Channel is an abstract base class which defines the channel interface. More...

#include <Channel.h>

Inheritance diagram for XC::Channel:

Collaboration diagram for XC::Channel:

Public Member Functions
	Channel (CommandEntity *owr=nullptr)
	Constructor.

virtual std::string	addToProgram (void)=0
	When creating remote actors the channels created in the actor space need to know how to contact the shadows channels. More...

virtual int	setUpConnection (void)=0

virtual int	setNextAddress (const ChannelAddress &theAddress)=0
	A method invoked to set specify the next address that the next messages to be sent if {sendMessage()} or received if {recvMessage()} is invoked with a null pointer. More...

virtual ChannelAddress *	getLastSendersAddress (void)=0

virtual bool	isDatastore (void) const
	Return true if channel is a data store.

virtual int	getDbTag (void) const
	Return next available database tag. More...

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.

virtual int	sendObj (int commitTag, MovableObject &theObj, ChannelAddress *theAddress=nullptr)=0
	To send the object `theObj` and the commit tag `commitTag` to a remote Channel whose address is given by `theAddress`. More...

virtual int	recvObj (int commitTag, MovableObject &theObj, FEM_ObjectBroker &theBroker, ChannelAddress *theAddress=nullptr)=0
	To receive the object `theObj` with the commit tag `commitTag` from a remote Channel whose address is given by `theAddress`. More...

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.

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

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

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

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

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

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

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

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

Public Member Functions inherited from CommandEntity
	CommandEntity (CommandEntity *owr=nullptr)
	Default constructor.

CommandEntity *	Owner (void)
	Return a pointer to the object owner.

const CommandEntity *	Owner (void) const
	Return un puntero al objeto propietario de ESTE.

const StandardOutputWrapper &	getStandardOutputWrapper (void) const
	Return the regular output stream wrapper.

StandardOutputWrapper &	getStandardOutputWrapper (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.

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.

EntityWithOwner &	operator= (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.

EntityWithOwner *	Owner (void)

const EntityWithOwner *	Owner (void) const

Protected Member Functions
int	sendMovable (int commitTag, MovableObject &)
	Send `theObject`.

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

Protected Member Functions inherited from CommandEntity
template<class T >
void	string_to (T &, const std::string &) const

Protected Member Functions inherited from EntityWithProperties
bool	isEqual (const EntityWithProperties &) const
	Return true if both objects are equal.

Protected Member Functions inherited from EntityWithOwner
virtual bool	isEqual (const EntityWithOwner &) const
	Return true if both objects are equal.

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 CommandEntity *	entcmd_cast (boost::any &data)

Static Protected Attributes inherited from EntityWithOwner
static int	verbosity = 1
	Object that owns THIS ONE. More...

Detailed Description

Channel is an abstract base class which defines the channel interface.

is a point of communication in a program, a mailbox to/from which data enters/leaves a program. Channels are objects through which the objects in the current processes address space can interact with objects in another processes address space. A channel in one process space is associated with a channel in the address space of another process space. The interaction is in the form of data sent between the two processes along the connection line.

Member Function Documentation

◆ addToProgram()

virtual std::string XC::Channel::addToProgram ( void )

pure virtual

When creating remote actors the channels created in the actor space need to know how to contact the shadows channels.

This information is provided in the string returned from this method. It is used by the machine broker when starting the remote process. It places this information as the last arguments to the program.

Implemented in XC::TCP_SocketNoDelay, XC::FE_Datastore, XC::UDP_Socket, XC::TCP_Socket, XC::MPI_Channel, and XC::OracleDatastore.

◆ getDbTag()

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

virtual

Return next available database tag.

Return the next available database tag, must be an integer value greater than 0, 0 is used by the objects to check if they have yet been assigned a database tag. The method defined for the Channel base class always returns 0, only database channel objects need worry about assigning unique integer values.

Reimplemented in XC::FE_Datastore, and XC::NEESData.

◆ recvID()

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

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

Implemented in XC::FileDatastore, XC::NEESData, XC::BerkeleyDbDatastore, XC::MySqlDatastore, XC::UDP_Socket, XC::OracleDatastore, XC::TCP_Socket, XC::MPI_Channel, XC::SQLiteDatastore, and XC::PyDictDatastore.

◆ recvMatrix()

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

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

Implemented in XC::FileDatastore, XC::NEESData, XC::BerkeleyDbDatastore, XC::MySqlDatastore, XC::UDP_Socket, XC::OracleDatastore, XC::TCP_Socket, XC::MPI_Channel, XC::SQLiteDatastore, and XC::PyDictDatastore.

◆ recvMsg()

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

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

Implemented in XC::FileDatastore, XC::NEESData, XC::BerkeleyDbDatastore, XC::MySqlDatastore, XC::UDP_Socket, XC::OracleDatastore, XC::TCP_Socket, XC::MPI_Channel, XC::SQLiteDatastore, and XC::PyDictDatastore.

◆ recvObj()

virtual int XC::Channel::recvObj	(	int	commitTag,
		MovableObject &	theObj,
		FEM_ObjectBroker &	theBroker,
		ChannelAddress *	theAddress = `nullptr`
	)

pure virtual

To receive the object theObj with the commit tag commitTag from a remote 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.

Implemented in XC::FE_Datastore, XC::UDP_Socket, XC::OracleDatastore, XC::TCP_Socket, and XC::MPI_Channel.

◆ recvVector()

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

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

Implemented in XC::FileDatastore, XC::NEESData, XC::BerkeleyDbDatastore, XC::MySqlDatastore, XC::UDP_Socket, XC::OracleDatastore, XC::TCP_Socket, XC::MPI_Channel, XC::SQLiteDatastore, and XC::PyDictDatastore.

◆ sendID()

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

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

Implemented in XC::FileDatastore, XC::NEESData, XC::BerkeleyDbDatastore, XC::MySqlDatastore, XC::UDP_Socket, XC::OracleDatastore, XC::TCP_Socket, XC::MPI_Channel, XC::SQLiteDatastore, and XC::PyDictDatastore.

◆ sendMatrix()

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

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

Implemented in XC::FileDatastore, XC::NEESData, XC::BerkeleyDbDatastore, XC::MySqlDatastore, XC::UDP_Socket, XC::OracleDatastore, XC::TCP_Socket, XC::MPI_Channel, XC::SQLiteDatastore, and XC::PyDictDatastore.

◆ sendMsg()

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

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

Implemented in XC::FileDatastore, XC::NEESData, XC::BerkeleyDbDatastore, XC::MySqlDatastore, XC::UDP_Socket, XC::OracleDatastore, XC::TCP_Socket, XC::MPI_Channel, XC::SQLiteDatastore, and XC::PyDictDatastore.

◆ sendObj()

virtual int XC::Channel::sendObj	(	int	commitTag,
		MovableObject &	theObj,
		ChannelAddress *	theAddress = `nullptr`
	)

pure virtual

To send the object theObj and the commit tag commitTag to a remote Channel whose address is 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.

Implemented in XC::FE_Datastore, XC::UDP_Socket, XC::OracleDatastore, XC::TCP_Socket, and XC::MPI_Channel.

◆ sendVector()

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

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

Implemented in XC::FileDatastore, XC::NEESData, XC::BerkeleyDbDatastore, XC::MySqlDatastore, XC::UDP_Socket, XC::OracleDatastore, XC::TCP_Socket, XC::MPI_Channel, XC::SQLiteDatastore, and XC::PyDictDatastore.

◆ setNextAddress()

virtual int XC::Channel::setNextAddress ( const ChannelAddress & theAddress )

pure virtual

A method invoked to set specify the next address that the next messages to be sent if {sendMessage()} or received if {recvMessage()} is invoked with a null pointer.

Implemented in XC::FE_Datastore, XC::UDP_Socket, XC::TCP_SocketNoDelay, XC::TCP_Socket, XC::MPI_Channel, and XC::OracleDatastore.

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

src/utility/actor/channel/Channel.h
src/utility/actor/channel/Channel.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addToProgram()

◆ getDbTag()

◆ recvID()

◆ recvMatrix()

◆ recvMsg()

◆ recvObj()

◆ recvVector()

◆ sendID()

◆ sendMatrix()

◆ sendMsg()

◆ sendObj()

◆ sendVector()

◆ setNextAddress()