From: apo Date: Fri, 11 Nov 2005 07:27:54 +0000 (+0000) Subject: To document the sources X-Git-Tag: BR-D5-38-2003_D2005-24-11~54 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=8259cbffc054e3e55e40b9bc0d99d9a6529fa72b;p=modules%2Fvisu.git To document the sources --- diff --git a/src/CONVERTOR/VISU_Convertor.hxx b/src/CONVERTOR/VISU_Convertor.hxx index c81ce297..4af7323b 100644 --- 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 a00aa315..45d6531e 100644 --- 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; // 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 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 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 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 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 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