The DtAssistantStateObserveMsg defines a wrapper for the RTI Assistant message used by the Assistant to inform a component that there is an Assistant observing the component and that it should send update messages. More...

Inheritance diagram for DtAssistantStateObserveMsg:

Collaboration diagram for DtAssistantStateObserveMsg:

Public Member Functions
	DtAssistantStateObserveMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtAssistantStateObserveMsg (const DtNetAssistantStateObserveMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtAssistantStateObserveMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual bool	isObserved () const
	Returns whether the state is or is not being observed.
virtual void	setIsObserved (bool observed)
	Set whether the state is or is not being observed.
virtual bool	isLogRequest () const
	Returns whether this is a full observation requst or just a log request.
virtual void	setIsLogRequest (bool observed)
	Set that this is a log request.
virtual void	setDefunctRemovalTime (int removalTime)
	Set the defunct removal time.
virtual int	getDefunctRemovalTime () const
	Get the defunct removal time.
virtual bool	isSingleView () const
	Is this a persistent observation or a one-shot?
virtual void	setIsSingleView (bool oneTime)
	Set whether this is a persistent observation or not.
virtual unsigned int	timeStateUpdateInterval () const
	Get the time state update interval in milliseconds.
virtual void	setTimeStateUpdateInterval (unsigned int interval)
	Set the time state update interval in milliseconds.
virtual DtAssistantStateObserveType	targetType () const
	Get the target Type of the observation.
virtual void	setTargetType (DtAssistantStateObserveType target)
	Set the target of the observation.
virtual void	getConnection (DtRtiConnectionInfo &conn, const MAKRti::DtInetAddr &address) const
	Get the connection to be observed, setting the network interface address as given.
virtual void	setConnection (const DtRtiConnectionInfo &conn)
	Set the connection to be observed.
virtual void	printData () const
	Print the data section.
Public Member Functions inherited from DtAssistantMsg
virtual	~DtAssistantMsg ()
	Destructor.
virtual DtNetAssistantMsgHeader *	netHeader () const
	Get header of network representation.
virtual int	version () const
	Return the message version.
virtual bool	isValidVersion () const
	Returns bool: message version is valid?
virtual DtAssistantMsgKind	msgKind () const
	Get the message kind.
virtual void	print () const
	Printing functions.
virtual void	printHeader () const
virtual bool	isOk () const
	Message is good?
bool	isAssistantToAssistantMessage () const
	Returns whether or not this message contains source/destination information included in messages sent between assistants.
virtual MAKRti::DtInetAddr	sourceAddr () const
	Get/Set the IP address of the source of this message.
virtual void	setSourceAddr (const MAKRti::DtInetAddr &addr)
virtual int	sourceId () const
	Get/Set the ID of the source of this message.
virtual void	setSourceId (int id)
virtual MAKRti::DtString	sourceHost () const
	Get/Set the host name of the source of this message.
virtual void	setSourceHost (const MAKRti::DtString &addr)
virtual MAKRti::DtInetAddr	destAddr () const
	Get/Set the IP address of the destination of this message.
virtual void	setDestAddr (const MAKRti::DtInetAddr &addr)
virtual int	destId () const
	Get/Set the ID of the destination of this message.
virtual void	setDestId (int id)
virtual int	compId () const
	Get/Set the related component's connection ID.
virtual void	setCompId (int compId)

Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantClient conn, DtAssistantStateObserveCb cb, void usr)
	Adds or removes a callback with the given Assistant client for this message type.
static void	removeCallback (DtRtiAssistantClient conn, DtAssistantStateObserveCb cb, void usr)
static void	addCallback (DtRtiAssistantPeer conn, DtAssistantStateObserveCb cb, void usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer conn, DtAssistantStateObserveCb cb, void usr)
Static Public Member Functions inherited from DtAssistantMsg
static const char *	kindToString (DtAssistantMsgKind kind)
	Returns the name of the message, by kind enumeration.

Protected Member Functions
virtual DtNetAssistantStateObserveMsg *	netAssistantStateObserveMsg ()
	The network representation for the state observe message.
virtual const DtNetAssistantStateObserveMsg *	netAssistantStateObserveMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantExitMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
Protected Member Functions inherited from DtAssistantMsg
	DtAssistantMsg ()
	Constructor.
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes.
void	initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual.
void	initAssistantMsg (const void *initial, int size, DtBufferPtr buffer)
void	initAssistantMsg (const DtNetAssistantMsgHeader *header, DtBufferPtr buffer)
virtual void	adjustBytes (int offset, int numBytes)
	Adjust numBytes bytes at the indicated offset in the net rep.
virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated address.
virtual void	resizeForSrcDestInfo ()
	Allocates memory at the end of the message for source/destination information needed when sending messages between assistants.
virtual const DtNetAssistantSrcDestInfo *	srcDestInfoPtr () const
	Return pointer to source/destination information in the message.
virtual DtNetAssistantSrcDestInfo *	srcDestInfoPtr ()
virtual void	setSourceHostSize (unsigned long size)
	Set/Get source host name text size.
virtual unsigned long	sourceHostSize () const
virtual const char *	sourceHostPtr () const
	Return pointer to source host name in message.
virtual char *	sourceHostPtr ()

Detailed Description

The DtAssistantStateObserveMsg defines a wrapper for the RTI Assistant message used by the Assistant to inform a component that there is an Assistant observing the component and that it should send update messages.

Constructor & Destructor Documentation

DtAssistantStateObserveMsg::DtAssistantStateObserveMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructor.

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().

Referenced by clone(), and create().

DtAssistantStateObserveMsg::DtAssistantStateObserveMsg	(	const DtNetAssistantStateObserveMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

Constructor.

References DtNetAssistantStateObserveMsg::header, and DtAssistantMsg::initAssistantMsg().

DtAssistantStateObserveMsg::~DtAssistantStateObserveMsg ( )

virtual

Destructor.

Member Function Documentation

void DtAssistantStateObserveMsg::addCallback	(	DtRtiAssistantClient *	conn,
		DtAssistantStateObserveCb	cb,
		void *	usr
	)

static

Adds or removes a callback with the given Assistant client for this message type.

References DtRtiAssistantClient::addMsgCallback(), and DtAssistantStateObserveMsgKind.

Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr(), DtAssistantNetworkCompInfoMgr::DtAssistantNetworkCompInfoMgr(), DtForwarderObserverForAssistant::DtForwarderObserverForAssistant(), and DtRtiexecObserverForAssistant::DtRtiexecObserverForAssistant().

void DtAssistantStateObserveMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantStateObserveCb	cb,
		void *	usr
	)

static

Adds or removes a callback with the given Assistant peer for this message type.

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantStateObserveMsgKind.

DtAssistantMsg * DtAssistantStateObserveMsg::clone ( bool copy = true ) const

virtual

Return a copy/empty object of the same type as this.

Implements DtAssistantMsg.

References DtAssistantStateObserveMsg(), and netAssistantStateObserveMsg().

DtAssistantMsg * DtAssistantStateObserveMsg::create	(	const DtNetAssistantMsgHeader *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

static

Creators.

References DtAssistantStateObserveMsg().

DtAssistantMsg * DtAssistantStateObserveMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

References DtAssistantStateObserveMsg().

void DtAssistantStateObserveMsg::getConnection	(	DtRtiConnectionInfo &	conn,
		const MAKRti::DtInetAddr &	address
	)		const

virtual

Get the connection to be observed, setting the network interface address as given.

References netAssistantStateObserveMsg(), DtRtiConnectionInfo::setBestEffortIp(), DtRtiConnectionInfo::setForwarderPort(), DtRtiConnectionInfo::setNetworkInterfaceAddr(), DtRtiConnectionInfo::setReliableIp(), DtRtiConnectionInfo::setTcpPort(), DtRtiConnectionInfo::setUdpPort(), DtRtiConnectionInfo::setUseRtiexec(), and tcpPort.

Referenced by printData(), DtAssistantNetworkCompInfoMgr::processForwarderObserveMsg(), and DtAssistantFederationsInfoMgr::processObserveMsg().

int DtAssistantStateObserveMsg::getDefunctRemovalTime ( ) const

virtual

Get the defunct removal time.

References DtNetAssistantStateObserveMsg::defunctRemovalTime, and netAssistantStateObserveMsg().

Referenced by DtForwarderObserverForAssistant::processForwarderObserveMsg().

DtAssistantMsgKind DtAssistantStateObserveMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantExitMsg message.

Implements DtAssistantMsg.

References DtAssistantStateObserveMsgKind.

Referenced by DtAssistantStateObserveMsg().

bool DtAssistantStateObserveMsg::isLogRequest ( ) const

virtual

Returns whether this is a full observation requst or just a log request.

References DtNetAssistantStateObserveMsg::isLogRequest, and netAssistantStateObserveMsg().

Referenced by printData(), DtRtiexecObserverForAssistant::processExecObserveMsg(), DtAssistantNetworkCompInfoMgr::processForwarderObserveMsg(), DtForwarderObserverForAssistant::processForwarderObserveMsg(), and DtAssistantFederationsInfoMgr::processObserveMsg().

bool DtAssistantStateObserveMsg::isObserved ( ) const

virtual

Returns whether the state is or is not being observed.

References DtNetAssistantStateObserveMsg::isObserved, and netAssistantStateObserveMsg().

Referenced by printData(), DtRtiexecObserverForAssistant::processExecObserveMsg(), DtAssistantNetworkCompInfoMgr::processForwarderObserveMsg(), DtForwarderObserverForAssistant::processForwarderObserveMsg(), and DtAssistantFederationsInfoMgr::processObserveMsg().

bool DtAssistantStateObserveMsg::isSingleView ( ) const

virtual

Is this a persistent observation or a one-shot?

References DtNetAssistantStateObserveMsg::isSingleView, and netAssistantStateObserveMsg().

Referenced by printData(), and DtRtiexecObserverForAssistant::processExecObserveMsg().

int DtAssistantStateObserveMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantStateObserveMsg().

DtNetAssistantStateObserveMsg * DtAssistantStateObserveMsg::netAssistantStateObserveMsg ( )

protectedvirtual

The network representation for the state observe message.

Referenced by clone(), getConnection(), getDefunctRemovalTime(), isLogRequest(), isObserved(), isSingleView(), setConnection(), setDefunctRemovalTime(), setIsLogRequest(), setIsObserved(), setIsSingleView(), setTargetType(), setTimeStateUpdateInterval(), targetType(), and timeStateUpdateInterval().

const DtNetAssistantStateObserveMsg * DtAssistantStateObserveMsg::netAssistantStateObserveMsg ( ) const

protectedvirtual

void DtAssistantStateObserveMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

References DtRtiConnectionInfo::defaultName(), DtAssistantStateObserveFederationsOrRtiexec, DtAssistantStateObserveForwarder, getConnection(), isLogRequest(), isObserved(), isSingleView(), targetType(), and timeStateUpdateInterval().

void DtAssistantStateObserveMsg::removeCallback	(	DtRtiAssistantClient *	conn,
		DtAssistantStateObserveCb	cb,
		void *	usr
	)

static

References DtAssistantStateObserveMsgKind, and DtRtiAssistantClient::removeMsgCallback().

Referenced by DtAssistantFederationsInfoMgr::~DtAssistantFederationsInfoMgr(), DtAssistantNetworkCompInfoMgr::~DtAssistantNetworkCompInfoMgr(), DtForwarderObserverForAssistant::~DtForwarderObserverForAssistant(), and DtRtiexecObserverForAssistant::~DtRtiexecObserverForAssistant().

void DtAssistantStateObserveMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantStateObserveCb	cb,
		void *	usr
	)

static

References DtAssistantStateObserveMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

void DtAssistantStateObserveMsg::setConnection ( const DtRtiConnectionInfo & conn )

virtual

Set the connection to be observed.

References DtNetAssistantStateObserveMsg::addressFamily, DtRtiConnectionInfo::bestEffortIp(), DtNetAssistantStateObserveMsg::bestEffortIpAddress, DtNetAssistantStateObserveMsg::forwarderPort, DtRtiConnectionInfo::forwarderPort(), netAssistantStateObserveMsg(), DtRtiConnectionInfo::reliableIp(), DtNetAssistantStateObserveMsg::reliableIpAddress, DtNetAssistantStateObserveMsg::tcpPort, DtRtiConnectionInfo::tcpPort(), DtNetAssistantStateObserveMsg::udpPort, DtRtiConnectionInfo::udpPort(), DtNetAssistantStateObserveMsg::useRtiexec, and DtRtiConnectionInfo::useRtiexec().

Referenced by DtRtiAssistantPeer::sendObserveFederationsMsg(), and DtRtiAssistantPeer::sendObserveRtiForwarderMsg().

void DtAssistantStateObserveMsg::setDefunctRemovalTime ( int removalTime )

virtual

Set the defunct removal time.

References DtNetAssistantStateObserveMsg::defunctRemovalTime, and netAssistantStateObserveMsg().

Referenced by DtRtiAssistantServer::sendObserveRtiForwarderMsg().

void DtAssistantStateObserveMsg::setIsLogRequest ( bool observed )

virtual

Set that this is a log request.

References DtNetAssistantStateObserveMsg::isLogRequest, and netAssistantStateObserveMsg().

Referenced by DtRtiAssistantPeer::sendObserveRtiExecLogMsg(), DtRtiAssistantServer::sendObserveRtiexecLogMsg(), DtRtiAssistantServer::sendObserveRtiexecMsg(), DtRtiAssistantServer::sendObserveRtiForwarderMsg(), DtRtiAssistantServer::sendSingleObserveForwarderMsg(), and DtRtiAssistantServer::sendSingleObserveRtiExecMsg().

void DtAssistantStateObserveMsg::setIsObserved ( bool observed )

virtual

Set whether the state is or is not being observed.

References DtNetAssistantStateObserveMsg::isObserved, and netAssistantStateObserveMsg().

Referenced by DtRtiAssistantPeer::sendObserveFederationsMsg(), DtRtiAssistantPeer::sendObserveRtiExecLogMsg(), DtRtiAssistantServer::sendObserveRtiexecLogMsg(), DtRtiAssistantServer::sendObserveRtiexecMsg(), DtRtiAssistantServer::sendObserveRtiForwarderMsg(), DtRtiAssistantPeer::sendObserveRtiForwarderMsg(), DtRtiAssistantServer::sendSingleObserveForwarderMsg(), and DtRtiAssistantServer::sendSingleObserveRtiExecMsg().

void DtAssistantStateObserveMsg::setIsSingleView ( bool oneTime )

virtual

Set whether this is a persistent observation or not.

References DtNetAssistantStateObserveMsg::isSingleView, and netAssistantStateObserveMsg().

Referenced by DtRtiAssistantPeer::sendObserveFederationsMsg(), DtRtiAssistantPeer::sendObserveRtiExecLogMsg(), DtRtiAssistantServer::sendObserveRtiexecLogMsg(), DtRtiAssistantServer::sendObserveRtiexecMsg(), DtRtiAssistantServer::sendObserveRtiForwarderMsg(), DtRtiAssistantPeer::sendObserveRtiForwarderMsg(), DtRtiAssistantServer::sendSingleObserveForwarderMsg(), and DtRtiAssistantServer::sendSingleObserveRtiExecMsg().

void DtAssistantStateObserveMsg::setTargetType ( DtAssistantStateObserveType target )

virtual

Set the target of the observation.

References netAssistantStateObserveMsg(), and DtNetAssistantStateObserveMsg::targetType.

Referenced by DtRtiAssistantPeer::sendObserveFederationsMsg(), DtRtiAssistantPeer::sendObserveRtiExecLogMsg(), DtRtiAssistantServer::sendObserveRtiexecLogMsg(), DtRtiAssistantServer::sendObserveRtiexecMsg(), DtRtiAssistantServer::sendObserveRtiForwarderMsg(), DtRtiAssistantPeer::sendObserveRtiForwarderMsg(), DtRtiAssistantServer::sendSingleObserveForwarderMsg(), and DtRtiAssistantServer::sendSingleObserveRtiExecMsg().

void DtAssistantStateObserveMsg::setTimeStateUpdateInterval ( unsigned int interval )

virtual

Set the time state update interval in milliseconds.

References interval, DtNetAssistantStateObserveMsg::intervalInMs, and netAssistantStateObserveMsg().

Referenced by DtRtiAssistantPeer::sendObserveRtiExecLogMsg(), DtRtiAssistantServer::sendObserveRtiexecLogMsg(), DtRtiAssistantServer::sendObserveRtiexecMsg(), and DtRtiAssistantServer::sendObserveRtiForwarderMsg().

DtAssistantStateObserveType DtAssistantStateObserveMsg::targetType ( ) const

virtual

Get the target Type of the observation.

References netAssistantStateObserveMsg(), and DtNetAssistantStateObserveMsg::targetType.

Referenced by printData(), DtRtiexecObserverForAssistant::processExecObserveMsg(), DtAssistantNetworkCompInfoMgr::processForwarderObserveMsg(), DtForwarderObserverForAssistant::processForwarderObserveMsg(), and DtAssistantFederationsInfoMgr::processObserveMsg().

unsigned int DtAssistantStateObserveMsg::timeStateUpdateInterval ( ) const

virtual

Get the time state update interval in milliseconds.

References DtNetAssistantStateObserveMsg::intervalInMs, and netAssistantStateObserveMsg().

Referenced by printData(), and DtRtiexecObserverForAssistant::processExecObserveMsg().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation