xc
Public Member Functions | Protected Member Functions | List of all members
XC::NodeRecorder Class Reference

Recording of specified nodal DOF responses for the specified nodes. More...

#include <NodeRecorder.h>

Inheritance diagram for XC::NodeRecorder:
Inheritance graph
[legend]
Collaboration diagram for XC::NodeRecorder:
Collaboration graph
[legend]

Public Member Functions

 NodeRecorder (const ID &theDof, const ID &theNodes, int sensitivity, const std::string &dataToStore, Domain &theDomain, DataOutputHandler &theOutputHandler, double deltaT=0.0, bool echoTimeFlag=true)
 
void setupDataFlag (const std::string &dataToStore)
 set the data flag used as a switch to get the response in a record
 
int record (int commitTag, double timeStamp)
 Invoked by the Domain object after commit() has been invoked on all the domain component objects. More...
 
int sendSelf (Communicator &)
 Send the object through the communicator being passed as parameter. More...
 
int recvSelf (const Communicator &)
 Receive the object through the communicator being passed as parameter. More...
 
- Public Member Functions inherited from XC::NodeRecorderBase
 NodeRecorderBase (int classTag)
 
 NodeRecorderBase (int classTag, const ID &theDof, const ID &theNodes, Domain &theDomain, DataOutputHandler &theOutputHandler, double deltaT=0.0, bool echoTimeFlag=true)
 
- Public Member Functions inherited from XC::MeshCompRecorder
 MeshCompRecorder (int classTag)
 
 MeshCompRecorder (int classTag, Domain &theDomain, DataOutputHandler &theOutputHandler, double deltaT=0.0, bool echoTimeFlag=true)
 
- Public Member Functions inherited from XC::HandlerRecorder
 HandlerRecorder (int classTag)
 
 HandlerRecorder (int classTag, Domain &theDomain, DataOutputHandler &theOutputHandler, bool timeFlag)
 
void SetOutputHandler (DataOutputHandler *tH)
 Sets de data output handler.
 
- 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 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...
 
- 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 (Communicator &)
 Return the object identifier in the database.
 
void setDbTag (int dbTag)
 Sets the object identifier in the database.
 
void setDbTag (Communicator &)
 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 ~DistributedBase (void)
 Destructor.
 
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.
 
- Public Member Functions inherited from CommandEntity
 CommandEntity (CommandEntity *owr=nullptr)
 Default constructor.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (void)
 Return the regular output stream wrapper.
 
const std::string & getLogFileName (void) const
 Returns log file name.
 
void setLogFileName (const std::string &)
 Sets log file name.
 
const std::string & getErrFileName (void) const
 Returns err file name.
 
void setErrFileName (const std::string &)
 Sets error file name.
 
const std::string & getOutputFileName (void) const
 Returns regular output file name.
 
void setOutputFileName (const std::string &)
 Sets regular output file name.
 
boost::python::object evalPy (boost::python::object dict, const std::string &)
 Return the Python object that results from evaluating the argument.
 
boost::python::object execPy (boost::python::object dict, const std::string &)
 Return the Python objects that results from executing the code in the string argument.
 
boost::python::object execFilePy (boost::python::object dict, const std::string &)
 Return the Python object that results from executing the code in the file.
 
- Public Member Functions inherited from EntityWithProperties
 EntityWithProperties (EntityWithProperties *owr=nullptr)
 Default constructor.
 
virtual bool operator== (const EntityWithProperties &) const
 Comparison operator.
 
void clearPyProps (void)
 Clear python properties map.
 
bool hasPyProp (const std::string &)
 Returns true if property exists.
 
boost::python::object getPyProp (const std::string &str)
 Return the Python object with the name being passed as parameter.
 
void setPyProp (std::string str, boost::python::object val)
 Sets/appends a value tho the Python object's dictionary.
 
void copyPropsFrom (const EntityWithProperties &)
 Copy the properties from the argument.
 
boost::python::list getPropNames (void) const
 Return the names of the object properties weightings.
 
const PythonDict & getPropertiesDict (void) const
 Return a std::map container with the properties of the object.
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary containing the object members values.
 
void setPyDict (const boost::python::dict &)
 Set the values of the object members from a Python dictionary.
 
- Public Member Functions inherited from EntityWithOwner
 EntityWithOwner (EntityWithOwner *owr=nullptr)
 Default constructor.
 
 EntityWithOwner (const EntityWithOwner &)
 Copy constructor.
 
EntityWithOwneroperator= (const EntityWithOwner &)
 Assignment operator.
 
virtual bool operator== (const EntityWithOwner &) const
 Comparison operator.
 
virtual ~EntityWithOwner (void)
 Virtual destructor.
 
virtual std::string getClassName (void) const
 Returns demangled class name.
 
void set_owner (EntityWithOwner *owr)
 Assigns the owner of the object.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 

Protected Member Functions

int sendData (Communicator &)
 Send the object through the communicator being passed as parameter. More...
 
int receiveData (const Communicator &)
 Receive the object through the communicator being passed as parameter. More...
 
- Protected Member Functions inherited from XC::NodeRecorderBase
int sendData (Communicator &)
 Send the object through the communicator being passed as parameter. More...
 
int receiveData (const Communicator &)
 Receive the object through the communicator being passed as parameter. More...
 
- Protected Member Functions inherited from XC::MeshCompRecorder
int sendData (Communicator &)
 Send the object mediante el communicator being passed as parameter. More...
 
int receiveData (const Communicator &)
 Receives object through the communicator being passed as parameter.
 
- Protected Member Functions inherited from XC::HandlerRecorder
int sendData (Communicator &)
 Sends object through the communicator being passed as parameter.
 
int receiveData (const Communicator &)
 Receives object through the communicator being passed as parameter.
 
- Protected Member Functions inherited from CommandEntity
template<class T >
void string_to (T &, const std::string &) const
 

Additional Inherited Members

- Public Types inherited from EntityWithProperties
typedef std::map< std::string, boost::python::object > PythonDict
 
- Static Public Member Functions inherited from CommandEntity
static void resetStandardOutput (void)
 Reset the standard output streams to its defaults buffers.
 
- Static Public Member Functions inherited from EntityWithOwner
static int getVerbosityLevel (void)
 Get the value of the verbosity level.
 
static void setVerbosityLevel (const int &)
 Set the value of the verbosity level.
 
- Static Protected Member Functions inherited from CommandEntity
static CommandEntityentcmd_cast (boost::any &data)
 
- Protected Attributes inherited from XC::NodeRecorderBase
IDtheDofs
 DOFs identifiers.
 
IDtheNodalTags
 ??
 
std::vector< Node * > theNodes
 Pointer to nodes.
 
int dataFlag
 flag indicating what it is to be stored in recorder.
 
int numValidNodes
 
- Protected Attributes inherited from XC::MeshCompRecorder
double deltaT
 
double nextTimeStampToRecord
 
- Protected Attributes inherited from XC::HandlerRecorder
DataOutputHandlertheHandler
 Output handler (TO DEPRECATE).
 
bool initializationDone
 
bool echoTimeFlag
 
- Protected Attributes inherited from XC::DomainRecorderBase
DomaintheDomain
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

Recording of specified nodal DOF responses for the specified nodes.

Member Function Documentation

◆ receiveData()

int XC::NodeRecorder::receiveData ( const Communicator comm)
protected

Receive the object through the communicator being passed as parameter.

◆ record()

int XC::NodeRecorder::record ( int  commitTag,
double  timeStamp 
)
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.

Implements XC::Recorder.

◆ recvSelf()

int XC::NodeRecorder::recvSelf ( const Communicator comm)
virtual

Receive the object through the communicator being passed as parameter.

Reimplemented from XC::Recorder.

◆ sendData()

int XC::NodeRecorder::sendData ( Communicator comm)
protected

Send the object through the communicator being passed as parameter.

◆ sendSelf()

int XC::NodeRecorder::sendSelf ( Communicator comm)
virtual

Send the object through the communicator being passed as parameter.

Reimplemented from XC::Recorder.


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