1 | <!-- Documentation produced by the Html generator of Bouml (http://bouml.free.fr) --> |
---|
2 | <?xml version="1.0" encoding="UTF-8"?> |
---|
3 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
4 | <html xmlns="http://www.w3.org/1999/xhtml" xmlns:svg="http://www.w3.org/2000/svg"> |
---|
5 | |
---|
6 | <head> |
---|
7 | <title>Class SpaceExtent</title> |
---|
8 | <link rel="stylesheet" href="style.css" type="text/css" /> |
---|
9 | </head> |
---|
10 | |
---|
11 | <body bgcolor="#ffffff"> |
---|
12 | |
---|
13 | <div class = "title">Class SpaceExtent</div> |
---|
14 | <p></p> |
---|
15 | |
---|
16 | <!-- ============================================================= --> |
---|
17 | |
---|
18 | <a name="refclass131074"></a> |
---|
19 | <p>*<br /> * SpaceExtent class stores the information of Yao space extension, so the shape.<br /> * The shape is represented with a number variable of integer in function of the<br /> * definition (i,j,k) of the Yao space. In three dimensions spaces the integer is three.<br /> <br /></p><p>Declaration :</p><ul><li>C++ : class SpaceExtent </li></ul><p>Directly inherited by : <a href="class130562.html#refclass130562"><b>Operator</b></a> </p> |
---|
20 | <p>Artifact : <a href="index.html#refartifact130306"><b>SpaceExtent</b></a></p><div class="sub"> |
---|
21 | <a name="refoperation166402"></a> |
---|
22 | <table><tr><td><div class="element">Operation <b>SpaceExtent</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + SpaceExtent() : </li><li>C++ : public: inline SpaceExtent() </li></ul><a name="refoperation166530"></a> |
---|
23 | <table><tr><td><div class="element">Operation <b>SpaceExtent</b></div></td></tr></table><p>!< Default constructor, creates empty space extent.<br /></p><p>Declaration :</p><ul><li>Uml : + SpaceExtent(in aShape : std::vector<int>) : </li><li>C++ : public: inline SpaceExtent(std::vector<int> aShape) : theShape(aShape)</li></ul><a name="refoperation166658"></a> |
---|
24 | <table><tr><td><div class="element">Operation <b>getDimension</b></div></td></tr></table><p>!< Constructor.<br />*<br /> * Get the dimension, so the number of axes, of the space shape.<br /> * @return the dimension of the shape.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getDimension() : int</li><li>C++ : public: inline int getDimension() const</li></ul><a name="refoperation166786"></a> |
---|
25 | <table><tr><td><div class="element">Operation <b>getShape</b></div></td></tr></table><p>*<br /> * Get the shape of the space so a vector that contains from one to three integers in function to the dimension of the shape.<br /> * @return a constant shape vector.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getShape() : std::vector<int></li><li>C++ : public: inline const std::vector<int> & getShape() const</li></ul><a name="refoperation166914"></a> |
---|
26 | <table><tr><td><div class="element">Operation <b>getYA</b></div></td></tr></table><p>*<br /> * Get the size YAx (x=1,2,3) of the space shape.<br /> * @param YAx is the number between 1 to 3 in order to identify one axe.<br /> * @return YAx (x=1,2,3).<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getYA(in YAx : short) : int</li><li>C++ : public: inline int getYA(short YAx) const</li></ul><a name="refattribute136194"></a> |
---|
27 | <table><tr><td><div class="element">Attribute <b>theShape</b></div></td></tr></table> |
---|
28 | <p>!< Shape (dimensions) of the space extent.<br /></p><p>Declaration :</p><ul><li>Uml : # theShape : int</li><li>C++ : protected: vector<int> theShape</li></ul><p>Stereotype: vector</p> |
---|
29 | </div> |
---|
30 | <p>All public operations : <a href="class131074.html#refoperation166658"><b>getDimension</b></a> , <a href="class131074.html#refoperation166786"><b>getShape</b></a> , <a href="class131074.html#refoperation166914"><b>getYA</b></a> </p> |
---|
31 | </body> |
---|
32 | </html> |
---|