An abstract class for performing buffered history output. More...

Inheritance diagram for geosx::BufferedHistoryIO:

Public Member Functions
	BufferedHistoryIO ()
	Constructor.

virtual	~BufferedHistoryIO ()
	Destructor.

buffer_unit_type *	getBufferHead ()
	Get the head of the internal history storage buffer. More...

virtual void	init (bool existsOkay)=0
	Perform and intialization needed for time-history output. More...

virtual void	write ()=0
	Write the buffered history data to the output target.

virtual void	compressInFile ()=0
	Ensure the repressentation of the data in the output target is dense and terse. More...

localIndex	getBufferedCount ()
	Query the number of history states currently stored in the internal buffer. More...

Protected Member Functions
virtual void	resizeBuffer ()=0
	Resize the buffer to accomodate additional history collection.

void	emptyBuffer ()
	Empty the history collection buffer.

Protected Attributes
localIndex	m_bufferedCount
	The current number of records in the buffer.

buffer_unit_type *	m_bufferHead
	The write head of the buffer.

buffer_type	m_dataBuffer
	The data buffer containing the history info.

Detailed Description

An abstract class for performing buffered history output.

Definition at line 32 of file HistoryIO.hpp.

Member Function Documentation

virtual void geosx::BufferedHistoryIO::compressInFile ( )

pure virtual

Ensure the repressentation of the data in the output target is dense and terse.

Note: Typically the file will be oversized to receive data writes without constant resizing.

localIndex geosx::BufferedHistoryIO::getBufferedCount ( )

inline

Query the number of history states currently stored in the internal buffer.

Returns: The number of discrete time history records buffered to be written.

Definition at line 82 of file HistoryIO.hpp.

buffer_unit_type* geosx::BufferedHistoryIO::getBufferHead ( )

inline

Get the head of the internal history storage buffer.

Note: Depends on the virtual function resizeBuffer() being implemented correctly in an inheriting class.

Definition at line 52 of file HistoryIO.hpp.

virtual void geosx::BufferedHistoryIO::init ( bool existsOkay )

pure virtual

Perform and intialization needed for time-history output.

Parameters

existsOkay Whether it is acceptable for the intended output target to already exist ( false on start from scratch, true on restart ). data).

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