Inheritance diagram for AbstractDataWriter:

Public Member Functions
virtual int	DefineFixedDimension (const std::string &rDimensionName, const std::string &rDimensionUnits, long dimensionSize)=0
virtual int	DefineUnlimitedDimension (const std::string &rDimensionName, const std::string &rDimensionUnits)=0
virtual int	DefineVariable (const std::string &rVariableName, const std::string &rVariableUnits)=0
virtual void	EndDefineMode ()=0
virtual void	AdvanceAlongUnlimitedDimension ()=0
virtual void	PutVariable (int variableID, double variableValue, long dimensionPosition=-1)=0
virtual void	Close ()=0
virtual	~AbstractDataWriter ()

Detailed Description

An abstract base class for data output. Loosely based on NetCDF api.

Definition at line 45 of file AbstractDataWriter.hpp.

Constructor & Destructor Documentation

virtual AbstractDataWriter::~AbstractDataWriter ( ) [inline, virtual]

Base class with virtual methods needs a virtual destructor.

Definition at line 119 of file AbstractDataWriter.hpp.

virtual void AbstractDataWriter::AdvanceAlongUnlimitedDimension ( ) [pure virtual]

Dummy function for DoAdvanceAlongUnlimitedDimension. This method must be overridden in concrete classes.

virtual void AbstractDataWriter::Close ( ) [pure virtual]

Close any open files. This method must be overridden in concrete classes.

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

Define the fixed dimension. This method must be overridden in concrete classes.

Parameters:

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

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

Define the unlimited dimension, i.e. the dimension that increases as the simulation progresses. This method must be overridden in concrete classes.

Parameters:

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

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

Define a variable. This method must be overridden in concrete classes.

Parameters:

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

virtual void AbstractDataWriter::EndDefineMode ( ) [pure virtual]

End the define mode of the DataWriter. This method must be overridden in concrete classes.

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

Input the variable value to the output file or ancillary file This method must be overridden in concrete classes.

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

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