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

Inheritance diagram for geos::BufferedHistoryIO:

Public Member Functions
virtual	~BufferedHistoryIO ()
	Destructor.

virtual buffer_unit_type *	getBufferHead ()=0
	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...

virtual void	updateCollectingCount (localIndex count)=0
	Update the number of items being stored for IO in this object. More...

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

Detailed Description

An abstract class for performing buffered history output.

Definition at line 27 of file BufferedHistoryIO.hpp.

Member Function Documentation

virtual void geos::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.

virtual localIndex geos::BufferedHistoryIO::getBufferedCount ( )

pure virtual

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

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

Note: Since the size of each discrete time history can change, this should not be used to calculate size, but is useful to check for consistency between collectors that should be operating at the same cadence (ie the time collector and the data collector).

Deprecated:: Also, note that this member function is related to restarting HDF5 files. Which means that getting this information popping through the abstract interface is a shortcut that should eventually be fixed by keeping this information in the HDF5 buffer.