To document the sources

diff --git a/src/CONVERTOR/VISU_Convertor.hxx b/src/CONVERTOR/VISU_Convertor.hxx
index c81ce29784a400bc99a8026a334332e221654212..4af7323bc76e4d04dfd45b2b2e12714acf29921d 100644 (file)
--- a/src/CONVERTOR/VISU_Convertor.hxx
+++ b/src/CONVERTOR/VISU_Convertor.hxx
@@ -115,7 +115,7 @@ namespace VISU
   //! Define a container for mesh generated from MED GAUSS and corresponding MED PROFILE
   struct TGaussSubMesh: virtual TBaseStructure
   {
-    PSubProfile mySubProfile;
+    PSubProfile mySubProfile; //!< Keeps reference on what submesh the Gauss Points are located
   };
 
   

diff --git a/src/CONVERTOR/VISU_Convertor_impl.hxx b/src/CONVERTOR/VISU_Convertor_impl.hxx
index a00aa31540b90d8de6b9e6bb2206bea54ff2becb..45d6531e1eb34b055ee78b0fe40ffd09bb1ba788 100644 (file)
--- a/src/CONVERTOR/VISU_Convertor_impl.hxx
+++ b/src/CONVERTOR/VISU_Convertor_impl.hxx
@@ -111,6 +111,7 @@ namespace VISU
     const TVTKSource& 
     GetSource() const;
 
+    //! Reimplement the TIDMapper::GetVTKOutput
     virtual
     TVTKOutput* 
     GetVTKOutput();
@@ -134,6 +135,7 @@ namespace VISU
     const TVTKAppendFilter& 
     GetFilter() const;
 
+    //! Reimplement the TIDMapper::GetVTKOutput
     virtual
     TVTKOutput* 
     GetVTKOutput();
@@ -157,6 +159,7 @@ namespace VISU
     const TVTKMergeFilter& 
     GetFilter() const;
 
+    //! Reimplement the TIDMapper::GetVTKOutput
     virtual
     TVTKOutput* 
     GetVTKOutput();
@@ -270,10 +273,10 @@ namespace VISU
   struct TMeshImpl: virtual TMesh, 
                    virtual TIsVTKDone
   {
-    PNamedPointCoords myNamedPointCoords;
+    PNamedPointCoords myNamedPointCoords; //!< Keeps intermediate representation of the nodes
 
-    TVTKPoints myPoints;
-    vtkIdType myNbPoints;
+    TVTKPoints myPoints; //!< Keeps VTK representation of the nodes
+    vtkIdType myNbPoints; //!< Keeps number of the nodes
 
     TMeshImpl();
   };
@@ -353,24 +356,24 @@ namespace VISU
     vtkCell* 
     GetElemCell(vtkIdType theObjID);
     
-    //! Get corresponding VTK output
+    //! Reimplement the TIDMapper::GetVTKOutput
     virtual
     TVTKOutput* 
     GetVTKOutput();
 
     TID2ID myElemObj2VTKID; //!< Keeps object to VTK numeration mapping
-    TSubProfileArr mySubProfileArr; //!< Keeps sequence of TSubProfiles as they was added into TAppendFilter
+    TSubProfileArr mySubProfileArr; //!< Keeps sequence of TSubProfiles as they were added into TAppendFilter
     PNamedPointCoords myNamedPointCoords; //!< Keeps reference on the same TNamedPointCoords as TMesh
     TMeshOnEntityImpl* myMeshOnEntity; //<! Keeps backward reference to corresponding MED ENTITY mesh
 
-    TSource mySource; //! Keeps VTK representation of the MED TIMESTAMP mesh
-    TGeom2SubProfile myGeom2SubProfile; //! Keeps TSubProfiles according to their geometrical type
+    TSource mySource; //!< Keeps VTK representation of the MED TIMESTAMP mesh
+    TGeom2SubProfile myGeom2SubProfile; //!< Keeps TSubProfiles according to their geometrical type
   };
   typedef SharedPtr<TProfileImpl> PProfileImpl;
 
 
   //---------------------------------------------------------------
-  //! Specialize TMergeFilter to provide VTK mapping for MED TIMESTAMP mesh
+  //! Specialize TIDMapper to provide VTK mapping for MED TIMESTAMP mesh
   struct TIDMapperFilter: virtual TMergeFilter
   {
     TAppendFilter myIDMapper; //!< Responsible for numbering
@@ -406,6 +409,7 @@ namespace VISU
     vtkCell* 
     GetElemCell(vtkIdType theObjID);
     
+    //! Reimplement the TIDMapper::GetVTKOutput
     virtual
     TVTKOutput* 
     GetVTKOutput();
@@ -414,7 +418,7 @@ namespace VISU
 
 
   //---------------------------------------------------------------
-  //! Specialize TGauss to provide more detail information for the MED GAUSS entity
+  //! Specialize TGauss to provide more detail information of the MED GAUSS entity for VTK mapping
   struct TGaussImpl: virtual TGauss
   {
     EGeometry myGeom; //!< Define, to which geometrical type the MED GAUSS entity belongs
@@ -465,6 +469,7 @@ namespace VISU
     TGaussPointID
     GetObjID(vtkIdType theID) const;
 
+    //! Reimplement the TIDMapper::GetVTKOutput
     virtual
     TVTKOutput* 
     GetVTKOutput();
@@ -476,21 +481,25 @@ namespace VISU
 
     TSource mySource; //!< Keeps VTK representation of the Gauss Points
     TNamedIDMapper* myParent; //!< Refer to parent mesh
-    TGaussSubMeshArr myGaussSubMeshArr; //!< Keeps sequence of TGaussSubMesh as they was added into TAppendFilter
-    TGeom2GaussSubMesh myGeom2GaussSubMesh; //! Keeps TGaussSubMesh according to their geometrical type
+    TGaussSubMeshArr myGaussSubMeshArr; //!< Keeps sequence of TGaussSubMesh as they were added into TAppendFilter
+    TGeom2GaussSubMesh myGeom2GaussSubMesh; //!< Keeps TGaussSubMesh according to their geometrical type
   };
   typedef SharedPtr<TGaussMeshImpl> PGaussMeshImpl;
 
 
+  //---------------------------------------------------------------
+  //! Specialize TGaussPtsIDMapper to provide VTK mapping for MED TIMESTAMP mesh
   struct TGaussPtsIDFilter: virtual TIDMapperFilter,
                            virtual TGaussPtsIDMapper
   { 
     PGaussPtsIDMapper myGaussPtsIDMapper;
 
+    //! Reimplement the TGaussPtsIDMapper::GetObjID
     virtual 
     TGaussPointID 
     GetObjID(vtkIdType theID) const;
 
+    //! Reimplement the TGaussPtsIDMapper::GetParent
     virtual 
     TNamedIDMapper*
     GetParent();
@@ -596,6 +605,7 @@ namespace VISU
     vtkIdType 
     GetElemObjID(vtkIdType theID) const;
 
+    //! Reimplement the TIDMapper::GetVTKOutput
     virtual
     TVTKOutput* 
     GetVTKOutput();
@@ -717,21 +727,25 @@ namespace VISU
   //---------------------------------------------------------------
   typedef std::map<EGeometry,TMeshValue> TGeom2Value;
 
+  //! Specialize TValForTime to provide VTK mapping for the entity
   struct TValForTimeImpl: virtual TValForTime
   {
-    PGaussPtsIDFilter myGaussPtsIDFilter;
-    PIDMapperFilter myIDMapperFilter;
-    TGeom2Value myGeom2Value;
-    vtkIdType myNbGauss;
+    PGaussPtsIDFilter myGaussPtsIDFilter; //!< Keep VTK representation for mesh and data on Gauss Points
+    PIDMapperFilter myIDMapperFilter; //!< Keep VTK representation for ordinary mesh and data
+    TGeom2Value myGeom2Value; //!< Keep value that is assigned to the mesh
+    vtkIdType myNbGauss; //!< Keep number of Gauss Points
    
     TValForTimeImpl();
 
+    //! Get mesh data for defined geometrical type (constant version)
     const TMeshValue& 
     GetMeshValue(EGeometry theGeom) const;
 
+    //! Get mesh data for defined geometrical type
     TMeshValue& 
     GetMeshValue(EGeometry theGeom);
 
+    //! Get number of Gauss Points for defined geometrical type
     virtual
     int
     GetNbGauss(EGeometry theGeom) const;
@@ -740,6 +754,11 @@ namespace VISU
 }
 
 
+//! This class perfroms mapping of intermediate data strucutres into corresponding VTK representation
+/*!
+  It implements VISU_Convertor public interface and declare new pure virtual functions
+  to fill its intermediate data structure from a MED source
+*/
 class VISU_Convertor_impl: public VISU_Convertor
 {
 public:
@@ -748,6 +767,7 @@ public:
   virtual
   ~VISU_Convertor_impl();
 
+  //! Just to define default behaviour
   virtual
   VISU_Convertor* 
   Build() 
@@ -755,42 +775,50 @@ public:
     return this;
   }
 
+  //! Implemention of the VISU_Convertor::GetSize
   virtual 
   float
   GetSize();
 
+  //! Implemention of the VISU_Convertor::GetMeshOnEntity
   virtual 
   VISU::PNamedIDMapper 
   GetMeshOnEntity(const std::string& theMeshName, 
                  const VISU::TEntity& theEntity);
 
+  //! Implemention of the VISU_Convertor::GetMeshOnEntitySize
   virtual 
   float 
   GetMeshOnEntitySize(const std::string& theMeshName, 
                       const VISU::TEntity& theEntity);
 
+  //! Implemention of the VISU_Convertor::GetFamilyOnEntity
   virtual 
   VISU::PIDMapper 
   GetFamilyOnEntity(const std::string& theMeshName, 
                    const VISU::TEntity& theEntity,
                    const std::string& theFamilyName);
 
+  //! Implemention of the VISU_Convertor::GetFamilyOnEntitySize
   virtual 
   float 
   GetFamilyOnEntitySize(const std::string& theMeshName, 
                        const VISU::TEntity& theEntity,
                        const std::string& theFamilyName);
 
+  //! Implemention of the VISU_Convertor::GetMeshOnGroup
   virtual 
   VISU::PIDMapper 
   GetMeshOnGroup(const std::string& theMeshName, 
                 const std::string& theGroupName);
   
+  //! Implemention of the VISU_Convertor::GetMeshOnGroupSize
   virtual 
   float 
   GetMeshOnGroupSize(const std::string& theMeshName, 
                     const std::string& theGroupName);
 
+  //! Implemention of the VISU_Convertor::GetTimeStampOnMesh
   virtual
   VISU::PIDMapper 
   GetTimeStampOnMesh(const std::string& theMeshName, 
@@ -798,6 +826,7 @@ public:
                     const std::string& theFieldName,
                     int theStampsNum);
 
+  //! Implemention of the VISU_Convertor::GetTimeStampSize
   virtual 
   float 
   GetTimeStampSize(const std::string& theMeshName, 
@@ -805,6 +834,7 @@ public:
                   const std::string& theFieldName,
                   int theStampsNum);
 
+  //! Implemention of the VISU_Convertor::GetTimeStampOnGaussPts
   virtual
   VISU::PGaussPtsIDMapper 
   GetTimeStampOnGaussPts(const std::string& theMeshName, 
@@ -812,18 +842,21 @@ public:
                         const std::string& theFieldName,
                         int theStampsNum);
   
+  //! Implemention of the VISU_Convertor::GetFieldOnMeshSize
   virtual 
   float 
   GetFieldOnMeshSize(const std::string& theMeshName, 
                     const VISU::TEntity& theEntity,
                     const std::string& theFieldName);
 
+  //! Implemention of the VISU_Convertor::GetField
   virtual 
   const VISU::PField 
   GetField(const std::string& theMeshName, 
           VISU::TEntity theEntity, 
           const std::string& theFieldName);
 
+  //! Implemention of the VISU_Convertor::GetTimeStamp
   virtual 
   const VISU::PValForTime 
   GetTimeStamp(const std::string& theMeshName, 
@@ -832,25 +865,30 @@ public:
               int theStampsNum);
 
 protected:
+  //! An utility method to find TMesh by its name
   VISU::PMeshImpl 
   FindMesh(const std::string& theMeshName);
 
+  //! An utility method to find TMeshOnEntity by name of its parent mesh and entity
   typedef boost::tuple<VISU::PMeshImpl,VISU::PMeshOnEntityImpl> TFindMeshOnEntity;
   TFindMeshOnEntity
   FindMeshOnEntity(const std::string& theMeshName,
                   const VISU::TEntity& theEntity);
 
+  //! An utility method to find TFamily by name of its parent mesh, corresponding entity and its name
   typedef boost::tuple<VISU::PMeshImpl,VISU::PMeshOnEntityImpl,VISU::PFamilyImpl> TFindFamilyOnEntity;
   TFindFamilyOnEntity
   FindFamilyOnEntity(const std::string& theMeshName,
                    const VISU::TEntity& theEntity,
                    const std::string& theFamilyName);
 
+  //! An utility method to find Group by name of its parent mesh and its name
   typedef boost::tuple<VISU::PMeshImpl,VISU::PGroupImpl> TFindMeshOnGroup;
   TFindMeshOnGroup
   FindMeshOnGroup(const std::string& theMeshName, 
                  const std::string& theGroupName);
 
+  //! An utility method to find TField by name of its parent mesh, corresponding entity and its name
   typedef boost::tuple<VISU::PMeshImpl,
                       VISU::PMeshOnEntityImpl,
                       VISU::PMeshOnEntityImpl,
@@ -860,6 +898,7 @@ protected:
            const VISU::TEntity& theEntity, 
            const std::string& theFieldName);
 
+  //! An utility method to find TTimeStamp by name of its parent mesh, corresponding entity, field name and its number
   typedef boost::tuple<VISU::PMeshImpl,
                       VISU::PMeshOnEntityImpl,
                       VISU::PMeshOnEntityImpl,
@@ -872,22 +911,26 @@ protected:
                int theStampsNum);
   
 protected:
+  //! To fill intermeiate representation of TMeshOnEntity from a MED source
   virtual
   int
   LoadMeshOnEntity(VISU::PMeshImpl theMesh,
                   VISU::PMeshOnEntityImpl theMeshOnEntity) = 0;
 
+  //! To fill intermeiate representation of TFamily from a MED source
   virtual
   int
   LoadFamilyOnEntity(VISU::PMeshImpl theMesh,
                     VISU::PMeshOnEntityImpl theMeshOnEntity, 
                     VISU::PFamilyImpl theFamily) = 0;
 
+  //! To fill intermeiate representation of TGroup from a MED source
   virtual 
   int
   LoadMeshOnGroup(VISU::PMeshImpl theMesh, 
                  const VISU::TFamilySet& theFamilySet) = 0;
 
+  //! To fill intermeiate representation of TValForTime for ordinary mesh from a MED source
   virtual 
   int
   LoadValForTimeOnMesh(VISU::PMeshImpl theMesh, 
@@ -895,6 +938,7 @@ protected:
                       VISU::PFieldImpl theField, 
                       VISU::PValForTimeImpl theValForTime) = 0;
 
+  //! To fill intermeiate representation of TValForTime for mesh on Gauss Points from a MED source
   virtual 
   int
   LoadValForTimeOnGaussPts(VISU::PMeshImpl theMesh, 

diff --git a/src/CONVERTOR/VISU_IDMapper.hxx b/src/CONVERTOR/VISU_IDMapper.hxx
index 3fd19bb483af75dd466918898486a516c1638cbe..e4b2825f61516a514a8f000509b5aaf3c68b4c3b 100644 (file)
--- a/src/CONVERTOR/VISU_IDMapper.hxx
+++ b/src/CONVERTOR/VISU_IDMapper.hxx
@@ -45,8 +45,10 @@ namespace VISU
   using MED::SharedPtr;
 
   //---------------------------------------------------------------
+  //! Defines a basic class for intemediate data structures
   struct TBaseStructure
   {
+    //! Just to provide possibility of dynamic navigation through the class hierarchy
     virtual ~TBaseStructure()
     {}
   };