xc
Public Types | Public Member Functions | Protected Member Functions | List of all members
XC::RecorderContainer Class Referenceabstract

Object that can manage Recorders. More...

#include <RecorderContainer.h>

Inheritance diagram for XC::RecorderContainer:
Inheritance graph
[legend]

Public Types

typedef std::list< Recorder * > lista_recorders
 
typedef lista_recorders::iterator recorder_iterator
 
typedef lista_recorders::const_iterator const_recorder_iterator
 

Public Member Functions

 RecorderContainer (DataOutputHandler::map_output_handlers *oh=nullptr)
 
virtual ~RecorderContainer (void)
 Destructor.
 
RecordernewRecorder (const std::string &, DataOutputHandler *oh=nullptr)
 Read a Recorder object from file.
 
virtual int addRecorder (Recorder &theRecorder)
 Adds a recorder. More...
 
recorder_iterator recorder_begin (void)
 
const_recorder_iterator recorder_begin (void) const
 
recorder_iterator recorder_end (void)
 
const_recorder_iterator recorder_end (void) const
 
virtual int record (int track, double timeStamp=0.0)
 To invoke {record(cTag, timeStamp)} on any Recorder objects which have been added. More...
 
void restart (void)
 To invoke {restart()} on any Recorder objects which have been added. More...
 
virtual int removeRecorders (void)
 Remove the recorders.
 
void setLinks (Domain *dom)
 Asigna el domain a los recorders.
 
void SetOutputHandlers (DataOutputHandler::map_output_handlers *oh)
 Set the outputhandlers container.
 

Protected Member Functions

int sendData (Communicator &comm)
 
int recvData (const Communicator &comm)
 
size_t getNumRecorders (void) const
 Returns the number of recorders already defined.
 
virtual Domainget_domain_ptr (void)=0
 

Detailed Description

Object that can manage Recorders.

Member Function Documentation

◆ addRecorder()

int XC::RecorderContainer::addRecorder ( Recorder theRecorder)
virtual

Adds a recorder.

To add a recorder object theRecorder to the SolutionAlgorithm. returns \(0\).

Reimplemented in XC::Domain, XC::ShadowSubdomain, and XC::PartitionedDomain.

◆ record()

int XC::RecorderContainer::record ( int  cTag,
double  timeStamp = 0.0 
)
virtual

To invoke {record(cTag, timeStamp)} on any Recorder objects which have been added.

◆ restart()

void XC::RecorderContainer::restart ( void  )

To invoke {restart()} on any Recorder objects which have been added.


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