DtAssistantNetworkTestEnableMsg Class Reference

The DtAssistantNetworkTestEnableMsg defines a wrapper for the RTI Assistant network testing enable/disable message used by the Assistant to command an rtiexec to enable or disable testing for a given federation. More...

Inheritance diagram for DtAssistantNetworkTestEnableMsg:

Collaboration diagram for DtAssistantNetworkTestEnableMsg:

Public Member Functions
	DtAssistantNetworkTestEnableMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantNetworkTestEnableMsg (const DtNetAssistantNetworkTestEnableMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantNetworkTestEnableMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual unsigned long	federationHandle () const
	Get the handle of the federation for which network testing should be enabled or disabled.
virtual void	setFederationHandle (unsigned long handle)
	Set the handle of the federation for which network testing should be enabled or disabled.
virtual bool	enableTesting () const
	Gets whether testing should be enabled or disabled.
virtual void	setEnableTesting (bool enable)
	Sets whether testing should be enabled or disabled.
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, DtAssistantNetworkTestEnableCb cb, void *usr)
	Adds or removes a callback with the given Assistant client for this message type.
static void	removeCallback (DtRtiAssistantClient *conn, DtAssistantNetworkTestEnableCb 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 DtNetAssistantNetworkTestEnableMsg *	netAssistantNetworkTestEnableMsg ()
	The network representation for the message.
virtual const DtNetAssistantNetworkTestEnableMsg *	netAssistantNetworkTestEnableMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantNetworkTestEnableMsg 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 DtAssistantNetworkTestEnableMsg defines a wrapper for the RTI Assistant network testing enable/disable message used by the Assistant to command an rtiexec to enable or disable testing for a given federation.

Constructor & Destructor Documentation

DtAssistantNetworkTestEnableMsg::DtAssistantNetworkTestEnableMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtAssistantNetworkTestEnableMsg::DtAssistantNetworkTestEnableMsg	(	const DtNetAssistantNetworkTestEnableMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

virtual DtAssistantNetworkTestEnableMsg::~DtAssistantNetworkTestEnableMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtAssistantNetworkTestEnableMsg::addCallback ( DtRtiAssistantClient *  conn, DtAssistantNetworkTestEnableCb  cb, void *  usr  )

static

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

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

virtual

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

Implements DtAssistantMsg.

static DtAssistantMsg* DtAssistantNetworkTestEnableMsg::create ( const DtNetAssistantMsgHeader *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER  )

static

Creators.

static DtAssistantMsg* DtAssistantNetworkTestEnableMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER )

static

virtual bool DtAssistantNetworkTestEnableMsg::enableTesting ( ) const

virtual

Gets whether testing should be enabled or disabled.

virtual unsigned long DtAssistantNetworkTestEnableMsg::federationHandle ( ) const

virtual

Get the handle of the federation for which network testing should be enabled or disabled.

virtual DtAssistantMsgKind DtAssistantNetworkTestEnableMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantNetworkTestEnableMsg message.

Implements DtAssistantMsg.

virtual int DtAssistantNetworkTestEnableMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantNetworkTestEnableMsg* DtAssistantNetworkTestEnableMsg::netAssistantNetworkTestEnableMsg ( )

protectedvirtual

The network representation for the message.

virtual const DtNetAssistantNetworkTestEnableMsg* DtAssistantNetworkTestEnableMsg::netAssistantNetworkTestEnableMsg ( ) const

protectedvirtual

virtual void DtAssistantNetworkTestEnableMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantNetworkTestEnableMsg::removeCallback ( DtRtiAssistantClient *  conn, DtAssistantNetworkTestEnableCb  cb, void *  usr  )

static

virtual void DtAssistantNetworkTestEnableMsg::setEnableTesting ( bool  enable )

virtual

Sets whether testing should be enabled or disabled.

virtual void DtAssistantNetworkTestEnableMsg::setFederationHandle ( unsigned long  handle )

virtual

Set the handle of the federation for which network testing should be enabled or disabled.

---

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

• assistantNetworkTestEnableMsg.h