ColumnDataWriter Class Reference

#include <ColumnDataWriter.hpp>

Collaboration diagram for ColumnDataWriter:

Public Member Functions
	ColumnDataWriter (const std::string &rDirectory, const std::string &rBaseName, bool cleanDirectory=true, unsigned precision=8)
virtual	~ColumnDataWriter ()
int	DefineUnlimitedDimension (const std::string &rDimensionName, const std::string &rDimensionUnits)
int	DefineFixedDimension (const std::string &rDimensionName, const std::string &rDimensionUnits, long dimensionSize)
int	DefineVariable (const std::string &rVariableName, const std::string &rVariableUnits)
virtual void	EndDefineMode ()
virtual void	AdvanceAlongUnlimitedDimension ()
virtual void	PutVariable (int variableID, double variableValue, long dimensionPosition=-1)
virtual void	Close ()
std::string	GetOutputDirectory ()
Protected Member Functions
void	CreateFixedDimensionFile (const std::string &rFileName)
void	CreateInfoFile (const std::string &rFileName)
void	CheckVariableName (const std::string &rName)
void	CheckUnitsName (const std::string &rName)
void	DoAdvanceAlongUnlimitedDimension ()
Protected Attributes
OutputFileHandler	mOutputFileHandler
std::string	mDirectory
std::string	mBaseName
bool	mIsInDefineMode
bool	mIsFixedDimensionSet
bool	mIsUnlimitedDimensionSet
long	mUnlimitedDimensionPosition
long	mFixedDimensionSize
out_stream	mpCurrentOutputFile
out_stream	mpCurrentAncillaryFile
DataWriterVariable *	mpUnlimitedDimensionVariable
DataWriterVariable *	mpFixedDimensionVariable
std::string	mUnlimitedDimensionName
std::string	mUnlimitedDimensionUnits
std::string	mFixedDimensionName
std::string	mFixedDimensionUnits
std::vector< DataWriterVariable >	mVariables
const unsigned	mFieldWidth
const unsigned	mPrecision
std::string	mFileExtension
int	mRowStartPosition
int	mRowWidth
int	mAncillaryRowStartPosition
int	mAncillaryRowWidth
bool	mHasPutVariable
bool	mNeedAdvanceAlongUnlimitedDimension
Static Protected Attributes
static const int	SPACING = 2
static const int	FIXED_DIMENSION_VAR_ID = -1
static const int	UNLIMITED_DIMENSION_VAR_ID = -2

Detailed Description

A concrete column data writer class. Writes grid-formatted data in space separated column form. Each file has a header row with names and optional units for each column.

Definition at line 45 of file ColumnDataWriter.hpp.

Constructor & Destructor Documentation

ColumnDataWriter::ColumnDataWriter	(	const std::string &	rDirectory,
		const std::string &	rBaseName,
		bool	cleanDirectory = `true`,
		unsigned	precision = `8`
	)

Constructor.

Parameters:

	rDirectory	the directory in which to write the data to file
	rBaseName	the name of the file in which to write the data
	cleanDirectory	whether to clean the directory (defaults to true)
	precision	the precision with which to write the data (i.e. exactly how many digits to display after the decimal point). Defaults to 8. Must be between 2 and 20 (inclusive).

Implementation file for ColumnDataWriter class.

Definition at line 46 of file ColumnDataWriter.cpp.

ColumnDataWriter::~ColumnDataWriter ( ) [virtual]

Destructor. Closes any open files.

Definition at line 73 of file ColumnDataWriter.cpp.

References Close(), mpFixedDimensionVariable, and mpUnlimitedDimensionVariable.

Member Function Documentation

void ColumnDataWriter::AdvanceAlongUnlimitedDimension ( ) [virtual]

Dummy function for DoAdvanceAlongUnlimitedDimension.

Implements AbstractDataWriter.

Reimplemented in ParallelColumnDataWriter.

Definition at line 387 of file ColumnDataWriter.cpp.

References mHasPutVariable, and mNeedAdvanceAlongUnlimitedDimension.

void ColumnDataWriter::CheckUnitsName ( const std::string & rName ) [protected]

Check name of unit is allowed, i.e. contains only alphanumeric & _, and isn't blank.

Parameters:

rName

unit name

Definition at line 118 of file ColumnDataWriter.cpp.

Referenced by CheckVariableName(), DefineFixedDimension(), DefineUnlimitedDimension(), and DefineVariable().

void ColumnDataWriter::CheckVariableName ( const std::string & rName ) [protected]

Check name of variable is allowed, i.e. contains only alphanumeric & _, and isn't blank.

Parameters:

rName

variable name

Definition at line 109 of file ColumnDataWriter.cpp.

References CheckUnitsName().

Referenced by DefineFixedDimension(), DefineUnlimitedDimension(), and DefineVariable().

void ColumnDataWriter::Close ( ) [virtual]

Close any open files.

Implements AbstractDataWriter.

Reimplemented in ParallelColumnDataWriter.

Definition at line 94 of file ColumnDataWriter.cpp.

References mpCurrentAncillaryFile, and mpCurrentOutputFile.

Referenced by ~ColumnDataWriter().

void ColumnDataWriter::CreateFixedDimensionFile ( const std::string & rFileName ) [protected]

Create the output file and write out the header for it.

Parameters:

rFileName

the name of the file to write to, relative to the output directory

Definition at line 313 of file ColumnDataWriter.cpp.

References mFixedDimensionSize, mOutputFileHandler, mpCurrentOutputFile, mpFixedDimensionVariable, mPrecision, mRowStartPosition, mRowWidth, DataWriterVariable::mVariableName, mVariables, DataWriterVariable::mVariableUnits, and OutputFileHandler::OpenOutputFile().

Referenced by DoAdvanceAlongUnlimitedDimension(), and EndDefineMode().

void ColumnDataWriter::CreateInfoFile ( const std::string & rFileName ) [protected]

Create the info file.

Parameters:

rFileName

the name of the file to create, relative to the output directory

Definition at line 342 of file ColumnDataWriter.cpp.

References ChasteBuildInfo::GetProvenanceString(), mFixedDimensionSize, mIsUnlimitedDimensionSet, mOutputFileHandler, mVariables, and OutputFileHandler::OpenOutputFile().

Referenced by EndDefineMode().

int ColumnDataWriter::DefineFixedDimension	(	const std::string &	rDimensionName,
		const std::string &	rDimensionUnits,
		long	dimensionSize
	)			`[virtual]`

Define the fixed dimension.

Parameters:

	rDimensionName	The name of the dimension
	rDimensionUnits	The physical units of the dimension
	dimensionSize	The size of the dimension

Returns:: The identifier of the variable

Implements AbstractDataWriter.

Definition at line 158 of file ColumnDataWriter.cpp.

References CheckUnitsName(), CheckVariableName(), FIXED_DIMENSION_VAR_ID, mFixedDimensionName, mFixedDimensionSize, mFixedDimensionUnits, mIsFixedDimensionSet, mIsInDefineMode, mpFixedDimensionVariable, DataWriterVariable::mVariableName, and DataWriterVariable::mVariableUnits.

int ColumnDataWriter::DefineUnlimitedDimension	(	const std::string &	rDimensionName,
		const std::string &	rDimensionUnits
	)			`[virtual]`

Define the unlimited dimension, i.e. the dimension that increases as the simulation progresses.

Parameters:

	rDimensionName	The name of the unlimited dimension
	rDimensionUnits	The physical units of the unlimited dimension

Returns:: The identifier of the variable

Implements AbstractDataWriter.

Definition at line 130 of file ColumnDataWriter.cpp.

References CheckUnitsName(), CheckVariableName(), mIsInDefineMode, mIsUnlimitedDimensionSet, mpUnlimitedDimensionVariable, mUnlimitedDimensionName, mUnlimitedDimensionUnits, DataWriterVariable::mVariableName, DataWriterVariable::mVariableUnits, and UNLIMITED_DIMENSION_VAR_ID.

int ColumnDataWriter::DefineVariable	(	const std::string &	rVariableName,
		const std::string &	rVariableUnits
	)			`[virtual]`

Define a variable.

Parameters:

	rVariableName	The name of the variable
	rVariableUnits	The physical units of the variable

Returns:: The identifier of the variable

Implements AbstractDataWriter.

Definition at line 186 of file ColumnDataWriter.cpp.

References CheckUnitsName(), CheckVariableName(), mFixedDimensionName, mIsInDefineMode, mUnlimitedDimensionName, DataWriterVariable::mVariableName, mVariables, and DataWriterVariable::mVariableUnits.

void ColumnDataWriter::DoAdvanceAlongUnlimitedDimension ( ) [protected]

Advance along the unlimited dimension. Normally this will be called when all variables in a row have been input.

Definition at line 353 of file ColumnDataWriter.cpp.

References CreateFixedDimensionFile(), FILE_SUFFIX_WIDTH, mBaseName, mHasPutVariable, mIsFixedDimensionSet, mIsUnlimitedDimensionSet, mNeedAdvanceAlongUnlimitedDimension, mpCurrentOutputFile, mRowStartPosition, mRowWidth, and mUnlimitedDimensionPosition.

Referenced by ParallelColumnDataWriter::AdvanceAlongUnlimitedDimension(), and PutVariable().

void ColumnDataWriter::EndDefineMode ( ) [virtual]

End the define mode of the DataWriter.

Implements AbstractDataWriter.

Reimplemented in ParallelColumnDataWriter.

Definition at line 223 of file ColumnDataWriter.cpp.

References CreateFixedDimensionFile(), CreateInfoFile(), FILE_SUFFIX_WIDTH, mAncillaryRowStartPosition, mAncillaryRowWidth, mBaseName, mFieldWidth, mIsFixedDimensionSet, mIsInDefineMode, mIsUnlimitedDimensionSet, mOutputFileHandler, mpCurrentAncillaryFile, mpCurrentOutputFile, mpFixedDimensionVariable, mPrecision, mpUnlimitedDimensionVariable, mRowStartPosition, mRowWidth, mUnlimitedDimensionPosition, DataWriterVariable::mVariableName, mVariables, DataWriterVariable::mVariableUnits, OutputFileHandler::OpenOutputFile(), and SPACING.

std::string ColumnDataWriter::GetOutputDirectory ( )

Return the full pathname of the directory where we're writing files.

Definition at line 89 of file ColumnDataWriter.cpp.

References OutputFileHandler::GetOutputDirectoryFullPath(), and mOutputFileHandler.

void ColumnDataWriter::PutVariable	(	int	variableID,
		double	variableValue,
		long	dimensionPosition = `-1`
	)			`[virtual]`

Input the variable value to the output file or ancillary file.

Parameters:

	variableID
	variableValue
	dimensionPosition	The position in column (defaults to -1). This is required if there is a fixed dimension, and will be the position along that dimension

Implements AbstractDataWriter.

Reimplemented in ParallelColumnDataWriter.

Definition at line 395 of file ColumnDataWriter.cpp.

References DoAdvanceAlongUnlimitedDimension(), FIXED_DIMENSION_VAR_ID, mFieldWidth, mFixedDimensionSize, mHasPutVariable, mIsFixedDimensionSet, mIsInDefineMode, mIsUnlimitedDimensionSet, mNeedAdvanceAlongUnlimitedDimension, mpCurrentAncillaryFile, mpCurrentOutputFile, mpFixedDimensionVariable, mpUnlimitedDimensionVariable, mRowStartPosition, mRowWidth, mVariables, SPACING, and UNLIMITED_DIMENSION_VAR_ID.