Version: 5.1.6

MEDMEM_ENSIGHT._CaseFileDriver_User Class Reference

Base of all Ensight drivers. It stores data passed from case file. More...

#include <MEDMEM_EnsightUtils.hxx>

Inheritance diagram for MEDMEM_ENSIGHT._CaseFileDriver_User:
Inheritance graph

Public Member Functions

 _CaseFileDriver_User (const std::string &caseFileName="", MED_EN::med_mode_acces mode=MED_EN::RDWR)
 _CaseFileDriver_User constructor
const std::string & getCaseFileName () const
const std::string & getDataFileName () const
bool isGoldFormat () const
 returns true if there are several meshes/fields in a data file
bool isSingleFileMode () const
 index of meshes/fields in a data file, zero for static mesh/feild
int getIndexInDataFile () const
 true if there are time steps, i.e. getTime() has sense
bool isTransientMode () const
 time of a step
double getTime () const
void setInterData (_InterMed *imed)
 < for mesh driver to store data
_InterMedgetInterData ()
 for field driver to get mesh data
_SubPartgetSubPart (const _SubPartDesc &descriptor) throw (MEDEXCEPTION)
 return _SubPart by its description
_SupportgetSupport (const _SupportDesc &descriptor, const medEntityMesh entity) throw (MEDEXCEPTION)
 return _Support by its description
int getPartNumber (const SUPPORT *support) const
 < return part number to write support with, zero in failure case
 ~_CaseFileDriver_User ()
 _CaseFileDriver_User destructor

Static Public Member Functions

static bool canOpenFile (const string &fileName, med_mode_acces mode)
 check possibility to open a file with a given mode
static void getSupportNodes (const SUPPORT *sup, map< int, int > &nodeIds)
 analyse if data file is binary
static bool isBinaryDataFile (const string &dataFileName)
 analyse if data file is binary
static bool isTimeStepBeginning (const string &line)
static bool isTimeStepEnd (const char *line)
static bool isToWriteEntity (const medEntityMesh entity, const MESH *mesh)
 Return true if we strore an enetuty to EnSight.

Data Fields

std::string _dataFileName
bool _isGoldFormat
bool _transientMode
 true if there are time steps
bool _singleFileMode
 only one or several meshes/fields in a data file
int _indexInDataFile
 which meshes/fields in a data file
std::string _time
 time of a step
_InterMed_imed
 to be used by field driver
string _imedMapKey
 key in the map storing mesh data for usage by field drv

Friends

class _CaseFileDriver

Detailed Description

Base of all Ensight drivers. It stores data passed from case file.


Constructor & Destructor Documentation

MEDMEM_ENSIGHT._CaseFileDriver_User::_CaseFileDriver_User ( const std::string &  caseFileName = "",
MED_EN::med_mode_acces  mode = MED_EN::RDWR 
)

_CaseFileDriver_User constructor

MEDMEM_ENSIGHT._CaseFileDriver_User::~_CaseFileDriver_User (  ) 

Member Function Documentation

const std::string& MEDMEM_ENSIGHT._CaseFileDriver_User.getCaseFileName (  )  const
const std::string& MEDMEM_ENSIGHT._CaseFileDriver_User.getDataFileName (  )  const
bool MEDMEM_ENSIGHT._CaseFileDriver_User.isGoldFormat (  )  const

returns true if there are several meshes/fields in a data file

References MEDMEM_ENSIGHT._CaseFileDriver_User._isGoldFormat.

bool MEDMEM_ENSIGHT._CaseFileDriver_User.isSingleFileMode (  )  const

index of meshes/fields in a data file, zero for static mesh/feild

References MEDMEM_ENSIGHT._CaseFileDriver_User._singleFileMode.

int MEDMEM_ENSIGHT._CaseFileDriver_User.getIndexInDataFile (  )  const

true if there are time steps, i.e. getTime() has sense

References MEDMEM_ENSIGHT._CaseFileDriver_User._indexInDataFile.

bool MEDMEM_ENSIGHT._CaseFileDriver_User.isTransientMode (  )  const
double MEDMEM_ENSIGHT._CaseFileDriver_User.getTime (  )  const
void MEDMEM_ENSIGHT._CaseFileDriver_User::setInterData ( _InterMed imed  ) 

< for mesh driver to store data

method called by mesh driver at reading to store data to be used by field driver

for field driver to get mesh data

References MEDMEM_ENSIGHT._CaseFileDriver_User._imedMapKey, MEDMEM_ENSIGHT._InterMed._isOwnMedMesh, MEDMEM_ENSIGHT._InterMed._medMesh, and MEDMEM_ENSIGHT.theInterMedMap.

_InterMed * MEDMEM_ENSIGHT._CaseFileDriver_User::getInterData (  ) 
_SubPart * MEDMEM_ENSIGHT._CaseFileDriver_User::getSubPart ( const _SubPartDesc descriptor  )  throw (MEDEXCEPTION)
_Support * MEDMEM_ENSIGHT._CaseFileDriver_User::getSupport ( const _SupportDesc descriptor,
const medEntityMesh  entity 
) throw (MEDEXCEPTION)
int MEDMEM_ENSIGHT._CaseFileDriver_User::getPartNumber ( const SUPPORT support  )  const
bool MEDMEM_ENSIGHT._CaseFileDriver_User::canOpenFile ( const string &  fileName,
med_mode_acces  mode 
) [static]

check possibility to open a file with a given mode

References MED_EN.WRONLY.

void MEDMEM_ENSIGHT._CaseFileDriver_User::getSupportNodes ( const SUPPORT sup,
map< int, int > &  nodeIds 
) [static]
bool MEDMEM_ENSIGHT._CaseFileDriver_User::isBinaryDataFile ( const string &  dataFileName  )  [static]

analyse if data file is binary

References MEDMEM.GENDRIVER.close(), MEDMEM.GENDRIVER.open(), and MEDMEM.GENDRIVER.read().

static bool MEDMEM_ENSIGHT._CaseFileDriver_User.isTimeStepBeginning ( const string &  line  )  [static]
static bool MEDMEM_ENSIGHT._CaseFileDriver_User.isTimeStepEnd ( const char *  line  )  [static]
bool MEDMEM_ENSIGHT._CaseFileDriver_User::isToWriteEntity ( const medEntityMesh  entity,
const MESH mesh 
) [static]

Friends And Related Function Documentation

friend class _CaseFileDriver [friend]

Field Documentation

true if there are time steps

only one or several meshes/fields in a data file

which meshes/fields in a data file

time of a step

to be used by field driver

key in the map storing mesh data for usage by field drv