| 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 Connection</title> |
|---|
| 8 | <link rel="stylesheet" href="style.css" type="text/css" /> |
|---|
| 9 | </head> |
|---|
| 10 | |
|---|
| 11 | <body bgcolor="#ffffff"> |
|---|
| 12 | |
|---|
| 13 | <div class = "title">Class Connection</div> |
|---|
| 14 | <p></p> |
|---|
| 15 | |
|---|
| 16 | <!-- ============================================================= --> |
|---|
| 17 | |
|---|
| 18 | <a name="refclass128642"></a> |
|---|
| 19 | <p>* <br /> * Connection class, handles the connections between modules.<br /> * <br /> * It allows to stock all the information about the directive ctin-m of the description file.<br /> * It allows also to perform the basic operations get and set of the members and some other operations on these members like<br /> * test on the options of the ctin-m directive.<br /> * This class has two members groupes:<br /> * 1) members needed in order to read the description file and manipolate this first stage of information.<br /> * 2) members needed in order to get and set the information already manipulated: the second stage of information.<br /> * Before arrive to the second stage of information we have to perform some check and we have to translate the #, %, ~, +, - operators in<br /> * simple connection. We mean that one object of the Connection class in the second stage represents one connection in the graph and not a multiple<br /> * connection like we can define in the description file with the operators #, %, ....<br /> * The members of the class can concern the first or the second stage. We put a mark in the member specification.<br /> * If the member concern both stages we do not put anything.<br /> *<br /> * The class has some significant property: "from", "N° output", "Ci", "Cj", "Ck", "Ct", "to", "N° input". These can be retrieved with the methods:<br /> * getPropertyCount, getPropertyName and getProperty. These methods are useful above all in the second stage and they are used to shows <br /> * in a structured way the properties of the theConnectionTable object that is a table composed of Connection objects.<br /> *<br /> <br /></p><p>Declaration :</p><ul><li>C++ : class Connection </li></ul><p>Artifact : <a href="index.html#refartifact128898"><b>Connection</b></a></p><div class="sub"> |
|---|
| 20 | <a name="refoperation136450"></a> |
|---|
| 21 | <table><tr><td><div class="element">Operation <b>Connection</b></div></td></tr></table><p>! Default constructor.<br /></p><p>Declaration :</p><ul><li>Uml : + Connection() : </li><li>C++ : public: inline Connection() : reli(0), relj(0), relk(0), relt(0), inBegin(0), inEnd(0), outBegin(0), outEnd(0), t(false), T(false)</li></ul><a name="refoperation136578"></a> |
|---|
| 22 | <table><tr><td><div class="element">Operation <b>setIn</b></div></td></tr></table><p>* <br /> * Set the number of the input entry (only for the second stage). It can be only absolute.<br /> * @param value the entry of the module being connected.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setIn(in value : int) : void</li><li>C++ : public: inline void setIn(int value)</li></ul><a name="refoperation136706"></a> |
|---|
| 23 | <table><tr><td><div class="element">Operation <b>setOut</b></div></td></tr></table><p>* <br /> * Set the number of the output (only for the second stage). It can be only absolute.<br /> * @param value the output of the module being connected.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setOut(in value : int) : void</li><li>C++ : public: inline void setOut(int value)</li></ul><a name="refoperation136834"></a> |
|---|
| 24 | <table><tr><td><div class="element">Operation <b>setT</b></div></td></tr></table><p>* <br /> * Set the number of the time coordinate (only for the second stage). It can be absolute or relative in function of relt.<br /> * The concept of t and T private attributes is different. The others are seted if they are present in the description file.<br /> * @param value the t coordinate of the module being connected.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setT(in value : int) : void</li><li>C++ : public: inline void setT(int value)</li></ul><a name="refoperation136962"></a> |
|---|
| 25 | <table><tr><td><div class="element">Operation <b>setI</b></div></td></tr></table><p>* <br /> * Set the number of the i coordinate (only for the second stage). It can be absolute or relative in function of reli.<br /> * @param value in the second stage set the i coordinate of the module being connected.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setI(in value : int) : void</li><li>C++ : public: inline void setI(int value)</li></ul><a name="refoperation137090"></a> |
|---|
| 26 | <table><tr><td><div class="element">Operation <b>setJ</b></div></td></tr></table><p>* <br /> * Set the number of the j coordinate (only for the second stage). It can be absolute or relative in function of relj.<br /> * @param value the j coordinate of the module being connected.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setJ(in value : int) : void</li><li>C++ : public: inline void setJ(int value)</li></ul><a name="refoperation137218"></a> |
|---|
| 27 | <table><tr><td><div class="element">Operation <b>setK</b></div></td></tr></table><p>* <br /> * The number of the k coordinate. It can be absolute or relative in function of relk.<br /> * @param value in the second stage set the k coordinate of the module being connected. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setK(in value : int) : void</li><li>C++ : public: inline void setK(int value)</li></ul><a name="refoperation137346"></a> |
|---|
| 28 | <table><tr><td><div class="element">Operation <b>getIn</b></div></td></tr></table><p>* <br /> * Get the number of the input (only for the second stage). It can be only absolute.<br /> * @return the entry of the module connected. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getIn() : int</li><li>C++ : public: inline int getIn()</li></ul><a name="refoperation137474"></a> |
|---|
| 29 | <table><tr><td><div class="element">Operation <b>getOut</b></div></td></tr></table><p>* <br /> * Get the number of the output (only for the second stage). It can be only absolute.<br /> * @return the output of the module connected.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getOut() : int</li><li>C++ : public: inline int getOut()</li></ul><a name="refoperation137602"></a> |
|---|
| 30 | <table><tr><td><div class="element">Operation <b>getT</b></div></td></tr></table><p>* <br /> * Get the number of t coordinate (only for the second stage). It can be absolute or relative in function of relt.<br /> * @return the t coordinate of the module connected.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getT() : int</li><li>C++ : public: inline int getT()</li></ul><a name="refoperation137730"></a> |
|---|
| 31 | <table><tr><td><div class="element">Operation <b>getI</b></div></td></tr></table><p>* <br /> * Get the number of i coordinate (only for the second stage). It can be absolute or relative in function of reli.<br /> * @return the i coordinate of the module connected.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getI() : int</li><li>C++ : public: inline int getI()</li></ul><a name="refoperation137858"></a> |
|---|
| 32 | <table><tr><td><div class="element">Operation <b>getJ</b></div></td></tr></table><p>* <br /> * Get the number of j coordinate (only for the second stage). It can be absolute or relative in function of relj.<br /> * @return the j coordinate of the module connected.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getJ() : int</li><li>C++ : public: inline int getJ()</li></ul><a name="refoperation137986"></a> |
|---|
| 33 | <table><tr><td><div class="element">Operation <b>getK</b></div></td></tr></table><p>* <br /> * Get the number of k coordinate (only for the second stage). It can be absolute or relative in function of relk.<br /> * @return the k coordinate of the module connected. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getK() : int</li><li>C++ : public: inline int getK()</li></ul><a name="refoperation138114"></a> |
|---|
| 34 | <table><tr><td><div class="element">Operation <b>getName</b></div></td></tr></table><p>* <br /> * Get a string that identifies the Connection. It's "outModule ===> inModule". <br /> * @return the name of the connection.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getName() : string</li><li>C++ : public: inline string getName()</li></ul><a name="refoperation138242"></a> |
|---|
| 35 | <table><tr><td><div class="element">Operation <b>setInBegin</b></div></td></tr></table><p>* <br /> * Set the lower edge of an input range (only for the first stage). The range can be a simple point in function of inEnd. <br /> * The range can only be absolute.<br /> * @param anInBegin the edge. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setInBegin(in anInBegin : int) : void</li><li>C++ : public: inline void setInBegin(int anInBegin)</li></ul><a name="refoperation138370"></a> |
|---|
| 36 | <table><tr><td><div class="element">Operation <b>getInBegin</b></div></td></tr></table><p>* <br /> * Get the lower edge of an input range (only for the first stage). The range can be a simple point in function of inEnd. <br /> * The range can only be absolute.<br /> * @return the edge. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getInBegin() : int</li><li>C++ : public: inline int getInBegin()</li></ul><a name="refoperation138498"></a> |
|---|
| 37 | <table><tr><td><div class="element">Operation <b>setInEnd</b></div></td></tr></table><p>* <br /> * Set the upper edge of an input range (only for the first stage). If inEnd is 0 the range is a single point stocked in inBegin. <br /> * The range can only be absolute.<br /> * @param anInEnd the edge. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setInEnd(in anInEnd : int) : void</li><li>C++ : public: inline void setInEnd(int anInEnd)</li></ul><a name="refoperation138626"></a> |
|---|
| 38 | <table><tr><td><div class="element">Operation <b>getInEnd</b></div></td></tr></table><p>* <br /> * Get the upper edge of an input range (only for the first stage). If inEnd is 0 the range is a single point stocked in inBegin. <br /> * The range can only be absolute.<br /> * @return the edge. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getInEnd() : int</li><li>C++ : public: inline int getInEnd()</li></ul><a name="refoperation138754"></a> |
|---|
| 39 | <table><tr><td><div class="element">Operation <b>setOutBegin</b></div></td></tr></table><p>* <br /> * Set the lower edge of an output range (only for the first stage). The range can be a simple point in function of outEnd. <br /> * The range can only be absolute.<br /> * @param anOutBegin the edge. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setOutBegin(in anOutBegin : int) : void</li><li>C++ : public: inline void setOutBegin(int anOutBegin)</li></ul><a name="refoperation138882"></a> |
|---|
| 40 | <table><tr><td><div class="element">Operation <b>getOutBegin</b></div></td></tr></table><p>* <br /> * Get the lower edge of an output range (only for the first stage). The range can be a simple point in function of outEnd. <br /> * The range can only be absolute.<br /> * @return the edge. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getOutBegin() : int</li><li>C++ : public: inline int getOutBegin()</li></ul><a name="refoperation139010"></a> |
|---|
| 41 | <table><tr><td><div class="element">Operation <b>setOutEnd</b></div></td></tr></table><p>* <br /> * Set the upper edge of an output range (only for the first stage). If outEnd is 0 the range is a single point stocked in outBegin. <br /> * The range can only be absolute.<br /> * @param anOutEnd the edge. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setOutEnd(in anOutEnd : int) : void</li><li>C++ : public: inline void setOutEnd(int anOutEnd)</li></ul><a name="refoperation139138"></a> |
|---|
| 42 | <table><tr><td><div class="element">Operation <b>getOutEnd</b></div></td></tr></table><p>* <br /> * Get the output module. <br /> * @return the output module. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getOutEnd() : int</li><li>C++ : public: inline int getOutEnd()</li></ul><a name="refoperation139266"></a> |
|---|
| 43 | <table><tr><td><div class="element">Operation <b>setInModule</b></div></td></tr></table><p>* <br /> * Set the input module that is the module in the connection that receive the information from the output module. <br /> * @param anInModule the input module. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setInModule(in anInModule : string) : void</li><li>C++ : public: inline void setInModule(string anInModule)</li></ul><a name="refoperation139394"></a> |
|---|
| 44 | <table><tr><td><div class="element">Operation <b>getInModule</b></div></td></tr></table><p>* <br /> * Get the input module. <br /> * @return the input module. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getInModule() : string</li><li>C++ : public: inline string getInModule()</li></ul><a name="refoperation139522"></a> |
|---|
| 45 | <table><tr><td><div class="element">Operation <b>setOutModule</b></div></td></tr></table><p>* <br /> * Set the output module that is the module in the connection that give the information to the input module. <br /> * @param anOutModule the output module. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setOutModule(in anOutModule : string) : void</li><li>C++ : public: inline void setOutModule(string anOutModule)</li></ul><a name="refoperation139650"></a> |
|---|
| 46 | <table><tr><td><div class="element">Operation <b>getOutModule</b></div></td></tr></table><p>* <br /> * Get the output module. <br /> * @return the output module. <br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getOutModule() : string</li><li>C++ : public: inline string getOutModule()</li></ul><a name="refoperation139778"></a> |
|---|
| 47 | <table><tr><td><div class="element">Operation <b>getInElements</b></div></td></tr></table><p>* <br /> * Get the input total number of the inModule range (only for the first stage).<br /> * @return the number of elements of the range.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getInElements() : int</li><li>C++ : public: inline int getInElements()</li></ul><a name="refoperation139906"></a> |
|---|
| 48 | <table><tr><td><div class="element">Operation <b>getOutElements</b></div></td></tr></table><p>* <br /> * Get the output total number of the outModule range (only for the first stage).<br /> * @return the number of elements of the range.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getOutElements() : int</li><li>C++ : public: inline int getOutElements()</li></ul><a name="refoperation140034"></a> |
|---|
| 49 | <table><tr><td><div class="element">Operation <b>getIElements</b></div></td></tr></table><p>* <br /> * Get the i total range number (only for the first stage).<br /> * @return the number of elements of the range.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getIElements() : int</li><li>C++ : public: inline int getIElements()</li></ul><a name="refoperation140162"></a> |
|---|
| 50 | <table><tr><td><div class="element">Operation <b>getJElements</b></div></td></tr></table><p>* <br /> * Get the j total range number (only for the first stage).<br /> * @return the number of elements of the range.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getJElements() : int</li><li>C++ : public: inline int getJElements()</li></ul><a name="refoperation140290"></a> |
|---|
| 51 | <table><tr><td><div class="element">Operation <b>getKElements</b></div></td></tr></table><p>* <br /> * Get the k total range number (only for the first stage).<br /> * @return the number of elements of the range.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getKElements() : int</li><li>C++ : public: inline int getKElements()</li></ul><a name="refoperation140418"></a> |
|---|
| 52 | <table><tr><td><div class="element">Operation <b>getTElements</b></div></td></tr></table><p>* <br /> * Get the t total range number (only for the first stage).<br /> * @return the number of elements of the range.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getTElements() : int</li><li>C++ : public: inline int getTElements()</li></ul><a name="refoperation140546"></a> |
|---|
| 53 | <table><tr><td><div class="element">Operation <b>isI</b></div></td></tr></table><p>* <br /> * Control if in the description file the i coordinate has been inserted in the directive ctin-m.<br /> * @return true if i is present in the description file.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + isI() : bool</li><li>C++ : public: inline bool isI()</li></ul><a name="refoperation140674"></a> |
|---|
| 54 | <table><tr><td><div class="element">Operation <b>isJ</b></div></td></tr></table><p>* <br /> * Control if in the description file the j coordinate has been inserted in the directive ctin-m.<br /> * @return true if j is present in the description file.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + isJ() : bool</li><li>C++ : public: inline bool isJ()</li></ul><a name="refoperation140802"></a> |
|---|
| 55 | <table><tr><td><div class="element">Operation <b>isK</b></div></td></tr></table><p>* <br /> * Control if in the description file the k coordinate has been inserted in the directive ctin-m.<br /> * @return true if k is present in the description file.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + isK() : bool</li><li>C++ : public: inline bool isK()</li></ul><a name="refoperation140930"></a> |
|---|
| 56 | <table><tr><td><div class="element">Operation <b>ist</b></div></td></tr></table><p>* <br /> * Control if in the description file the t coordinate has been inserted in the directive ctin-m. Be careful t is not T.<br /> * @return true if t is present in the description file.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + ist() : bool</li><li>C++ : public: inline bool ist()</li></ul><a name="refoperation141058"></a> |
|---|
| 57 | <table><tr><td><div class="element">Operation <b>isT</b></div></td></tr></table><p>* <br /> * Control if in the description file the T coordinate has been inserted in the directive ctin-m. Be careful T is not t.<br /> * @return true if T is present in the description file.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + isT() : bool</li><li>C++ : public: inline bool isT()</li></ul><a name="refoperation141186"></a> |
|---|
| 58 | <table><tr><td><div class="element">Operation <b>setReli</b></div></td></tr></table><p>* <br /> * Set relative or absolute displacement for i coordinate. If setted the content of ci is relative.<br /> * @param aReli 0 not present in the ctin-m directive, -1 absolute displacement, 1 relative displacement.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setReli(in aReli : short) : void</li><li>C++ : public: inline void setReli(short aReli)</li></ul><a name="refoperation141314"></a> |
|---|
| 59 | <table><tr><td><div class="element">Operation <b>getReli</b></div></td></tr></table><p>* <br /> * Get relative or absolute displacement for i coordinate. <br /> * @return 0 not present in the ctin-m directive, -1 absolute displacement, 1 relative displacement.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getReli() : short</li><li>C++ : public: inline short getReli()</li></ul><a name="refoperation141442"></a> |
|---|
| 60 | <table><tr><td><div class="element">Operation <b>setRelj</b></div></td></tr></table><p>* <br /> * Set relative or absolute displacement for j coordinate. If setted the content of cj is relative.<br /> * @param aRelj 0 not present in the ctin-m directive, -1 absolute displacement, 1 relative displacement.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setRelj(in aRelj : short) : void</li><li>C++ : public: inline void setRelj(short aRelj)</li></ul><a name="refoperation141570"></a> |
|---|
| 61 | <table><tr><td><div class="element">Operation <b>getRelj</b></div></td></tr></table><p>* <br /> * Get relative or absolute displacement for j coordinate. <br /> * @return 0 not present in the ctin-m directive, -1 absolute displacement, 1 relative displacement.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getRelj() : short</li><li>C++ : public: inline short getRelj()</li></ul><a name="refoperation141698"></a> |
|---|
| 62 | <table><tr><td><div class="element">Operation <b>setRelk</b></div></td></tr></table><p>* <br /> * Set relative or absolute displacement for k coordinate. If setted the content of ck is relative.<br /> * @param aRelk 0 not present in the ctin-m directive, -1 absolute displacement, 1 relative displacement.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setRelk(in aRelk : short) : void</li><li>C++ : public: inline void setRelk(short aRelk)</li></ul><a name="refoperation141826"></a> |
|---|
| 63 | <table><tr><td><div class="element">Operation <b>getRelk</b></div></td></tr></table><p>* <br /> * Get relative or absolute displacement for k coordinate. <br /> * @return 0 not present in the ctin-m directive, -1 absolute displacement, 1 relative displacement.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getRelk() : short</li><li>C++ : public: inline short getRelk()</li></ul><a name="refoperation141954"></a> |
|---|
| 64 | <table><tr><td><div class="element">Operation <b>setRelt</b></div></td></tr></table><p>* <br /> * Set relative or absolute displacement for t or T coordinate. If setted the content of ct is relative.<br /> * @param aRelt the relt value (look to the definition of the attribute).<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setRelt(in aRelt : short) : void</li><li>C++ : public: inline void setRelt(short aRelt)</li></ul><a name="refoperation142082"></a> |
|---|
| 65 | <table><tr><td><div class="element">Operation <b>getRelt</b></div></td></tr></table><p>* <br /> * Get relative or absolute displacement for t or T coordinate. <br /> * @return the value of relt (look to the definition of the attribute).<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getRelt() : short</li><li>C++ : public: inline short getRelt()</li></ul><a name="refoperation142210"></a> |
|---|
| 66 | <table><tr><td><div class="element">Operation <b>setCtinType</b></div></td></tr></table><p>* <br /> * Set the type of ctin-m. If setted the connection present in the description file is ctin otherwise is ctinm.<br /> * @param aType the type of ctin-m.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setCtinType(in aType : bool) : void</li><li>C++ : public: inline void setCtinType(bool aType)</li></ul><a name="refoperation142338"></a> |
|---|
| 67 | <table><tr><td><div class="element">Operation <b>isCtinType</b></div></td></tr></table><p>* <br /> * Get the type of ctin-m. <br /> * @return the type of ctin-m: true ctin and false ctinm.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + isCtinType() : bool</li><li>C++ : public: inline bool isCtinType()</li></ul><a name="refoperation142466"></a> |
|---|
| 68 | <table><tr><td><div class="element">Operation <b>setRelativeInterval</b></div></td></tr></table><p>*<br /> * We set a RELATIVE interval that is only allowed for the coordinates (i,j,k,t), so we set the range of the coordinates. <br /> * We call this function only if in the description file the connection ctin-m is relative.<br /> * @param rangeOp is the range operator that is one of the choice of possible interval: "", "+", "-", "~", "%+", "%-", "%~", "#+", "#-", "#~".<br /> * @param value is the value parsed in the description file inside the directive ctin.<br /> * @param parameterNumber is a number that identifies the actual position we are parsing in the directive. <br /> * This is why we need to understand which kind of range we are managing: <br /> * 0 is for the input range, 1 is for the output range, 2/3/4/5/6 are for the i/j/k/t/T respectively.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setRelativeInterval(in rangeOp : string, in value : int, in parameterNumber : short) : void</li><li>C++ : public: inline void setRelativeInterval(string rangeOp, int value, short parameterNumber)</li></ul><a name="refoperation142594"></a> |
|---|
| 69 | <table><tr><td><div class="element">Operation <b>setAbsoluteInterval</b></div></td></tr></table><p>*<br /> * We set an ABSOLUTE interval, so we set the range of the coordinates and of the input/output. <br /> * We call this function only if in the description file the connection ctin-m is absolute (i.e.: 2..4)<br /> * @param aBegin is the begin value of the range (in the example is 2).<br /> * @param anEnd is the end value of the range (in the example is 4).<br /> * @param parameterNumber is a number that identifies the actual position we are parsing in the directive. <br /> * This is why we need to understand which kind of range we are managing: <br /> * 0 is for the input range, 1 is for the output range, 2/3/4/5/6 are for the i/j/k/t/T respectively.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + setAbsoluteInterval(in aBegin : int, in anEnd : int, in parameterNumber : short) : void</li><li>C++ : public: inline void setAbsoluteInterval(int aBegin, int anEnd, short parameterNumber)</li></ul><a name="refoperation142722"></a> |
|---|
| 70 | <table><tr><td><div class="element">Operation <b>checkOptions</b></div></td></tr></table><p>*<br /> * SOME CHECK for the option specified on the directive ctin-m. Here we check some consistency parameters of the ctin-m.<br /> * The consistency of the ctin-m syntax is already tested by the grammar. Here we test the semantic of the parameters.<br /> * The only thing that we do not test here is the consitency between directive ctin-m. Each test concern one ctin-m, <br /> * the modules and the relative space and trajetory.<br /> * @param inMod is a pointer on the object input module.<br /> * @param outMod is a pointer on the object output module.<br /> * @param theTableSpace is the object that contain all the spaces.<br /> * @param theOperatorTable is the object that contain all the operators.<br /> * @param theTrajectoryTable is the object that contain all the Trajectories.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + checkOptions(inout inMod : <a href="class128898.html#refclass128898"><b>Modul</b></a>, inout outMod : <a href="class128898.html#refclass128898"><b>Modul</b></a>, in theSpaceTable : Table<Space>, in theOperatorTable : Table<Operator>, in theTrajectoryTable : Table<Trajectory>) : void</li><li>C++ : public: inline void checkOptions(<a href="class128898.html#refclass128898"><b>Modul</b></a> * inMod, <a href="class128898.html#refclass128898"><b>Modul</b></a> * outMod, Table<Space> theSpaceTable, Table<Operator> theOperatorTable, Table<Trajectory> theTrajectoryTable)</li></ul><a name="refoperation142850"></a> |
|---|
| 71 | <table><tr><td><div class="element">Operation <b>getPropertyCount</b></div></td></tr></table><p>*<br /> * Allows to have a nice and automatic visualization of the Connection object elements.<br /> * @return the number of significant properties stored in this class.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : static, + getPropertyCount() : int</li><li>C++ : public: static inline int getPropertyCount()</li></ul><a name="refoperation142978"></a> |
|---|
| 72 | <table><tr><td><div class="element">Operation <b>getPropertyName</b></div></td></tr></table><p>*<br /> * Allows to have a nice and automatic visualization of the Connection object elements. <br /> * In this method we retrive this kind of propertis: "from", "N° output", "Ci", "Cj", "Ck", "Ct", "to", "N° input".<br /> * These are prefixed string that never change.<br /> * @param anIndex is the number of property required.<br /> * @return a string that represent the number of property stored in this class.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : static, + getPropertyName(in anIndex : int) : std::string</li><li>C++ : public: static inline std::string getPropertyName(int anIndex)</li></ul><a name="refoperation143106"></a> |
|---|
| 73 | <table><tr><td><div class="element">Operation <b>getProperty</b></div></td></tr></table><p>*<br /> * Allows to have a nice and automatic visualization of the Connection object elements. <br /> * In this method we retrive the value of significant property: "from", "N° output", "Ci", "Cj", "Ck", "Ct", "to", "N° input".<br /> * In function of the integer in input to the method we retrieve the respective property.<br /> * @param anIndex is the number of property required.<br /> * @return the property stored in this class.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : + getProperty(in anIndex : int) : std::string</li><li>C++ : public: inline std::string getProperty(int anIndex) const</li></ul><a name="refoperation143234"></a> |
|---|
| 74 | <table><tr><td><div class="element">Operation <b>setCoordinateValue</b></div></td></tr></table><p>*<br /> * Set the value in the right vector in function of the coordinate number "parameterNumber". <br /> * In this method "parameterNumber" can be addressed only with coordinate i,j,k,t or T and not with input or output modules.<br /> * @param value the coordinate value to be setted.<br /> * @param parameterNumber is a number that identifies the actual position we are parsing in the directive. <br /> * This is why we need to understand which kind of range we are managing: <br /> * 0 is for the input range, 1 is for the output range, 2/3/4/5/6 are for the i/j/k/t/T respectively.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : - setCoordinateValue(in value : int, in parameterNumber : short) : void</li><li>C++ : private: inline void setCoordinateValue(int value, short parameterNumber)</li></ul><a name="refoperation143362"></a> |
|---|
| 75 | <table><tr><td><div class="element">Operation <b>Ypdt2pdt</b></div></td></tr></table><p>*<br /> * Allows to test the translation, between two trajectories, of one instant of time.<br /> * @param theTrajectoryTable is the object that contain all the Trajectories.<br /> * @param outTraj is the trajectory of the output module.<br /> * @param inInstant is the instant to be translated. This instant belong to the input module trajectory.<br /> * @param inTraj is the trajectory of the input module.<br /> * @return the equivalent instant of the output trajectory.<br /> <br /></p><p>Declaration :</p><ul><li>Uml : - Ypdt2pdt(in theTrajectoryTable : Table<Trajectory>, in outTraj : string, in inInstant : int, in inTraj : string) : int</li><li>C++ : private: inline int Ypdt2pdt(Table<Trajectory> theTrajectoryTable, string outTraj, int inInstant, string inTraj)</li></ul><a name="refattribute128770"></a> |
|---|
| 76 | <table><tr><td><div class="element">Attribute <b>relt</b></div></td></tr></table> |
|---|
| 77 | <p>Declaration :</p><ul><li>Uml : - relt : short</li><li>C++ : private: short relt</li></ul><a name="refattribute128898"></a> |
|---|
| 78 | <table><tr><td><div class="element">Attribute <b>ctinType</b></div></td></tr></table> |
|---|
| 79 | <p>!< True if ctin, false if ctinm.<br /></p><p>Declaration :</p><ul><li>Uml : - ctinType : bool</li><li>C++ : private: bool ctinType</li></ul><a name="refattribute129026"></a> |
|---|
| 80 | <table><tr><td><div class="element">Attribute <b>t</b></div></td></tr></table> |
|---|
| 81 | <p>!< True if t has been inserted in the description file.<br /></p><p>Declaration :</p><ul><li>Uml : - t : bool</li><li>C++ : private: bool t</li></ul><a name="refattribute129154"></a> |
|---|
| 82 | <table><tr><td><div class="element">Attribute <b>T</b></div></td></tr></table> |
|---|
| 83 | <p>!< True if T has been inserted in the description file.<br /></p><p>Declaration :</p><ul><li>Uml : - T : bool</li><li>C++ : private: bool T</li></ul><a name="refrelation131586"></a> |
|---|
| 84 | <table><tr><td><div class="element">Relation <b><association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : - : <a href="class128898.html#refclass128898"><b>Modul</b></a>, multiplicity : 2</li><li>C++ : private: <a href="class128898.html#refclass128898"><b>Modul</b></a> * </li></ul><a name="refattribute146946"></a> |
|---|
| 85 | <table><tr><td><div class="element">Attribute <b>inModule</b></div></td></tr></table> |
|---|
| 86 | <p>Declaration :</p><ul><li>Uml : - inModule : string</li><li>C++ : private: string inModule</li></ul><a name="refattribute147074"></a> |
|---|
| 87 | <table><tr><td><div class="element">Attribute <b>outModule</b></div></td></tr></table> |
|---|
| 88 | <p>Declaration :</p><ul><li>Uml : - outModule : string</li><li>C++ : private: string outModule</li></ul><a name="refrelation141570"></a> |
|---|
| 89 | <table><tr><td><div class="element">Relation <b>(belong)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : - : <a href="class128386.html#refclass128386"><b>Table</b></a>, multiplicity : 1</li><li>C++ : private: <a href="class128386.html#refclass128386"><b>Table</b></a> * </li></ul><a name="refrelation141826"></a> |
|---|
| 90 | <table><tr><td><div class="element">Relation <b><association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : - : <a href="class138242.html#refclass138242"><b>Helper</b></a></li><li>C++ : private: <a href="class138242.html#refclass138242"><b>Helper</b></a> * </li></ul></div> |
|---|
| 91 | <p>All public operations : <a href="class128642.html#refoperation142722"><b>checkOptions</b></a> , <a href="class128642.html#refoperation137730"><b>getI</b></a> , <a href="class128642.html#refoperation140034"><b>getIElements</b></a> , <a href="class128642.html#refoperation137346"><b>getIn</b></a> , <a href="class128642.html#refoperation138370"><b>getInBegin</b></a> , <a href="class128642.html#refoperation139778"><b>getInElements</b></a> , <a href="class128642.html#refoperation138626"><b>getInEnd</b></a> , <a href="class128642.html#refoperation139394"><b>getInModule</b></a> , <a href="class128642.html#refoperation137858"><b>getJ</b></a> , <a href="class128642.html#refoperation140162"><b>getJElements</b></a> , <a href="class128642.html#refoperation137986"><b>getK</b></a> , <a href="class128642.html#refoperation140290"><b>getKElements</b></a> , <a href="class128642.html#refoperation138114"><b>getName</b></a> , <a href="class128642.html#refoperation137474"><b>getOut</b></a> , <a href="class128642.html#refoperation138882"><b>getOutBegin</b></a> , <a href="class128642.html#refoperation139906"><b>getOutElements</b></a> , <a href="class128642.html#refoperation139138"><b>getOutEnd</b></a> , <a href="class128642.html#refoperation139650"><b>getOutModule</b></a> , <a href="class128642.html#refoperation143106"><b>getProperty</b></a> , <a href="class128642.html#refoperation142850"><b>getPropertyCount</b></a> , <a href="class128642.html#refoperation142978"><b>getPropertyName</b></a> , <a href="class128642.html#refoperation141314"><b>getReli</b></a> , <a href="class128642.html#refoperation141570"><b>getRelj</b></a> , <a href="class128642.html#refoperation141826"><b>getRelk</b></a> , <a href="class128642.html#refoperation142082"><b>getRelt</b></a> , <a href="class128642.html#refoperation137602"><b>getT</b></a> , <a href="class128642.html#refoperation140418"><b>getTElements</b></a> , <a href="class128642.html#refoperation142338"><b>isCtinType</b></a> , <a href="class128642.html#refoperation140546"><b>isI</b></a> , <a href="class128642.html#refoperation140674"><b>isJ</b></a> , <a href="class128642.html#refoperation140802"><b>isK</b></a> , <a href="class128642.html#refoperation141058"><b>isT</b></a> , <a href="class128642.html#refoperation140930"><b>ist</b></a> , <a href="class128642.html#refoperation142594"><b>setAbsoluteInterval</b></a> , <a href="class128642.html#refoperation142210"><b>setCtinType</b></a> , <a href="class128642.html#refoperation136962"><b>setI</b></a> , <a href="class128642.html#refoperation136578"><b>setIn</b></a> , <a href="class128642.html#refoperation138242"><b>setInBegin</b></a> , <a href="class128642.html#refoperation138498"><b>setInEnd</b></a> , <a href="class128642.html#refoperation139266"><b>setInModule</b></a> , <a href="class128642.html#refoperation137090"><b>setJ</b></a> , <a href="class128642.html#refoperation137218"><b>setK</b></a> , <a href="class128642.html#refoperation136706"><b>setOut</b></a> , <a href="class128642.html#refoperation138754"><b>setOutBegin</b></a> , <a href="class128642.html#refoperation139010"><b>setOutEnd</b></a> , <a href="class128642.html#refoperation139522"><b>setOutModule</b></a> , <a href="class128642.html#refoperation142466"><b>setRelativeInterval</b></a> , <a href="class128642.html#refoperation141186"><b>setReli</b></a> , <a href="class128642.html#refoperation141442"><b>setRelj</b></a> , <a href="class128642.html#refoperation141698"><b>setRelk</b></a> , <a href="class128642.html#refoperation141954"><b>setRelt</b></a> , <a href="class128642.html#refoperation136834"><b>setT</b></a> </p> |
|---|
| 92 | </body> |
|---|
| 93 | </html> |
|---|
![(please configure the [header_logo] section in trac.ini)](/yao/chrome/site/your_project_logo.png){kind=logo}
