Changeset 198

Timestamp:

02/11/10 15:57:46 (14 years ago)

Author:

bernard

Message:

updating comments in Order.hpp

File:

• trunk/yao/src/YAOObjects/Order.hpp (modified) (2 diffs)

trunk/yao/src/YAOObjects/Order.hpp

@@ -241 +241 @@
    typedef vector<cfcStruct> cfcStructTableType;
         
-   // Array of data type that embed all the component informations of a graph (one entry by dimension i, j and k, used for storing the inner component informations).
-
+   // Vector of component structures that embed informations on the 3D main graph
    vector<cfcStruct> outerComp;
-   
+
+   // Array of vectors of component structures that embed informations on the 2D graphs
    cfcStructTableType **middleComp;
 
+   // Array of vectors of component structures that embed informations on the 1D graphs
    cfcStructTableType ****innerComp; 
 
@@ -336 +337 @@
         * This function create a graph then populate its properties accordignly to the boost API.
         * @param currentGraph a reference on the graph that should be created.
+        * @param valCi a vector of integer that register the connection values for the i dimension.
+        * @param valCj a vector of integer that register the connection values for the j dimension.
+        * @param valCk a vector of integer that register the connection values for the k dimension.
+        * @param modulList a vector of strings that regster the modul names.
+        * @param edgeArray a vector of edges that register the source modul and the target modul of each edge (connection). 
         */
         void generateGraph(myGraphType& currentGraph, const vector<int>& valCi, const vector<int>& valCj, const vector<int>& valCk, const vector<string>& modulList, const vector<edge>& edgeArray);