Stores the data corresponding to the envelope of a magnitude. More...

#include <EnvelopeData.h>

Inheritance diagram for XC::EnvelopeData:

Collaboration diagram for XC::EnvelopeData:

Public Member Functions
	EnvelopeData (void)
	Constructor.

	~EnvelopeData (void)
	Destructor.

const Matrix *	getData (void) const

Matrix *	getData (void)

const Vector *	getCurrentData (void) const

Vector *	getCurrentData (void)

const bool &	First (void) const

bool &	First (void)

int	restart (void)

int	sendSelf (Communicator &)
	Send the object. More...

int	recvSelf (const Communicator &)
	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 (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 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.

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...

Friends
class	EnvelopeElementRecorder

class	EnvelopeNodeRecorder

Detailed Description

Stores the data corresponding to the envelope of a magnitude.

Member Function Documentation

◆ receiveData()

int XC::EnvelopeData::receiveData ( const Communicator & comm )

protected

Receive the object through the communicator being passed as parameter.

◆ recvSelf()

int XC::EnvelopeData::recvSelf ( const Communicator & comm )

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.

◆ sendData()

int XC::EnvelopeData::sendData ( Communicator & comm )

protected

Send the object through the communicator being passed as parameter.

◆ sendSelf()

int XC::EnvelopeData::sendSelf ( Communicator & comm )

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.

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

src/utility/recorder/EnvelopeData.h
src/utility/recorder/EnvelopeData.cc

Public Member Functions