ShowFileReader Class Reference

#include <ShowFileReader.h>

Public Types
enum	ReturnType { notFound =0, solutionFound =1, gridFound =2, solutionAndGridFound =3 }
enum	GridLocationEnum { useDefaultLocation =-2, useCurrentFrame =-1 }

Public Member Functions
	ShowFileReader (const aString &nameOfShowFile=nullString)
	~ShowFileReader ()
int	open (const aString &nameOfShowFile, const int displayInfo=1)
int	close ()
int	getNumberOfFrameSeries () const
aString	getFrameSeriesName (const Ogshow::FrameSeriesID frame_series)
int	getNumberOfFrames () const
int	getNumberOfSolutions () const
int	getNumberOfSequences () const
int	setCurrentFrameSeries (const Ogshow::FrameSeriesID frame_series)
Ogshow::FrameSeriesID	getCurrentFrameSeries () const
ReturnType	getAGrid (MappedGrid &cg, int &solutionNumber, int frameForGrid=useDefaultLocation)
ReturnType	getAGrid (GridCollection &cg, int &solutionNumber, int frameForGrid=useDefaultLocation)
ReturnType	getASolution (int &solutionNumber, MappedGrid &cg, realMappedGridFunction &u)
ReturnType	getASolution (int &solutionNumber, GridCollection &cg, realGridCollectionFunction &u)
int	getSequenceNames (aString *name, int maximumNumberOfNames)
int	getSequence (int sequenceNumber, aString &name, RealArray &time, RealArray &value, aString *componentName1, int maxcomponentName1, aString *componentName2, int maxcomponentName2)
HDF_DataBase *	getFrame (int solutionNumber=-1)
bool	isAMovingGrid ()
bool	getGeneralParameter (const aString &name, int &value, const Ogshow::PlaceToSaveGeneralParameters placeToSave=Ogshow::THECurrentFrameSeries)
bool	getGeneralParameter (const aString &name, real &value, const Ogshow::PlaceToSaveGeneralParameters placeToSave=Ogshow::THECurrentFrameSeries)
bool	getGeneralParameter (const aString &name, aString &value, const Ogshow::PlaceToSaveGeneralParameters placeToSave=Ogshow::THECurrentFrameSeries)
bool	getGeneralParameter (const aString &name, ShowFileParameter::ParameterType type, int &value, real &rValue, aString &stringValue, const Ogshow::PlaceToSaveGeneralParameters placeToSave=Ogshow::THECurrentFrameSeries)
bool	getParameters (const aString &nameOfDirectory, ListOfShowFileParameters &params)
const aString *	getHeaderComments (int &numberOfHeaderComments)
int	getGeneralParameters (const int displayInfo=1)
ListOfShowFileParameters &	getListOfGeneralParameters (const Ogshow::PlaceToSaveGeneralParameters placeToSave=Ogshow::THECurrentFrameSeries)
void	setMaximumNumberOfOpenShowFiles (const int maxNumber)

Member Enumeration Documentation

enum ShowFileReader::GridLocationEnum

Enumerator
useDefaultLocation
useCurrentFrame

enum ShowFileReader::ReturnType

Enumerator
notFound
solutionFound
gridFound
solutionAndGridFound

Constructor & Destructor Documentation

ShowFileReader::ShowFileReader

(

const aString &

nameOfShowFile = nullString

)

References MappingRC::doNotLinkMappings, FALSE, nullString, open(), and MappingRC::setDataBaseMode().

ShowFileReader::~ShowFileReader

(

)

References close().

Member Function Documentation

int ShowFileReader::close

(

)

References NULL, and GenericDataBase::unmount().

Referenced by main(), and ~ShowFileReader().

ShowFileReader::ReturnType ShowFileReader::getAGrid	(	MappedGrid &	cg,
		int &	solutionNumber,
		int	frameForGrid = useDefaultLocation
	)

References MappedGrid::reference().

Referenced by getASolution(), and ogen().

ShowFileReader::ReturnType ShowFileReader::getAGrid	(	GridCollection &	cg,
		int &	solutionNumber,
		int	frameForGrid = useDefaultLocation
	)

References Overture::abort(), aString, debug, GenericDataBase::find(), HDF_DataBase::get(), GridCollection::get(), getFrame(), getFromADataBase(), gridFound, isAMovingGrid(), HDF_DataBase::locate(), max(), min(), GenericDataBase::noStreamMode, notFound, GenericGridCollection::numberOfComponentGrids(), printF(), GenericDataBase::setMode(), sPrintF(), HDF_DataBase::turnOffWarnings(), HDF_DataBase::turnOnWarnings(), useCurrentFrame, and useDefaultLocation.

ShowFileReader::ReturnType ShowFileReader::getASolution	(	int &	solutionNumber,
		MappedGrid &	cg,
		realMappedGridFunction &	u
	)

References doubleMappedGridFunction::reference(), and MappedGrid::reference().

Referenced by DerivedFunctions::getASolution(), main(), ShowFilePlotter::plot(), and readMappingsFromAnOverlappingGridFile().

ShowFileReader::ReturnType ShowFileReader::getASolution	(	int &	solutionNumber,
		GridCollection &	cg,
		realGridCollectionFunction &	u
	)

References Overture::abort(), HDF_DataBase::get(), doubleGridCollectionFunction::get(), getAGrid(), getFrame(), gridFound, isAMovingGrid(), notFound, GenericGridCollection::numberOfComponentGrids(), printF(), solutionAndGridFound, solutionFound, HDF_DataBase::turnOffWarnings(), HDF_DataBase::turnOnWarnings(), and doubleGridCollectionFunction::updateToMatchGrid().

Ogshow::FrameSeriesID ShowFileReader::getCurrentFrameSeries

(

)

const

HDF_DataBase * ShowFileReader::getFrame

(

int

solutionNumber = -1

)

References Overture::abort(), HDF_DataBase::isNull(), HDF_DataBase::locate(), NULL, printF(), and sPrintF().

Referenced by DerivedFunctions::computeDerivedFunctions(), PlotIt::contour1d(), getAGrid(), getASolution(), DerivedFunctions::getComponent(), getParameters(), DerivedFunctions::getUserDefinedDerivedFunction(), main(), ShowFilePlotter::plot(), and PlotIt::userDefinedOutput().

aString ShowFileReader::getFrameSeriesName

(

const Ogshow::FrameSeriesID

frame_series

)

Referenced by ShowFilePlotter::buildPlotStuffDialog(), ShowFilePlotter::plot(), and ShowFilePlotter::plotAll().

bool ShowFileReader::getGeneralParameter	(	const aString &	name,
		int &	value,
		const Ogshow::PlaceToSaveGeneralParameters	placeToSave = Ogshow::THECurrentFrameSeries
	)

References aString, and ShowFileParameter::intParameter.

Referenced by DerivedFunctions::computeDerivedFunctions(), DerivedFunctions::getComponent(), getGeneralParameter(), DerivedFunctions::getUserDefinedDerivedFunction(), DerivedFunctions::setupUserDefinedDerivedFunction(), and PlotIt::userDefinedOutput().

bool ShowFileReader::getGeneralParameter	(	const aString &	name,
		real &	value,
		const Ogshow::PlaceToSaveGeneralParameters	placeToSave = Ogshow::THECurrentFrameSeries
	)

References aString, getGeneralParameter(), and ShowFileParameter::realParameter.

bool ShowFileReader::getGeneralParameter	(	const aString &	name,
		aString &	value,
		const Ogshow::PlaceToSaveGeneralParameters	placeToSave = Ogshow::THECurrentFrameSeries
	)

References getGeneralParameter(), and ShowFileParameter::stringParameter.

bool ShowFileReader::getGeneralParameter	(	const aString &	name,
		ShowFileParameter::ParameterType	type,
		int &	value,
		real &	rValue,
		aString &	stringValue,
		const Ogshow::PlaceToSaveGeneralParameters	placeToSave = Ogshow::THECurrentFrameSeries
	)

References aString, ShowFileParameter::get(), ShowFileParameter::getType(), printF(), and Ogshow::THECurrentFrameSeries.

int ShowFileReader::getGeneralParameters

(

const int

displayInfo = 1

)

References aString, GenericDataBase::find(), HDF_DataBase::get(), ShowFileParameter::intParameter, printF(), ShowFileParameter::realParameter, ShowFileParameter::set(), HDF_DataBase::turnOffWarnings(), and HDF_DataBase::turnOnWarnings().

Referenced by open().

const aString * ShowFileReader::getHeaderComments

(

int &

numberOfHeaderComments

)

Referenced by ShowFilePlotter::getHeaderComments().

ListOfShowFileParameters & ShowFileReader::getListOfGeneralParameters

(

const Ogshow::PlaceToSaveGeneralParameters

placeToSave = Ogshow::THECurrentFrameSeries

)

References Ogshow::THECurrentFrameSeries.

Referenced by main().

int ShowFileReader::getNumberOfFrames

(

)

const

References Overture::abort(), and printF().

Referenced by main(), ogen(), ShowFilePlotter::plot(), and readMappingsFromAnOverlappingGridFile().

int ShowFileReader::getNumberOfFrameSeries

(

)

const

Referenced by ShowFilePlotter::buildPlotStuffDialog(), and ShowFilePlotter::plot().

int ShowFileReader::getNumberOfSequences

(

)

const

References Overture::abort(), and printF().

Referenced by ShowFilePlotter::plot().

int ShowFileReader::getNumberOfSolutions

(

)

const

References Overture::abort(), and printF().

bool ShowFileReader::getParameters	(	const aString &	nameOfDirectory,
		ListOfShowFileParameters &	params
	)

References assert, aString, GenericDataBase::get(), getFrame(), ShowFileParameter::intParameter, GenericDataBase::locate(), notFound, NULL, printF(), ShowFileParameter::realParameter, ShowFileParameter::set(), GenericDataBase::turnOffWarnings(), GenericDataBase::turnOnWarnings(), and GenericDataBase::virtualConstructor().

Referenced by ShowFilePlotter::setFrameSeriesTitles().

int ShowFileReader::getSequence	(	int	sequenceNumber,
		aString &	name,
		RealArray &	time,
		RealArray &	value,
		aString *	componentName1,
		int	maxcomponentName1,
		aString *	componentName2,
		int	maxcomponentName2
	)

References aString, HDF_DataBase::find(), HDF_DataBase::get(), HDF_DataBase::locate(), GenericDataBase::locate(), printF(), s, and sPrintF().

Referenced by ShowFilePlotter::plot().

int ShowFileReader::getSequenceNames	(	aString *	name,
		int	maximumNumberOfNames
	)

References aString, HDF_DataBase::find(), HDF_DataBase::get(), HDF_DataBase::locate(), GenericDataBase::locate(), min(), printF(), s, and sPrintF().

Referenced by ShowFilePlotter::plot().

bool ShowFileReader::isAMovingGrid

(

)

Referenced by getAGrid(), and getASolution().

int ShowFileReader::open	(	const aString &	nameOfShowFile,
		const int	displayInfo = 1
	)

References Overture::abort(), aString, FALSE, GenericDataBase::get(), getGeneralParameters(), GenericDataBase::mount(), GenericDataBase::noStreamMode, NULL, OVERTURE_VERSION, printF(), GenericDataBase::setMode(), GenericDataBase::turnOffWarnings(), and GenericDataBase::turnOnWarnings().

Referenced by main(), ShowFilePlotter::ShowFilePlotter(), and ShowFileReader().

int ShowFileReader::setCurrentFrameSeries

(

const Ogshow::FrameSeriesID

frame_series

)

Referenced by main(), and ShowFilePlotter::plot().

void ShowFileReader::setMaximumNumberOfOpenShowFiles

(

const int

maxNumber

)

References max(), and min().

Referenced by ShowFilePlotter::plot().

---

The documentation for this class was generated from the following files:

• ShowFileReader.h
• ShowFileReader.C