xc
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
XC::PropRecorder Class Reference
Inheritance diagram for XC::PropRecorder:
XC::DomainRecorderBase XC::Recorder XC::MovableObject XC::DistributedBase XC::ElementPropRecorder XC::NodePropRecorder

Public Member Functions

 PropRecorder (int classTag, Domain *ptr_dom=nullptr)
 Constructor.
 
std::string getCurrentCombinationName (void) const
 Returns the name of the current combination.
 
int getLastCommitTag (void) const
 
double getLastTimeStamp (void) const
 
double getCurrentTime (void) const
 
double getCommittedTime (void) const
 
int getCommitTag (void) const
 
void setCallbackSetup (const std::string &)
 
std::string getCallbackSetup (void)
 
void setCallbackRecord (const std::string &)
 
std::string getCallbackRecord (void)
 
void setCallbackRestart (const std::string &)
 
std::string getCallbackRestart (void)
 
- Public Member Functions inherited from XC::DomainRecorderBase
 DomainRecorderBase (int classTag, Domain *ptr_dom=nullptr)
 Constructor. More...
 
int setDomain (Domain &theDomain)
 Set the link with the domain.
 
DomaingetDomain (void)
 
- Public Member Functions inherited from XC::Recorder
 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 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.
 
MovableObjectoperator= (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 &param)
 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 DbTagDatagetDbTagData (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.
 

Protected Member Functions

void callSetupCallback (const int &, const double &)
 Runs setup callback.
 
template<class Container >
void callRecordCallback (Container &c, const int &, const double &)
 Calls record callback on each container element.
 
template<class Container >
void callRestartCallback (Container &c)
 Calls restart callback on each container element.
 

Protected Attributes

std::string CallbackSetup
 Python script to execute before any record calls.
 
std::string CallbackRecord
 Python script to execute on each record call.
 
std::string CallbackRestart
 Python script to execute on each restart call.
 
int lastCommitTag
 CommitTag of the last record call.
 
double lastTimeStamp
 TimeStamp of the last record call.
 
- Protected Attributes inherited from XC::DomainRecorderBase
DomaintheDomain
 

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