RecordableBase Class Reference

Inheritance diagram for RecordableBase:

Public Member Functions
virtual int	getNumElements () const =0
	Get the number of elements that needs to be recorded.
virtual variantTypes	getElement (int index) const =0
virtual void	startNewEpoch ()=0
virtual void	setDataType ()=0
	Set up a string representing the basic data type.
virtual const string &	getDataType () const =0
template<class Archive >
void	serialize (Archive &archive)
	Cereal serialization method.

Protected Member Functions
	RecordableBase ()=default
	prevents any code outside this class from creating a RecordableBase object

Protected Attributes
std::string	basicDataType_
	the basic data type in the recorded variable

Detailed Description

Definition at line 29 of file RecordableBase.h.

Member Function Documentation

getDataType()

virtual const string & RecordableBase::getDataType ( ) const

pure virtual

Get A string representing the data type of the recordable variable Dynamic or runtime type information of basic data type

Implemented in CompleteMatrix, EventBuffer, RecordableVector< T >, RecordableVector< BGFLOAT >, RecordableVector< uint64_t >, and VectorMatrix.

getElement()

virtual variantTypes RecordableBase::getElement ( int index ) const

pure virtual

Get the value of the recordable variable at the specified index.

Parameters

index

The index of the recorded value to retrieve.

Returns

A variant representing the recorded value.

Implemented in CompleteMatrix, EventBuffer, RecordableVector< T >, RecordableVector< BGFLOAT >, RecordableVector< uint64_t >, and VectorMatrix.

getNumElements()

virtual int RecordableBase::getNumElements ( ) const

pure virtual

Get the number of elements that needs to be recorded.

Implemented in CompleteMatrix, EventBuffer, RecordableVector< T >, RecordableVector< BGFLOAT >, RecordableVector< uint64_t >, and VectorMatrix.

serialize()

template<class Archive >

void RecordableBase::serialize ( Archive & archive )

inline

Cereal serialization method.

Definition at line 53 of file RecordableBase.h.

setDataType()

virtual void RecordableBase::setDataType ( )

pure virtual

Set up a string representing the basic data type.

Implemented in CompleteMatrix, EventBuffer, RecordableVector< T >, RecordableVector< BGFLOAT >, RecordableVector< uint64_t >, and VectorMatrix.

startNewEpoch()

virtual void RecordableBase::startNewEpoch ( )

pure virtual

Start a new epoch for the recordable variable. Called at the beginning of each simulation epoch to prepare for recording new events.

Implemented in CompleteMatrix, EventBuffer, RecordableVector< T >, RecordableVector< BGFLOAT >, RecordableVector< uint64_t >, and VectorMatrix.

Member Data Documentation

basicDataType_

std::string RecordableBase::basicDataType_

protected

the basic data type in the recorded variable

Definition at line 62 of file RecordableBase.h.

---

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

• Simulator/Recorders/RecordableBase.h