MEDMEM_ENSIGHT._CaseFileDriver Class Reference

Reader/writer of EnSight Case file. More...

#include <MEDMEM_EnsightUtils.hxx>

Data Structures
struct	_FileSet
struct	_Model
struct	_TimeSet
struct	_Variable
Public Types
typedef std::map< std::string, std::list < ENSIGHT_FIELD_WRONLY_DRIVER * > >	TFieldDriversByName
Public Member Functions
	_CaseFileDriver (const string &fileName, const _CaseFileDriver_User *creator)
	Case file driver constructor.
	~_CaseFileDriver ()
	Case file driver destructor.
void	read () throw (MEDEXCEPTION)
	Read Case file.
int	getNbMeshes () const
	sets all data necessary for meshDriver.read()
void	setDataFileName (const int meshIndex, ENSIGHT_MESH_RDONLY_DRIVER *meshDriver)
	Sets all data necessary for meshDriver.read().
int	getNbVariables () const
	Return nb of ensight variables.
int	getNbVarSteps (const int variableIndex)
	return variable index by variable name, return 0 if none found
int	getVariableIndex (const string &varName) const
	sets all data necessary for fieldDriver.read(), returns meshIndex
int	setDataFileName (const int varIndex, const int stepIndex, ENSIGHT_FIELD_RDONLY_DRIVER *fieldDriver)
	sets all data necessary for fieldDriver.read()
void	addMesh (const ENSIGHT_MESH_WRONLY_DRIVER *meshDriver)
	< add a mesh to the Case file
void	addField (const ENSIGHT_FIELD_WRONLY_DRIVER *fieldDriver)
	write and set necessary data to added drivers
void	write () throw (MEDEXCEPTION)
	writing Case file
bool	checkWasRead () const throw (MEDEXCEPTION)
	< throw if Case file has not been read else return false
int	fixWildCardName (const int timeStep, const std::string &ts, const std::string &fs, std::string &fileName, std::string &time)
	replace '*' in file name if any and return index in file
Data Fields
std::string	_fileName
std::string	_directory
EnSightFormat	_format
_Model	_model
std::map< int, _Variable >	_variables
	map order number to variable data
std::map< int, _TimeSet >	_timeSets
	map ts to time set data
std::map< int, _FileSet >	_fileSets
	map fs to file set data
const _CaseFileDriver_User *	_user
	mesh/field driver
std::list < ENSIGHT_MESH_WRONLY_DRIVER * >	_meshDrivers
	added meshes
TFieldDriversByName	_fieldDrivers
	added field drivers groupped by name
bool	_blocked

Detailed Description

Reader/writer of EnSight Case file.

Apart from it's major job, it o assures cooperation of MED and Mesh/Field drivers so that the Case file created by MED driver is not overwritten by Mesh driver called by MED driver.

Member Typedef Documentation

typedef std::map<std::string, std::list< ENSIGHT_FIELD_WRONLY_DRIVER* > > MEDMEM_ENSIGHT._CaseFileDriver.TFieldDriversByName

Constructor & Destructor Documentation

MEDMEM_ENSIGHT._CaseFileDriver::_CaseFileDriver	(	const string &	fileName,
		const _CaseFileDriver_User *	creator
	)

Case file driver constructor.

References MEDMEM_ENSIGHT._CaseFileDriver._blocked, MEDMEM_ENSIGHT._CaseFileDriver._directory, MEDMEM_ENSIGHT._CaseFileDriver._fileName, MEDMEM_ENSIGHT._CaseFileDriver._format, FILE_SEPARATOR, MEDMEM.getEnSightFormatForWriting(), and MEDMEM_ENSIGHT.isToIgnore().

MEDMEM_ENSIGHT._CaseFileDriver::~_CaseFileDriver ( )

Case file driver destructor.

References MEDMEM_ENSIGHT._CaseFileDriver._blocked, MEDMEM_ENSIGHT._CaseFileDriver._user, and MEDMEM_ENSIGHT.unregister().

Member Function Documentation

void MEDMEM_ENSIGHT._CaseFileDriver::read ( void ) throw (MEDEXCEPTION)

Read Case file.

int MEDMEM_ENSIGHT._CaseFileDriver::getNbMeshes ( ) const

sets all data necessary for meshDriver.read()

return number of time steps of a model

References _ATOI, MEDMEM_ENSIGHT._CaseFileDriver._blocked, MEDMEM_ENSIGHT._CaseFileDriver._fileName, MEDMEM_ENSIGHT._CaseFileDriver._model, MEDMEM_ENSIGHT._CaseFileDriver._Model._timeSetNumber, MEDMEM_ENSIGHT._CaseFileDriver._timeSets, and MEDMEM_ENSIGHT._CaseFileDriver.checkWasRead().

void MEDMEM_ENSIGHT._CaseFileDriver::setDataFileName	(	const int	meshIndex,
		ENSIGHT_MESH_RDONLY_DRIVER *	meshDriver
	)

Sets all data necessary for meshDriver.read().

Parameters:

	meshIndex	- time step index
	meshDriver	- driver

int MEDMEM_ENSIGHT._CaseFileDriver::getNbVariables ( ) const

Return nb of ensight variables.

References MEDMEM_ENSIGHT._CaseFileDriver._variables.

int MEDMEM_ENSIGHT._CaseFileDriver::getNbVarSteps ( const int variableIndex )

return variable index by variable name, return 0 if none found

return number of time steps of a variable

References _ATOI, MEDMEM_ENSIGHT._CaseFileDriver._blocked, MEDMEM_ENSIGHT._CaseFileDriver._TimeSet._times, MEDMEM_ENSIGHT._CaseFileDriver._Variable._timeSetNumber, MEDMEM_ENSIGHT._CaseFileDriver._timeSets, MEDMEM_ENSIGHT._CaseFileDriver._variables, MEDMEM_ENSIGHT._CaseFileDriver.checkWasRead(), and MEDMEM_ENSIGHT.contains().

int MEDMEM_ENSIGHT._CaseFileDriver::getVariableIndex ( const string & varName ) const

sets all data necessary for fieldDriver.read(), returns meshIndex

return variable index by variable name, return 0 if none found

References MEDMEM_ENSIGHT._CaseFileDriver._blocked, MEDMEM_ENSIGHT._CaseFileDriver._variables, MEDMEM_ENSIGHT._CaseFileDriver.checkWasRead(), and MEDMEM_ENSIGHT.contains().

int MEDMEM_ENSIGHT._CaseFileDriver::setDataFileName	(	const int	varIndex,
		const int	stepIndex,
		ENSIGHT_FIELD_RDONLY_DRIVER *	fieldDriver
	)

sets all data necessary for fieldDriver.read()

void MEDMEM_ENSIGHT._CaseFileDriver::addMesh ( const ENSIGHT_MESH_WRONLY_DRIVER * meshDriver )

< add a mesh to the Case file

add a mesh to the Case file

add a field to the Case file

References MEDMEM_ENSIGHT._CaseFileDriver._blocked, MEDMEM_ENSIGHT._CaseFileDriver._format, MEDMEM_ENSIGHT._CaseFileDriver._meshDrivers, MEDMEM_ENSIGHT.compatibilityPb(), MEDMEM.ENSIGHT_6, MEDMEM.MESH.getName(), MEDMEM.MESH.getNumberOfPolygons(), MEDMEM.MESH.getNumberOfPolyhedron(), MEDMEM_ENSIGHT.isToIgnore(), and MED_test2.mesh.

void MEDMEM_ENSIGHT._CaseFileDriver::addField ( const ENSIGHT_FIELD_WRONLY_DRIVER * fieldDriver )

write and set necessary data to added drivers

add a field to the Case file

References MEDMEM_ENSIGHT._CaseFileDriver._blocked, MEDMEM_ENSIGHT._CaseFileDriver._fieldDrivers, MEDMEM_ENSIGHT.compatibilityPb(), MED_test2.field, Med_Gen_test.fieldName, MEDMEM.ENSIGHT_FIELD_DRIVER.getField(), MEDMEM.ENSIGHT_FIELD_DRIVER.getFieldName(), MEDMEM.FIELD_.getGaussPresence(), MEDMEM.SUPPORT.getMesh(), MEDMEM.FIELD_.getName(), MEDMEM.FIELD_.getNumberOfComponents(), MEDMEM.FIELD_.getNumberOfValues(), MEDMEM.FIELD_.getSupport(), MEDMEM_ENSIGHT.ILLEGAL_FIELD_NAME_CHARACTERS, MEDMEM_ENSIGHT.isToIgnore(), and MED_test2.mesh.

void MEDMEM_ENSIGHT._CaseFileDriver::write ( void ) throw (MEDEXCEPTION)

writing Case file

bool MEDMEM_ENSIGHT._CaseFileDriver::checkWasRead ( ) const throw (MEDEXCEPTION)

< throw if Case file has not been read else return false

Throws if case file has not been read else return false.

replace '*' in file name if any and return index in a file and time

References MEDMEM_ENSIGHT._CaseFileDriver._fileName, MEDMEM_ENSIGHT._CaseFileDriver._Model._fileName, and MEDMEM_ENSIGHT._CaseFileDriver._model.

int MEDMEM_ENSIGHT._CaseFileDriver::fixWildCardName	(	const int	timeStep,
		const std::string &	ts,
		const std::string &	fs,
		std::string &	fileName,
		std::string &	time
	)