dawn::IODataCmn Struct Reference

Base interface for I/O data buffers (static and dynamic). More...

#include <idata.hxx>

Public Member Functions
virtual	~io_data_cmn_t ()
	Virtual destructor for polymorphic cleanup.
virtual void *	getDataPtr (size_t batch=0)=0
	Get pointer to data only (skips timestamp if present).
virtual size_t	getDataSize ()=0
	Get data size in bytes.
virtual size_t	getItems ()=0
	Get number of items per batch.
virtual void *	getPtr (size_t batch=0)=0
	Get pointer to batch.
virtual uint64_t &	getTs (size_t batch=0)=0
	Get timestamp reference for batch.
virtual bool	hasTimestamp ()=0
	Check if this data buffer has per-batch timestamp storage.

Detailed Description

Base interface for I/O data buffers (static and dynamic).

Definition at line 20 of file idata.hxx.

Member Function Documentation

getDataPtr()

virtual void * dawn::IODataCmn::getDataPtr ( size_t  batch = 0 )

pure virtual

Get pointer to data only (skips timestamp if present).

Parameters

batch

Batch index (default 0).

Returns

Void pointer to data.

Here is the caller graph for this function:

getDataSize()

virtual size_t dawn::IODataCmn::getDataSize ( )

pure virtual

Get data size in bytes.

Returns the size of a single data item (without timestamp if present).

Here is the caller graph for this function:

getPtr()

virtual void * dawn::IODataCmn::getPtr ( size_t  batch = 0 )

pure virtual

Get pointer to batch.

When timestamp is enabled, returns pointer to [timestamp + data]. When timestamp is disabled, returns pointer to [data] (same as getDataPtr).

Parameters

batch

Batch index (default 0).

Returns

Void pointer to batch.

getTs()

virtual uint64_t & dawn::IODataCmn::getTs ( size_t  batch = 0 )

pure virtual

Get timestamp reference for batch.

When hasTimestamp() is true, returns a per-batch timestamp reference. When hasTimestamp() is false, returns a shared dummy reference (writes are silently discarded on next call).

Parameters

batch

Batch index (default 0).

Returns

Reference to timestamp.

Here is the caller graph for this function:

hasTimestamp()

virtual bool dawn::IODataCmn::hasTimestamp ( )

pure virtual

Check if this data buffer has per-batch timestamp storage.

Returns

True if timestamps are stored per-batch.

---

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

• dawn/include/dawn/io/idata.hxx