Inheritance diagram for XC::NEESData:

Public Member Functions
	NEESData (const std::string &dataBase, Preprocessor &preprocessor, FEM_ObjectBroker &theBroker)

int	getDbTag (void) const
	To return a unique integer identifier at each call. More...

int	sendMsg (int dbTag, int commitTag, const Message &, ChannelAddress *theAddress=nullptr)
	A method invoked to send the data in the Message object `theMsg` to another Channel object. More...

int	recvMsg (int dbTag, int commitTag, Message &, ChannelAddress *theAddress=nullptr)
	Invoked to send the data in the Message object `theMsg` to another Channel object. More...

int	sendMatrix (int dbTag, int commitTag, const Matrix &, ChannelAddress *theAddress=nullptr)
	Invoked to receive the data in the Matrix object `theMatrix` to another Channel object. More...

int	recvMatrix (int dbTag, int commitTag, Matrix &, ChannelAddress *theAddress=nullptr)
	Invoked to receive the data in the Matrix object `theMatrix` to another Channel object. More...

int	sendVector (int dbTag, int commitTag, const Vector &, ChannelAddress *theAddress=nullptr)
	Invoked to receive the data in the Vector object `theVector` to another Channel object. More...

int	recvVector (int dbTag, int commitTag, Vector &, ChannelAddress *theAddress=nullptr)
	Invoked to receive the data in the Vector object `theVector` to another Channel object. More...

int	sendID (int dbTag, int commitTag, const ID &, ChannelAddress *theAddress=nullptr)
	Invoked to receive the data in the ID object `theID` to another Channel object. More...

int	recvID (int dbTag, int commitTag, ID &, ChannelAddress *theAddress=nullptr)
	Invoked to receive the data in the ID object `theID` to another Channel object. More...

int	createTable (const std::string &tableName, const std::vector< std::string > &columns)

int	insertData (const std::string &tableName, const std::vector< std::string > &columns, int commitTag, const Vector &data)

int	getData (const std::string &tableName, const std::vector< std::string > &columns, int commitTag, Vector &data)

int	commitState (int commitTag)
	Stores the current state on the database. More...

Public Member Functions inherited from XC::FE_Datastore
	FE_Datastore (Preprocessor &, FEM_ObjectBroker &theBroker)
	Constructor. More...

char *	addToProgram (void)
	Return \(nullptr\).

int	setUpConnection (void)

int	setNextAddress (const ChannelAddress &otherChannelAddress)
	Return \(0\).

ChannelAddress *	getLastSendersAddress (void)
	Return \(nullptr\).

int	sendObj (int commitTag, MovableObject &theObject, ChannelAddress *theAddress=0)
	Call {sendSelf(commitTag, this, theBroker)}* on `theObject` and return the result. More...

int	recvObj (int commitTag, MovableObject &theObject, FEM_ObjectBroker &theBroker, ChannelAddress *theAddress=0)
	Call {recvSelf(commitTag, this, theBroker)}* on `theObject` and return the result. More...

virtual bool	isDatastore (void) const
	Return true (this channel type IS a Datastore).

virtual int	restoreState (int commitTag)
	Invoked to restore the state of the domain from a database. More...

bool	isSaved (int commitTag) const
	Returns true if the state identified by commitTag was previously saved on the database. More...

int	save (const int &commitTag)

int	restore (const int &commitTag)

Public Member Functions inherited from XC::Channel
	Channel (CommandEntity *owr=nullptr)
	Constructor.

bool	checkDbTag (const int &dbTag)
	Check if a `dbTag` is already used.

const ID &	getUsedTags (void) const
	Return the list of dbTags already used.

void	clearDbTags (void)
	Reset used database tags set.

int	getTag (void) const
	Return the object tag.

template<class inputIterator >
int	sendObjs (int commitTag, const inputIterator &first, const inputIterator &last, ChannelAddress *theAddress=nullptr)
	Send the objects on interval [first,last).

template<class inputIterator >
int	recvObjs (int commitTag, const inputIterator &first, const inputIterator &last, FEM_ObjectBroker &, ChannelAddress *theAddress=nullptr)
	Receive an object sequence.

Additional Inherited Members
Protected Member Functions inherited from XC::FE_Datastore
FEM_ObjectBroker *	getObjectBroker (void)
	Returns a pointer to `theBroker` object passed in the constructor.

const Preprocessor *	getPreprocessor (void) const
	Returns a pointer to the object preprocessor.

Preprocessor *	getPreprocessor (void)
	Returns a pointer to the object preprocessor.

Protected Member Functions inherited from XC::Channel
int	sendMovable (int commitTag, MovableObject &)
	Send `theObject`.

int	receiveMovable (int commitTag, MovableObject &, FEM_ObjectBroker &)
	Receive `theObject`.

Constructor & Destructor Documentation

§ NEESData()

XC::NEESData::NEESData	(	const std::string &	dataBase,
		Preprocessor &	preprocessor,
		FEM_ObjectBroker &	theBroker
	)

Parameters

database	name
domain
object	broker

Author: fmk

Member Function Documentation

§ commitState()

int XC::NEESData::commitState ( int commitTag )

virtual

Stores the current state on the database.

Invoked to store the current state of the domain in the database. The integer commitTag is used to identify the state for subsequent calls to restore the information from the database. To return \(0\) if successful, a negative number if not.

The object loops over all the components of the Domain object invoking {sendSelf(commitTag, this)} on each of these objects. Returns \(0\) if successful, a negative number if not. For each domain component that could not send itself a warning message is printed.

Reimplemented from XC::FE_Datastore.

§ getDbTag()

int XC::NEESData::getDbTag ( void ) const

virtual

To return a unique integer identifier at each call.

This identifier will be used by the objects to store/retrieve their information to/from the database. Increments the integer containing the current dbTag and returns this integer.

Reimplemented from XC::FE_Datastore.

§ recvID()

int XC::NEESData::recvID	(	int	dbTag,
		int	commitTag,
		ID &	theID,
		ChannelAddress *	theAddress = `nullptr`
	)

virtual

Invoked to receive the data in the ID object theID to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theID. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

§ recvMatrix()

int XC::NEESData::recvMatrix	(	int	dbTag,
		int	commitTag,
		Matrix &	theMatrix,
		ChannelAddress *	theAddress = `nullptr`
	)

virtual

Invoked to receive the data in the Matrix object theMatrix to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theMatrix. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

§ recvMsg()

int XC::NEESData::recvMsg	(	int	dbTag,
		int	commitTag,
		Message &	theMsg,
		ChannelAddress *	theAddress = `nullptr`
	)

virtual

Invoked to send the data in the Message object theMsg to another Channel object.

The object will obtain the the size of the data that is being received by invoking getSize() on theMsg. The channel object is then responsible for receiving that amount of data from the channel whose address is given by theAddress. If theAddress is 0, the Channel receives from the Channel with the address last set in a send..(), recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

§ recvVector()

int XC::NEESData::recvVector	(	int	dbTag,
		int	commitTag,
		Vector &	theVector,
		ChannelAddress *	theAddress = `nullptr`
	)

virtual

Invoked to receive the data in the Vector object theVector to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theVector. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

§ sendID()

int XC::NEESData::sendID	(	int	dbTag,
		int	commitTag,
		const ID &	theID,
		ChannelAddress *	theAddress = `nullptr`
	)

virtual

Invoked to receive the data in the ID object theID to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theID. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

§ sendMatrix()

int XC::NEESData::sendMatrix	(	int	dbTag,
		int	commitTag,
		const Matrix &	theMatrix,
		ChannelAddress *	theAddress = `nullptr`
	)

virtual

Invoked to receive the data in the Matrix object theMatrix to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theMatrix. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

§ sendMsg()

int XC::NEESData::sendMsg	(	int	dbTag,
		int	commitTag,
		const Message &	theMsg,
		ChannelAddress *	theAddress = `nullptr`
	)

virtual

A method invoked to send the data in the Message object theMsg to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theMsg. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

§ sendVector()

int XC::NEESData::sendVector	(	int	dbTag,
		int	commitTag,
		const Vector &	theVector,
		ChannelAddress *	theAddress = `nullptr`
	)

virtual

Invoked to receive the data in the Vector object theVector to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theVector. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

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

src/utility/database/NEESData.h
src/utility/database/NEESData.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

§ NEESData()

Member Function Documentation

§ commitState()

§ getDbTag()

§ recvID()

§ recvMatrix()

§ recvMsg()

§ recvVector()

§ sendID()

§ sendMatrix()

§ sendMsg()

§ sendVector()