DtAssistantMsg Class Reference

Base class for assistant Messages. More...

Inheritance diagram for DtAssistantMsg:

Collaboration diagram for DtAssistantMsg:

Public Member Functions
virtual	~DtAssistantMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const =0
	Return a copy/empty object of the same type as this.
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 void	printSrcDest () const
virtual void	printData () 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)
virtual const DtAssistantUuid &	sourceUuid () const
	Get/Set the uuid of the source of this message.
virtual void	setSourceUuid (const DtAssistantUuid &uuid)
virtual bool	isForeign () const
	Get/Set the whether the source considers the destination foreign Assistant-to-Assistant messages only.
virtual void	setIsForeign (bool isForeignDestination)
virtual DtU32	sequence () const
	Get/Set sequence number Assistant-to-Assistant messages only.
virtual void	setSequence (DtU32 sequenceNumber)

Static Public Member Functions
static const char *	kindToString (DtAssistantMsgKind kind)
	Returns the name of the message, by kind enumeration.

Protected Member Functions
	DtAssistantMsg ()
	Constructor.
virtual DtAssistantMsgKind	internalMsgKind ()=0
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

Base class for assistant Messages.

Constructor & Destructor Documentation

virtual DtAssistantMsg::~DtAssistantMsg ( )

virtual

Destructor.

DtAssistantMsg::DtAssistantMsg ( )

protected

Constructor.

Member Function Documentation

void DtAssistantMsg::adjustBytes ( int  offset, int  numBytes  )

inlineprotectedvirtual

Adjust numBytes bytes at the indicated offset in the net rep.

Uses insertBytes or deleteBytes based on sign of numBytes

References rti1516e::insertBytes().

void DtAssistantMsg::adjustBytes ( void *  address, int  numBytes  )

inlineprotectedvirtual

Adjust the numBytes starting at the indicated address.

Assumes that address falls within the net rep. Uses insertBytes or deleteBytes based on sign of numBytes

References rti1516e::insertBytes().

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

pure virtual

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

NOTE: The transport type is not carried in the network representation used to make clones; therefore, it must be set after the clone is made

Implemented in DtAssistantStartRtiForwarderMsg, DtAssistantCommandMsg, DtAssistantTestMgrStatusMsg, DtAssistantShowDialogMsg, DtAssistantLatencyReportMsg, DtAssistantChangeLatencyTestModeMsg, DtAssistantLrcCompInfoMsg, DtAssistantShutdownMsg, DtAssistantStateObserveMsg, DtAssistantRtiexecCompInfoMsg, DtAssistantShmCompInfoMsg, DtAssistantFederateStateMsg, DtAssistantStartRtiexecMsg, DtAssistantLogMsg, DtAssistantNotifyMsg, DtAssistantPopupMsg, DtAssistantRtiForwarderCompInfoMsg, DtAssistantAwaitingForwardersMsg, DtAssistantConnMsg, DtAssistantForwarderConnectMsg, DtAssistantLightweightInfoMsg, DtAssistantExecStateMsg, DtAssistantLicQueryMsg, DtAssistantNtfyLvlUpdateMsg, DtAssistantQueryMsg, DtAssistantRidParamsMsg, DtAssistantInfoMsg, DtAssistantSyncPtUpdateMsg, DtAssistantDeleteFederateMsg, DtAssistantDeleteFederationMsg, DtAssistantExecObserveRspMsg, DtAssistantExitMsg, DtAssistantTimeStateMsg, DtAssistantFederationStateMsg, DtAssistantForwarderStateMsg, DtAssistantLicServerInfoMsg, DtAssistantLogEnableMsg, DtAssistantLogRequestMsg, DtAssistantNetworkTestEnableMsg, DtAssistantNotifyObserveMsg, DtAssistantSignalTickedMsg, DtAssistantRemovalMsg, DtAssistantConnQueryMsg, and DtAssistantFederateSignalTickIntervalMsg.

virtual int DtAssistantMsg::compId ( ) const

virtual

Get/Set the related component's connection ID.

Assistant-to-Assistant messages only.

virtual MAKRti::DtInetAddr DtAssistantMsg::destAddr ( ) const

virtual

Get/Set the IP address of the destination of this message.

Assistant-to-Assistant messages only.

virtual int DtAssistantMsg::destId ( ) const

virtual

Get/Set the ID of the destination of this message.

Assistant-to-Assistant messages only.

void DtAssistantMsg::initAssistantMsg ( int  size, DtAssistantMsgKind  msgKindVal, DtBufferPtr  buffer  )

protected

Called by ctor, so not virtual.

void DtAssistantMsg::initAssistantMsg ( const void *  initial, int  size, DtBufferPtr  buffer  )

protected

void DtAssistantMsg::initAssistantMsg ( const DtNetAssistantMsgHeader *  header, DtBufferPtr  buffer  )

protected

virtual DtAssistantMsgKind DtAssistantMsg::internalMsgKind ( )

protectedpure virtual

Implemented in DtAssistantStartRtiForwarderMsg, DtAssistantLrcCompInfoMsg, DtAssistantConnQueryMsg, DtAssistantFederateStateMsg, DtAssistantRtiexecCompInfoMsg, DtAssistantRtiForwarderCompInfoMsg, DtAssistantStartRtiexecMsg, DtAssistantStateObserveMsg, DtAssistantFederationStateMsg, DtAssistantChangeLatencyTestModeMsg, DtAssistantForwarderStateMsg, DtAssistantCommandMsg, DtAssistantTestMgrStatusMsg, DtAssistantRidParamsMsg, DtAssistantLatencyReportMsg, DtAssistantInfoMsg, DtAssistantShmCompInfoMsg, DtAssistantForwarderConnectMsg, DtAssistantSyncPtUpdateMsg, DtAssistantPopupMsg, DtAssistantExecStateMsg, DtAssistantAwaitingForwardersMsg, DtAssistantLicQueryMsg, DtAssistantNotifyMsg, DtAssistantShutdownMsg, DtAssistantDeleteFederateMsg, DtAssistantShowDialogMsg, DtAssistantLogMsg, DtAssistantConnMsg, DtAssistantDeleteFederationMsg, DtAssistantExecObserveRspMsg, DtAssistantLightweightInfoMsg, DtAssistantNetworkTestEnableMsg, DtAssistantLogRequestMsg, DtAssistantTimeStateMsg, DtAssistantLicServerInfoMsg, DtAssistantNtfyLvlUpdateMsg, DtAssistantExitMsg, DtAssistantFederateSignalTickIntervalMsg, DtAssistantLogEnableMsg, DtAssistantNotifyObserveMsg, DtAssistantQueryMsg, DtAssistantSignalTickedMsg, DtAssistantRemovalMsg, and DtAssistantTemplateMsg.

bool DtAssistantMsg::isAssistantToAssistantMessage

(

)

const

Returns whether or not this message contains source/destination information included in messages sent between assistants.

virtual bool DtAssistantMsg::isForeign ( ) const

virtual

Get/Set the whether the source considers the destination foreign Assistant-to-Assistant messages only.

bool DtAssistantMsg::isOk ( ) const

inlinevirtual

Message is good?

virtual bool DtAssistantMsg::isValidVersion ( ) const

virtual

Returns bool: message version is valid?

static const char* DtAssistantMsg::kindToString ( DtAssistantMsgKind  kind )

static

Returns the name of the message, by kind enumeration.

DtAssistantMsgKind DtAssistantMsg::msgKind ( ) const

inlinevirtual

Get the message kind.

References netHeader().

DtNetAssistantMsgHeader * DtAssistantMsg::netHeader ( ) const

inlinevirtual

Get header of network representation.

Referenced by DtNetAssistantMsgHeaderParam::endPtr(), and msgKind().

virtual void DtAssistantMsg::print ( ) const

virtual

Printing functions.

virtual void DtAssistantMsg::printData ( ) const

virtual

Reimplemented in DtAssistantLrcCompInfoMsg, DtAssistantFederateStateMsg, DtAssistantRtiexecCompInfoMsg, DtAssistantRtiForwarderCompInfoMsg, DtAssistantStartRtiexecMsg, DtAssistantFederationStateMsg, DtAssistantStateObserveMsg, DtAssistantConnQueryMsg, DtAssistantInfoMsg, DtAssistantRidParamsMsg, DtAssistantShmCompInfoMsg, DtAssistantForwarderConnectMsg, DtAssistantSyncPtUpdateMsg, DtAssistantCommandMsg, DtAssistantLicQueryMsg, DtAssistantNotifyMsg, DtAssistantShowDialogMsg, DtAssistantConnMsg, DtAssistantShutdownMsg, DtAssistantTestMgrStatusMsg, DtAssistantLogMsg, DtAssistantLightweightInfoMsg, DtAssistantNetworkTestEnableMsg, DtAssistantDeleteFederateMsg, DtAssistantTimeStateMsg, DtAssistantPopupMsg, DtAssistantLatencyReportMsg, DtAssistantTemplateMsg, DtAssistantChangeLatencyTestModeMsg, DtAssistantLicServerInfoMsg, DtAssistantNtfyLvlUpdateMsg, DtAssistantDeleteFederationMsg, DtAssistantExecObserveRspMsg, DtAssistantLogEnableMsg, DtAssistantLogRequestMsg, DtAssistantNotifyObserveMsg, DtAssistantAwaitingForwardersMsg, DtAssistantExecStateMsg, DtAssistantQueryMsg, DtAssistantExitMsg, DtAssistantFederateSignalTickIntervalMsg, DtAssistantForwarderStateMsg, DtAssistantSignalTickedMsg, and DtAssistantRemovalMsg.

virtual void DtAssistantMsg::printHeader ( ) const

virtual

virtual void DtAssistantMsg::printSrcDest ( ) const

virtual

virtual void DtAssistantMsg::resizeForSrcDestInfo ( )

protectedvirtual

Allocates memory at the end of the message for source/destination information needed when sending messages between assistants.

virtual DtU32 DtAssistantMsg::sequence ( ) const

virtual

Get/Set sequence number Assistant-to-Assistant messages only.

virtual void DtAssistantMsg::setCompId ( int  compId )

virtual

virtual void DtAssistantMsg::setDestAddr ( const MAKRti::DtInetAddr &  addr )

virtual

virtual void DtAssistantMsg::setDestId ( int  id )

virtual

virtual void DtAssistantMsg::setIsForeign ( bool  isForeignDestination )

virtual

virtual void DtAssistantMsg::setSequence ( DtU32  sequenceNumber )

virtual

virtual void DtAssistantMsg::setSourceAddr ( const MAKRti::DtInetAddr &  addr )

virtual

virtual void DtAssistantMsg::setSourceHost ( const MAKRti::DtString &  addr )

virtual

virtual void DtAssistantMsg::setSourceHostSize ( unsigned long  size )

protectedvirtual

Set/Get source host name text size.

virtual void DtAssistantMsg::setSourceId ( int  id )

virtual

virtual void DtAssistantMsg::setSourceUuid ( const DtAssistantUuid &  uuid )

virtual

virtual void DtAssistantMsg::sizeChanged ( int  size )

protectedvirtual

Called whenever size is changed using changeSize, or insert/deleteBytes.

virtual MAKRti::DtInetAddr DtAssistantMsg::sourceAddr ( ) const

virtual

Get/Set the IP address of the source of this message.

Assistant-to-Assistant messages only.

virtual MAKRti::DtString DtAssistantMsg::sourceHost ( ) const

virtual

Get/Set the host name of the source of this message.

Assistant-to-Assistant messages only.

virtual const char* DtAssistantMsg::sourceHostPtr ( ) const

protectedvirtual

Return pointer to source host name in message.

virtual char* DtAssistantMsg::sourceHostPtr ( )

protectedvirtual

virtual unsigned long DtAssistantMsg::sourceHostSize ( ) const

protectedvirtual

virtual int DtAssistantMsg::sourceId ( ) const

virtual

Get/Set the ID of the source of this message.

Assistant-to-Assistant messages only.

virtual const DtAssistantUuid& DtAssistantMsg::sourceUuid ( ) const

virtual

Get/Set the uuid of the source of this message.

Assistant-to-Assistant messages only.

virtual const DtNetAssistantSrcDestInfo* DtAssistantMsg::srcDestInfoPtr ( ) const

protectedvirtual

Return pointer to source/destination information in the message.

If the message does not contain this info, will return 0.

virtual DtNetAssistantSrcDestInfo* DtAssistantMsg::srcDestInfoPtr ( )

protectedvirtual

virtual int DtAssistantMsg::version ( ) const

virtual

Return the message version.

---

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

• assistantMsg.h