Overture  Version 25
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Ogshow Class Reference

#include <Ogshow.h>

Collaboration diagram for Ogshow:
Collaboration graph
[legend]

Classes

struct  OgshowFrameSeries
 

Public Types

enum  ShowFileOpenOption { openNewFileForWriting, openOldFileForWriting }
 
enum  PlaceToSaveGeneralParameters { THEShowFileRoot =-2, THECurrentFrameSeries =-1 }
 
enum  GridLocationEnum { useDefaultLocation =-2, useCurrentFrame =-1 }
 
typedef int FrameSeriesID
 

Public Member Functions

 Ogshow ()
 
 Ogshow (const aString &nameOfShowFile, const aString &nameOfDirectory=".", int useStreamMode=false, ShowFileOpenOption openOption=openNewFileForWriting)
 
 ~Ogshow ()
 
HDF_DataBasegetFrame (const Ogshow::FrameSeriesID=0)
 
int open (const aString &nameOfShowFile, const aString &nameOfDirectory=".", int useStreamMode=false, ShowFileOpenOption openOption=openNewFileForWriting)
 
int close ()
 
int saveGeneralComment (const aString &comment)
 
int saveComment (const int commentNumber, const aString &comment)
 
int saveSequence (const aString &name, const RealArray &time, const RealArray &value, aString *name1=NULL, aString *name2=NULL)
 
int saveGeneralParameters (ListOfShowFileParameters &params, const PlaceToSaveGeneralParameters placeToSave=THECurrentFrameSeries)
 
int saveParameters (const aString &nameOfDirectory, ListOfShowFileParameters &params)
 
int getTotalNumberOfFrames () const
 
int getNumberOfFrames () const
 
const aStringgetShowFileName () const
 
int saveSolution (realGridCollectionFunction &u, const aString &name="u", int frameForGrid=useDefaultLocation)
 
int saveSolution (realMappedGridFunction &u, const aString &name="u", int frameForGrid=useDefaultLocation)
 
int getNumberOfFrameSeries () const
 
FrameSeriesID newFrameSeries (const aString &name)
 
FrameSeriesID getFrameSeriesID (const aString &name)
 
const aStringgetFrameSeriesName (const FrameSeriesID frameSeries)
 
int setFrameSeriesName (const FrameSeriesID frameSeries, const aString &name)
 
FrameSeriesID getCurrentFrameSeries () const
 
int setCurrentFrameSeries (const FrameSeriesID frameSeries)
 
int setCurrentFrameSeries (const aString &name)
 
int startFrame (const int frame=-1)
 
int endFrame ()
 
bool getIsMovingGridProblem () const
 
void setIsMovingGridProblem (const bool trueOrFalse)
 
void setFlushFrequency (const int flushFrequency=5)
 
int getFlushFrequency () const
 
bool isFirstFrameInSubFile () const
 
bool isLastFrameInSubFile () const
 
void flush ()
 

Protected Member Functions

void initialize ()
 
int cleanup ()
 
int createShowFile (const aString &nameOfShowFile, const aString &nameOfDirectory, ShowFileOpenOption openOption)
 
int saveGeneralCommentsToFile ()
 
int saveCommentsToFile ()
 

Protected Attributes

aString showFileName
 
aString showFileDirectory
 
GenericDataBaseshowFile
 
GenericDataBaseshowDir
 
int currentFrameSeries
 
int showFileCounter
 
int showFileCreated
 
bool generalCommentsSaved
 
std::vector< aStringgeneralComment
 
int totalNumberOfFrames
 
int numberOfFramesPerFile
 
int magicNumber
 
int defaultStreamMode
 
std::vector< OgshowFrameSeriesframeSeriesList
 

Member Typedef Documentation

typedef int Ogshow::FrameSeriesID

Member Enumeration Documentation

Enumerator
useDefaultLocation 
useCurrentFrame 
Enumerator
THEShowFileRoot 
THECurrentFrameSeries 
Enumerator
openNewFileForWriting 
openOldFileForWriting 

Constructor & Destructor Documentation

Ogshow::Ogshow ( )
Ogshow::Ogshow ( const aString nameOfShowFile,
const aString nameOfDirectory = ".",
int  useStreamMode = false,
ShowFileOpenOption  openOption = openNewFileForWriting 
)
Ogshow::~Ogshow ( )

Member Function Documentation

int Ogshow::cleanup ( )
protected
int Ogshow::close ( )
int Ogshow::createShowFile ( const aString nameOfShowFile,
const aString nameOfDirectory,
ShowFileOpenOption  openOption 
)
protected
int Ogshow::endFrame ( )
void Ogshow::flush ( )
Ogshow::FrameSeriesID Ogshow::getCurrentFrameSeries ( ) const

References currentFrameSeries.

int Ogshow::getFlushFrequency ( ) const
HDF_DataBase * Ogshow::getFrame ( const Ogshow::FrameSeriesID  = 0)

References NOT_ON_SHOW_FILE_PROCESSOR, and NULL.

Referenced by main().

Ogshow::FrameSeriesID Ogshow::getFrameSeriesID ( const aString name)

References frameSeriesList.

Referenced by setCurrentFrameSeries().

const aString & Ogshow::getFrameSeriesName ( const FrameSeriesID  frameSeries)
bool Ogshow::getIsMovingGridProblem ( ) const
int Ogshow::getNumberOfFrames ( ) const
int Ogshow::getNumberOfFrameSeries ( ) const

References frameSeriesList, and max().

const aString & Ogshow::getShowFileName ( ) const
int Ogshow::getTotalNumberOfFrames ( ) const
void Ogshow::initialize ( )
protected

References NOT_ON_SHOW_FILE_PROCESSOR, and NULL.

bool Ogshow::isFirstFrameInSubFile ( ) const
bool Ogshow::isLastFrameInSubFile ( ) const
Ogshow::FrameSeriesID Ogshow::newFrameSeries ( const aString name)
int Ogshow::open ( const aString nameOfShowFile,
const aString nameOfDirectory = ".",
int  useStreamMode = false,
ShowFileOpenOption  openOption = openNewFileForWriting 
)

References NOT_ON_SHOW_FILE_PROCESSOR.

Referenced by main().

int Ogshow::saveComment ( const int  commentNumber,
const aString comment 
)
int Ogshow::saveCommentsToFile ( )
protected
int Ogshow::saveGeneralComment ( const aString comment)
int Ogshow::saveGeneralCommentsToFile ( )
protected
int Ogshow::saveGeneralParameters ( ListOfShowFileParameters params,
const PlaceToSaveGeneralParameters  placeToSave = THECurrentFrameSeries 
)
int Ogshow::saveParameters ( const aString nameOfDirectory,
ListOfShowFileParameters params 
)
int Ogshow::saveSequence ( const aString name,
const RealArray time,
const RealArray value,
aString name1 = NULL,
aString name2 = NULL 
)
int Ogshow::saveSolution ( realGridCollectionFunction u,
const aString name = "u",
int  frameForGrid = useDefaultLocation 
)
int Ogshow::saveSolution ( realMappedGridFunction u,
const aString name = "u",
int  frameForGrid = useDefaultLocation 
)
int Ogshow::setCurrentFrameSeries ( const FrameSeriesID  frameSeries)
Ogshow::FrameSeriesID Ogshow::setCurrentFrameSeries ( const aString name)
void Ogshow::setFlushFrequency ( const int  flushFrequency = 5)

References NOT_ON_SHOW_FILE_PROCESSOR.

Referenced by main().

int Ogshow::setFrameSeriesName ( const FrameSeriesID  frameSeries,
const aString name 
)

References frameSeriesList, and printF().

void Ogshow::setIsMovingGridProblem ( const bool  trueOrFalse)

References NOT_ON_SHOW_FILE_PROCESSOR.

Referenced by main().

int Ogshow::startFrame ( const int  frame = -1)

Member Data Documentation

int Ogshow::currentFrameSeries
protected
int Ogshow::defaultStreamMode
protected

Referenced by newFrameSeries().

std::vector<OgshowFrameSeries> Ogshow::frameSeriesList
protected
std::vector<aString> Ogshow::generalComment
protected
bool Ogshow::generalCommentsSaved
protected
int Ogshow::magicNumber
protected
int Ogshow::numberOfFramesPerFile
protected
GenericDataBase* Ogshow::showDir
protected

Referenced by newFrameSeries().

GenericDataBase* Ogshow::showFile
protected
int Ogshow::showFileCounter
protected
int Ogshow::showFileCreated
protected
aString Ogshow::showFileDirectory
protected
aString Ogshow::showFileName
protected
int Ogshow::totalNumberOfFrames
protected

Referenced by newFrameSeries().


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