Overture  Version 25
Public Types | Public Member Functions | List of all members
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_DataBasegetFrame (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 aStringgetHeaderComments (int &numberOfHeaderComments)
 
int getGeneralParameters (const int displayInfo=1)
 
ListOfShowFileParametersgetListOfGeneralParameters (const Ogshow::PlaceToSaveGeneralParameters placeToSave=Ogshow::THECurrentFrameSeries)
 
void setMaximumNumberOfOpenShowFiles (const int maxNumber)
 

Member Enumeration Documentation

Enumerator
useDefaultLocation 
useCurrentFrame 
Enumerator
notFound 
solutionFound 
gridFound 
solutionAndGridFound 

Constructor & Destructor Documentation

ShowFileReader::ShowFileReader ( const aString nameOfShowFile = nullString)
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 
)
ShowFileReader::ReturnType ShowFileReader::getASolution ( int &  solutionNumber,
MappedGrid cg,
realMappedGridFunction u 
)
ShowFileReader::ReturnType ShowFileReader::getASolution ( int &  solutionNumber,
GridCollection cg,
realGridCollectionFunction u 
)
Ogshow::FrameSeriesID ShowFileReader::getCurrentFrameSeries ( ) const
HDF_DataBase * ShowFileReader::getFrame ( int  solutionNumber = -1)
aString ShowFileReader::getFrameSeriesName ( const Ogshow::FrameSeriesID  frame_series)
bool ShowFileReader::getGeneralParameter ( const aString name,
int &  value,
const Ogshow::PlaceToSaveGeneralParameters  placeToSave = Ogshow::THECurrentFrameSeries 
)
bool ShowFileReader::getGeneralParameter ( const aString name,
real value,
const Ogshow::PlaceToSaveGeneralParameters  placeToSave = Ogshow::THECurrentFrameSeries 
)
bool ShowFileReader::getGeneralParameter ( const aString name,
aString value,
const Ogshow::PlaceToSaveGeneralParameters  placeToSave = Ogshow::THECurrentFrameSeries 
)
bool ShowFileReader::getGeneralParameter ( const aString name,
ShowFileParameter::ParameterType  type,
int &  value,
real rValue,
aString stringValue,
const Ogshow::PlaceToSaveGeneralParameters  placeToSave = Ogshow::THECurrentFrameSeries 
)
int ShowFileReader::getGeneralParameters ( const int  displayInfo = 1)
const aString * ShowFileReader::getHeaderComments ( int &  numberOfHeaderComments)
ListOfShowFileParameters & ShowFileReader::getListOfGeneralParameters ( const Ogshow::PlaceToSaveGeneralParameters  placeToSave = Ogshow::THECurrentFrameSeries)

References Ogshow::THECurrentFrameSeries.

Referenced by main().

int ShowFileReader::getNumberOfFrames ( ) const
int ShowFileReader::getNumberOfFrameSeries ( ) const
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 
)
int ShowFileReader::getSequence ( int  sequenceNumber,
aString name,
RealArray time,
RealArray value,
aString componentName1,
int  maxcomponentName1,
aString componentName2,
int  maxcomponentName2 
)
int ShowFileReader::getSequenceNames ( aString name,
int  maximumNumberOfNames 
)
bool ShowFileReader::isAMovingGrid ( )

Referenced by getAGrid(), and getASolution().

int ShowFileReader::open ( const aString nameOfShowFile,
const int  displayInfo = 1 
)
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: