The Sparta Modeling Framework
Loading...
Searching...
No Matches
Public Member Functions | List of all members
sparta::statistics::ArchiveDataSeries Class Reference

Wrapper around a leaf ArchiveNode's data. Owns a back pointer to the top RootArchiveNode in its tree, which it uses to synchronize the data source and data sink with every call to its data access APIs. More...

#include <ArchiveNode.hpp>

Public Member Functions

 ArchiveDataSeries (const size_t leaf_index, RootArchiveNode *root)
 
double getValueAt (const size_t idx)
 
const std::vector< double > & getDataReference ()
 Get the entire SI data array.
 
size_t size ()
 Get the size of the SI data array.
 
bool empty ()
 See if there are any SI data values at all.
 

Detailed Description

Wrapper around a leaf ArchiveNode's data. Owns a back pointer to the top RootArchiveNode in its tree, which it uses to synchronize the data source and data sink with every call to its data access APIs.

Definition at line 237 of file ArchiveNode.hpp.

Constructor & Destructor Documentation

◆ ArchiveDataSeries()

sparta::statistics::ArchiveDataSeries::ArchiveDataSeries ( const size_t  leaf_index,
RootArchiveNode *  root 
)
inline

Definition at line 240 of file ArchiveNode.hpp.

Member Function Documentation

◆ empty()

bool sparta::statistics::ArchiveDataSeries::empty ( )
inline

See if there are any SI data values at all.

Definition at line 268 of file ArchiveNode.hpp.

Here is the call graph for this function:

◆ getDataReference()

const std::vector< double > & sparta::statistics::ArchiveDataSeries::getDataReference ( )
inline

Get the entire SI data array.

Definition at line 256 of file ArchiveNode.hpp.

◆ getValueAt()

double sparta::statistics::ArchiveDataSeries::getValueAt ( const size_t  idx)
inline

Get just one SI value at the data series index. Throws if out of range.

Definition at line 250 of file ArchiveNode.hpp.

◆ size()

size_t sparta::statistics::ArchiveDataSeries::size ( )
inline

Get the size of the SI data array.

Definition at line 262 of file ArchiveNode.hpp.

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