suanPan
Recorder Class Referenceabstract

A Recorder class. More...

#include <Recorder.h>

Inheritance diagram for Recorder:
Collaboration diagram for Recorder:

Public Member Functions

 Recorder (unsigned, uvec &&, OutputType, unsigned, bool, bool)
 ctor More...
 
 Recorder (const Recorder &)=delete
 
 Recorder (Recorder &&)=delete
 
Recorderoperator= (const Recorder &)=delete
 
Recorderoperator= (Recorder &&)=delete
 
 ~Recorder () override=default
 
virtual void initialize (const shared_ptr< DomainBase > &)
 
void set_object_tag (uvec &&)
 
const uvec & get_object_tag () const
 
void set_variable_type (OutputType)
 
const OutputTypeget_variable_type () const
 
bool if_hdf5 () const
 
bool if_record_time () const
 
void insert (double)
 
void insert (const std::vector< vec > &, unsigned)
 
const std::vector< std::vector< std::vector< vec > > > & get_data_pool () const
 
const std::vector< double > & get_time_pool () const
 
virtual void record (const shared_ptr< DomainBase > &)=0
 
void clear_status ()
 
virtual void save ()
 
void print () override
 
- Public Member Functions inherited from Tag
 Tag (unsigned=0)
 
 Tag (const Tag &)=default
 
 Tag (Tag &&)=default
 
Tagoperator= (const Tag &)=delete
 
Tagoperator= (Tag &&)=delete
 
virtual ~Tag ()=default
 
void set_tag (unsigned) const
 
unsigned get_tag () const
 
void enable ()
 
void disable ()
 
void guard ()
 
void unguard ()
 
bool is_active () const
 
bool is_guarded () const
 
virtual void print ()
 

Protected Member Functions

bool if_perform_record ()
 

Protected Attributes

const unsigned interval
 
unsigned counter = 0
 

Detailed Description

A Recorder class.

Author
tlc
Date
27/07/2017
Version
0.1.0

Constructor & Destructor Documentation

◆ Recorder() [1/3]

Recorder::Recorder ( unsigned  T,
uvec &&  B,
OutputType  L,
unsigned  I,
bool  R,
bool  H 
)

ctor

Parameters
Tunique tag
Bobject tags
Lvariable type
Irecord interval
Rif to record time stamp
Hif to use hdf5 format

◆ Recorder() [2/3]

Recorder::Recorder ( const Recorder )
delete

◆ Recorder() [3/3]

Recorder::Recorder ( Recorder &&  )
delete

◆ ~Recorder()

Recorder::~Recorder ( )
overridedefault

Member Function Documentation

◆ clear_status()

void Recorder::clear_status ( )

◆ get_data_pool()

const std::vector< std::vector< std::vector< vec > > > & Recorder::get_data_pool ( ) const
Here is the caller graph for this function:

◆ get_object_tag()

const uvec & Recorder::get_object_tag ( ) const
Here is the caller graph for this function:

◆ get_time_pool()

const std::vector< double > & Recorder::get_time_pool ( ) const

◆ get_variable_type()

const OutputType & Recorder::get_variable_type ( ) const
Here is the caller graph for this function:

◆ if_hdf5()

bool Recorder::if_hdf5 ( ) const
Here is the caller graph for this function:

◆ if_perform_record()

bool Recorder::if_perform_record ( )
protected
Here is the caller graph for this function:

◆ if_record_time()

bool Recorder::if_record_time ( ) const
Here is the caller graph for this function:

◆ initialize()

void Recorder::initialize ( const shared_ptr< DomainBase > &  )
virtual

◆ insert() [1/2]

void Recorder::insert ( const std::vector< vec > &  D,
unsigned  I 
)

◆ insert() [2/2]

void Recorder::insert ( double  T)
Here is the caller graph for this function:

◆ operator=() [1/2]

Recorder & Recorder::operator= ( const Recorder )
delete

◆ operator=() [2/2]

Recorder & Recorder::operator= ( Recorder &&  )
delete

◆ print()

void Recorder::print ( )
overridevirtual

Reimplemented from Tag.

Reimplemented in SumRecorder, and VisualisationRecorder.

◆ record()

virtual void Recorder::record ( const shared_ptr< DomainBase > &  )
pure virtual

◆ save()

void Recorder::save ( )
virtual

Reimplemented in EigenRecorder, FrameRecorder, and VisualisationRecorder.

Here is the call graph for this function:

◆ set_object_tag()

void Recorder::set_object_tag ( uvec &&  T)
Here is the caller graph for this function:

◆ set_variable_type()

void Recorder::set_variable_type ( OutputType  T)

Member Data Documentation

◆ counter

unsigned Recorder::counter = 0
protected

◆ interval

const unsigned Recorder::interval
protected

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