geos::BufferedHistoryIO Class Reference

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

#include <BufferedHistoryIO.hpp>

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...
int	getLogLevel () const
	Get the log-level for BufferedHistoryIO classes. More...
void	setLogLevel (int logLevel)
	Set the log-level for BufferedHistoryIO classes. More...

Detailed Description

An abstract class for performing buffered history output.

Definition at line 28 of file BufferedHistoryIO.hpp.

Member Function Documentation

compressInFile()

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.

Implemented in geos::HDFHistoryIO.

getBufferedCount()

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.

Implemented in geos::HDFHistoryIO.

getBufferHead()

virtual buffer_unit_type* geos::BufferedHistoryIO::getBufferHead ( )

pure virtual

Get the head of the internal history storage buffer.

Returns

The head of the internal history storage buffer to be written to.

Implemented in geos::HDFHistoryIO.

getLogLevel()

int geos::BufferedHistoryIO::getLogLevel ( ) const

inline

Get the log-level for BufferedHistoryIO classes.

Returns

the current log-level

Definition at line 81 of file BufferedHistoryIO.hpp.

init()

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

pure virtual

Perform and intialization needed for time-history output.

Parameters

[in]

existsOkay

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

Implemented in geos::HDFHistoryIO.

setLogLevel()

void geos::BufferedHistoryIO::setLogLevel ( int  logLevel )

inline

Set the log-level for BufferedHistoryIO classes.

Parameters

[in]

logLevel

the log-level to set

Definition at line 87 of file BufferedHistoryIO.hpp.

updateCollectingCount()

virtual void geos::BufferedHistoryIO::updateCollectingCount ( localIndex  count )

pure virtual

Update the number of items being stored for IO in this object.

Parameters

count

[in] The new number of items being collected

Implemented in geos::HDFHistoryIO.

---

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

• coreComponents/fileIO/timeHistory/BufferedHistoryIO.hpp