Ogshow Class Reference

#include <Ogshow.h>

Collaboration diagram for Ogshow:

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_DataBase *	getFrame (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 aString &	getShowFileName () 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 aString &	getFrameSeriesName (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
GenericDataBase *	showFile
GenericDataBase *	showDir
int	currentFrameSeries
int	showFileCounter
int	showFileCreated
bool	generalCommentsSaved
std::vector< aString >	generalComment
int	totalNumberOfFrames
int	numberOfFramesPerFile
int	magicNumber
int	defaultStreamMode
std::vector< OgshowFrameSeries >	frameSeriesList

Member Typedef Documentation

typedef int Ogshow::FrameSeriesID

Member Enumeration Documentation

enum Ogshow::GridLocationEnum

Enumerator
useDefaultLocation
useCurrentFrame

enum Ogshow::PlaceToSaveGeneralParameters

Enumerator
THEShowFileRoot
THECurrentFrameSeries

enum Ogshow::ShowFileOpenOption

Enumerator
openNewFileForWriting
openOldFileForWriting

Constructor & Destructor Documentation

Ogshow::Ogshow

(

)

References NOT_ON_SHOW_FILE_PROCESSOR.

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

References NOT_ON_SHOW_FILE_PROCESSOR.

Ogshow::~Ogshow

(

)

Member Function Documentation

int Ogshow::cleanup ( )

protected

References Ogshow::OgshowFrameSeries::frame, Ogshow::OgshowFrameSeries::id, Ogshow::OgshowFrameSeries::movingGridProblem, NOT_ON_SHOW_FILE_PROCESSOR, NULL, Ogshow::OgshowFrameSeries::numberOfFrames, GenericDataBase::put(), s, Ogshow::OgshowFrameSeries::sequenceNumber, Ogshow::OgshowFrameSeries::showDir, Ogshow::OgshowFrameSeries::streamMode, and Ogshow::OgshowFrameSeries::totalNumberOfFramesWhenCreated.

int Ogshow::close

(

)

References NOT_ON_SHOW_FILE_PROCESSOR.

Referenced by main(), plot3dToOverture(), and showFileFromDataFile().

int Ogshow::createShowFile ( const aString &  nameOfShowFile, const aString &  nameOfDirectory, ShowFileOpenOption  openOption  )

protected

References MappingRC::doNotLinkMappings, GenericDataBase::normalMode, GenericDataBase::noStreamMode, NOT_ON_SHOW_FILE_PROCESSOR, OV_ABORT, printF(), and MappingRC::setDataBaseMode().

int Ogshow::endFrame

(

)

References NOT_ON_SHOW_FILE_PROCESSOR, GenericDataBase::put(), and Ogshow::OgshowFrameSeries::showDir.

void Ogshow::flush

(

)

References NOT_ON_SHOW_FILE_PROCESSOR, and sPrintF().

Ogshow::FrameSeriesID Ogshow::getCurrentFrameSeries

(

)

const

References currentFrameSeries.

int Ogshow::getFlushFrequency

(

)

const

References NOT_ON_SHOW_FILE_PROCESSOR.

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

)

References frameSeriesList, newFrameSeries(), and nullString.

bool Ogshow::getIsMovingGridProblem

(

)

const

References NOT_ON_SHOW_FILE_PROCESSOR.

int Ogshow::getNumberOfFrames

(

)

const

References NOT_ON_SHOW_FILE_PROCESSOR.

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

References NOT_ON_SHOW_FILE_PROCESSOR.

bool Ogshow::isLastFrameInSubFile

(

)

const

References NOT_ON_SHOW_FILE_PROCESSOR.

Ogshow::FrameSeriesID Ogshow::newFrameSeries

(

const aString &

name

)

References GenericDataBase::create(), defaultStreamMode, Ogshow::OgshowFrameSeries::frame, frameSeriesList, Ogshow::OgshowFrameSeries::id, Ogshow::OgshowFrameSeries::name, GenericDataBase::normalMode, GenericDataBase::noStreamMode, setCurrentFrameSeries(), GenericDataBase::setMode(), showDir, Ogshow::OgshowFrameSeries::showDir, Ogshow::OgshowFrameSeries::streamMode, totalNumberOfFrames, and Ogshow::OgshowFrameSeries::totalNumberOfFramesWhenCreated.

Referenced by getFrameSeriesName(), and setCurrentFrameSeries().

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
	)

References Ogshow::OgshowFrameSeries::comment, Ogshow::OgshowFrameSeries::commentsSaved, and NOT_ON_SHOW_FILE_PROCESSOR.

Referenced by main(), plot3dToOverture(), and showFileFromDataFile().

int Ogshow::saveCommentsToFile ( )

protected

References aString, Ogshow::OgshowFrameSeries::comment, Ogshow::OgshowFrameSeries::commentsSaved, Ogshow::OgshowFrameSeries::frame, NOT_ON_SHOW_FILE_PROCESSOR, GenericDataBase::put(), and s.

int Ogshow::saveGeneralComment

(

const aString &

comment

)

References NOT_ON_SHOW_FILE_PROCESSOR.

Referenced by main(), plot3dToOverture(), and showFileFromDataFile().

int Ogshow::saveGeneralCommentsToFile ( )

protected

References aString, NOT_ON_SHOW_FILE_PROCESSOR, and s.

int Ogshow::saveGeneralParameters	(	ListOfShowFileParameters &	params,
		const PlaceToSaveGeneralParameters	placeToSave = THECurrentFrameSeries
	)

References aString, ShowFileParameter::get(), NOT_ON_SHOW_FILE_PROCESSOR, and GenericDataBase::put().

Referenced by main(), plot3dToOverture(), and showFileFromDataFile().

int Ogshow::saveParameters	(	const aString &	nameOfDirectory,
		ListOfShowFileParameters &	params
	)

References assert, aString, GenericDataBase::create(), ShowFileParameter::get(), NOT_ON_SHOW_FILE_PROCESSOR, NULL, GenericDataBase::put(), and GenericDataBase::virtualConstructor().

int Ogshow::saveSequence	(	const aString &	name,
		const RealArray &	time,
		const RealArray &	value,
		aString *	name1 = NULL,
		aString *	name2 = NULL
	)

References assert, aString, c, GenericDataBase::create(), NOT_ON_SHOW_FILE_PROCESSOR, NULL, OV_ABORT, printF(), HDF_DataBase::put(), Ogshow::OgshowFrameSeries::sequenceNumber, Ogshow::OgshowFrameSeries::showDir, and sPrintF().

int Ogshow::saveSolution	(	realGridCollectionFunction &	u,
		const aString &	name = "u",
		int	frameForGrid = useDefaultLocation
	)

References checkArrays(), GenericDataBase::get(), GET_NUMBER_OF_ARRAYS, GridCollectionData::getClassName(), GridCollection::getClassName(), doubleGridCollectionFunction::getGridCollection(), NULL, printF(), GenericDataBase::put(), doubleGridCollectionFunction::put(), GridCollection::put(), CompositeGrid::put(), realGridCollectionFunction, ParallelGridUtility::redistribute(), MappedGrid::THEmask, GenericDataBase::turnOffWarnings(), and GenericDataBase::turnOnWarnings().

Referenced by main(), plot3dToOverture(), and showFileFromDataFile().

int Ogshow::saveSolution	(	realMappedGridFunction &	u,
		const aString &	name = "u",
		int	frameForGrid = useDefaultLocation
	)

References doubleMappedGridFunction::getComponentBase(), doubleMappedGridFunction::getComponentBound(), doubleMappedGridFunction::getComponentDimension(), doubleMappedGridFunction::getMappedGrid(), doubleMappedGridFunction::getName(), MappedGrid::numberOfDimensions(), doubleMappedGridFunction::positionOfComponent(), R, CompositeGrid::reference(), and doubleMappedGridFunction::setName().

int Ogshow::setCurrentFrameSeries

(

const FrameSeriesID

frameSeries

)

References currentFrameSeries, and frameSeriesList.

Referenced by newFrameSeries(), and setCurrentFrameSeries().

Ogshow::FrameSeriesID Ogshow::setCurrentFrameSeries

(

const aString &

name

)

References getFrameSeriesID(), newFrameSeries(), and setCurrentFrameSeries().

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

)

References aString, GenericDataBase::create(), Ogshow::OgshowFrameSeries::frame, Ogshow::OgshowFrameSeries::frameNumber, Ogshow::OgshowFrameSeries::globalFrameNumber, GenericDataBase::locate(), NOT_ON_SHOW_FILE_PROCESSOR, Ogshow::OgshowFrameSeries::numberOfFrames, printF(), Ogshow::OgshowFrameSeries::sequenceNumber, Ogshow::OgshowFrameSeries::showDir, and sPrintF().

Referenced by main(), plot3dToOverture(), and showFileFromDataFile().

Member Data Documentation

int Ogshow::currentFrameSeries

protected

Referenced by getCurrentFrameSeries(), and setCurrentFrameSeries().

int Ogshow::defaultStreamMode

protected

Referenced by newFrameSeries().

std::vector<OgshowFrameSeries> Ogshow::frameSeriesList

protected

Referenced by getFrameSeriesID(), getFrameSeriesName(), getNumberOfFrameSeries(), newFrameSeries(), setCurrentFrameSeries(), and setFrameSeriesName().

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:

• Ogshow.h
• Ogshow.C