src/CONVERTOR/VISU_Convertor.hxx

Go to the documentation of this file.

// Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//

//  VISU CONVERTOR :
//  File   : VISU_Convertor.hxx
//  Author : Alexey PETROV
//  Module : VISU
//
#ifndef VISU_Convertor_HeaderFile
#define VISU_Convertor_HeaderFile

#include "VISU_Structures.hxx"


//---------------------------------------------------------------

class VISU_CONVERTOR_EXPORT VISU_Convertor
{
public:
  virtual
  const std::string& 
  GetName();

  virtual
  int
  IsDone() const;

  virtual
  VISU_Convertor* 
  Build() = 0;

  virtual
  VISU_Convertor* 
  BuildEntities() = 0;

  virtual
  VISU_Convertor* 
  BuildFields() = 0;

  virtual
  VISU_Convertor* 
  BuildMinMax() = 0;

  virtual
  VISU_Convertor* 
  BuildGroups() = 0;

  virtual
  const VISU::TMeshMap& 
  GetMeshMap();

  virtual
  size_t
  GetSize() = 0;

  virtual
  VISU::PNamedIDMapper 
  GetMeshOnEntity(const std::string& theMeshName, 
                  const VISU::TEntity& theEntity) = 0;
  
  virtual
  size_t
  GetMeshOnEntitySize(const std::string& theMeshName, 
                      const VISU::TEntity& theEntity) = 0;
  
  virtual 
  VISU::PUnstructuredGridIDMapper 
  GetFamilyOnEntity(const std::string& theMeshName, 
                    const VISU::TEntity& theEntity,
                    const std::string& theFamilyName) = 0;

  virtual 
  size_t 
  GetFamilyOnEntitySize(const std::string& theMeshName, 
                        const VISU::TEntity& theEntity,
                        const std::string& theFamilyName) = 0;

  virtual
  VISU::PUnstructuredGridIDMapper
  GetMeshOnGroup(const std::string& theMeshName, 
                 const std::string& theGroupName) = 0;
  
  virtual
  size_t
  GetMeshOnGroupSize(const std::string& theMeshName, 
                     const std::string& theGroupName) = 0;
  
  virtual
  VISU::PUnstructuredGridIDMapper 
  GetTimeStampOnMesh(const std::string& theMeshName, 
                     const VISU::TEntity& theEntity,
                     const std::string& theFieldName,
                     int theTimeStampNumber) = 0;

  virtual
  VISU::PGaussPtsIDMapper 
  GetTimeStampOnGaussPts(const std::string& theMeshName, 
                         const VISU::TEntity& theEntity,
                         const std::string& theFieldName,
                         int theTimeStampNumber) = 0;
   
  virtual 
  size_t
  GetTimeStampOnMeshSize(const std::string& theMeshName, 
                         const VISU::TEntity& theEntity,
                         const std::string& theFieldName,
                         int theTimeStampNumber,
                         bool& theIsEstimated) = 0;
    
  virtual 
  size_t
  GetTimeStampOnGaussPtsSize(const std::string& theMeshName, 
                             const VISU::TEntity& theEntity,
                             const std::string& theFieldName,
                             int theTimeStampNumber,
                             bool& theIsEstimated) = 0;
    
  virtual 
  size_t
  GetFieldOnMeshSize(const std::string& theMeshName, 
                     const VISU::TEntity& theEntity,
                     const std::string& theFieldName) = 0;
  
  virtual
  const VISU::PField 
  GetField(const std::string& theMeshName, 
           VISU::TEntity theEntity, 
           const std::string& theFieldName) = 0;
  
  virtual
  const VISU::PValForTime 
  GetTimeStamp(const std::string& theMeshName, 
               const VISU::TEntity& theEntity,
               const std::string& theFieldName,
               int theTimeStampNumber) = 0;
    
  static 
  std::string 
  GenerateName(const VISU::TTime& aTime);

  static 
  std::string 
  GenerateName(const std::string& theName, unsigned int theTimeId);

protected:
  VISU_Convertor();
  
  std::string myName;
  VISU::TMeshMap myMeshMap;
  int myIsDone;
};

extern "C"
{
  VISU_CONVERTOR_EXPORT
  VISU_Convertor*
  CreateConvertor(const std::string& theFileName);
};


#endif