An Recorder object is used in the program to store/restore information at each commit(). More...
#include <Recorder.h>
Public Member Functions | |
| Recorder (int classTag) | |
| virtual int | record (int commitTag, double timeStamp)=0 |
| Invoked by the Domain object after commit() has been invoked on all the domain component objects. More... | |
| virtual int | playback (int commitTag) |
| //! Invoked by the analyst after the analysis has been performed. More... | |
| virtual int | restart (void) |
| Invoked by the Domain object when revertToStart() is invoked on the Domain object. More... | |
| virtual int | setDomain (Domain &theDomain) |
| virtual int | sendSelf (CommParameters &) |
| Send the object. More... | |
| virtual int | recvSelf (const CommParameters &) |
| Receive the object. More... | |
 Public Member Functions inherited from XC::MovableObject | |
| MovableObject (int classTag, int dbTag) | |
| Constructor. More... | |
| MovableObject (int classTag) | |
| Constructor. More... | |
| MovableObject (const MovableObject &) | |
| Copy constructor. Doesn't copy the dbTag. | |
| MovableObject & | operator= (const MovableObject &) |
| Assignment operator. Doesn't copy the dbTag. | |
| int | getClassTag (void) const |
| Return the class identifier. | |
| int | getDbTag (void) const |
| Return the object identifier in the database. | |
| int | getDbTag (CommParameters &) |
| Return the object identifier in the database. | |
| void | setDbTag (int dbTag) |
| Sets the object identifier in the database. | |
| void | setDbTag (CommParameters &) |
| Sets the object identifier in the database if not already set. More... | |
| virtual int | setParameter (const std::vector< std::string > &argv, Parameter ¶m) |
Sets the value param to the parameter argv. | |
| virtual int | updateParameter (int parameterID, Information &info) |
Updates the parameter identified by parameterID with info. | |
| virtual int | activateParameter (int parameterID) |
Activates the parameter identified by parameterID. | |
| virtual int | setVariable (const std::string &variable, Information &) |
Set the value of the variable idenfified by var. | |
| virtual int | getVariable (const std::string &variable, Information &) |
Return the value of the variable idenfified by var. | |
| Public Member Functions inherited from XC::DistributedBase | |
| DistributedBase (void) | |
| Constructor. | |
| virtual DbTagData & | getDbTagData (void) const |
| Returns a vector to store class dbTags. | |
| const int & | getDbTagDataPos (const int &i) const |
| Returns the data at the i-th position. | |
| void | setDbTagDataPos (const int &i, const int &v) |
| Sets the data at the i-th position. | |
| void | inicComm (const int &dataSize) const |
| Initializes communication. | |
Detailed Description
An Recorder object is used in the program to store/restore information at each commit().
The Recorder class is an abstract class which is introduced to allow information to be saved during the analysis. The interface defines two pure virtual methods record()} and {playback(). {record()} is a method which is called by the Domain object during a commit()}. The {playback() method can be called by the analyst after the analysis has been performed.
Member Function Documentation
§ playback()
|
virtual |
//! Invoked by the analyst after the analysis has been performed.
What the method does depends on the concrete subtype.
Reimplemented in XC::DamageRecorder, XC::FilePlotter, XC::GSA_Recorder, XC::AlgorithmIncrements, XC::DatastoreRecorder, XC::MaxNodeDispRecorder, XC::PatternRecorder, and XC::YsVisual.
§ record()
|
pure virtual |
Invoked by the Domain object after commit() has been invoked on all the domain component objects.
What the Recorder records depends on the concrete subtype.
Implemented in XC::DriftRecorder, XC::DamageRecorder, XC::FilePlotter, XC::GSA_Recorder, XC::NodeRecorder, XC::AlgorithmIncrements, XC::EnvelopeNodeRecorder, XC::EnvelopeElementRecorder, XC::DatastoreRecorder, XC::ElementRecorder, XC::MaxNodeDispRecorder, XC::PatternRecorder, XC::YsVisual, XC::ElementPropRecorder, and XC::NodePropRecorder.
§ recvSelf()
|
virtual |
Receive the object.
Each object has to receive the data needed to be able to recreate itself in the new process after it has been sent through cp. If the object is an aggregation containing other objects, new objects of the correct type can be constructed using #theBroker. To return 0 if successful or a -1 if not.
Implements XC::MovableObject.
Reimplemented in XC::DriftRecorder, XC::NodeRecorder, XC::EnvelopeNodeRecorder, XC::EnvelopeElementRecorder, XC::ElementRecorder, and XC::ElementRecorderBase.
§ restart()
|
virtual |
Invoked by the Domain object when revertToStart() is invoked on the Domain object.
What the Recorder does depends on the concrete subtype.
Reimplemented in XC::DriftRecorder, XC::DamageRecorder, XC::FilePlotter, XC::GSA_Recorder, XC::AlgorithmIncrements, XC::EnvelopeNodeRecorder, XC::DatastoreRecorder, XC::EnvelopeElementRecorder, XC::ElementRecorder, XC::MaxNodeDispRecorder, XC::PatternRecorder, XC::YsVisual, XC::ElementPropRecorder, and XC::NodePropRecorder.
§ sendSelf()
|
virtual |
Send the object.
Each object has to send the data needed to be able to reproduce that object in a remote process. The object uses the methods provided by cp object to send the data to another channel at the remote actor, the address of the channel is set before this method is called. An object of similar type at the remote actor is invoked with a receiveSelf() to receive the data. Returns 0 if successful (successful in that the data got to the channel), or a - if no data was sent.
Implements XC::MovableObject.
Reimplemented in XC::DriftRecorder, XC::NodeRecorder, XC::EnvelopeNodeRecorder, XC::EnvelopeElementRecorder, XC::ElementRecorder, and XC::ElementRecorderBase.
The documentation for this class was generated from the following files:
- src/utility/recorder/Recorder.h
- src/utility/recorder/Recorder.cpp
