DtAssistantLogEnableMsg Class Reference

The DtAssistantLogEnableMsg defines a wrapper for the RTI Assistant logging enable message used by the Assistant to command an RTI component to enable logging. More...

Inheritance diagram for DtAssistantLogEnableMsg:

Collaboration diagram for DtAssistantLogEnableMsg:

Public Member Functions
	DtAssistantLogEnableMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantLogEnableMsg (const DtNetAssistantLogEnableMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantLogEnableMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual bool	isEnable () const
	Get enable/disable status.
virtual void	setEnable (bool val)
	Set enable/disable status.
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, DtAssistantLogEnableCb cb, void *usr)
	Adds or removes a callback with the given Assistant client for this message type.
static void	removeCallback (DtRtiAssistantClient *conn, DtAssistantLogEnableCb 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 DtNetAssistantLogEnableMsg *	netAssistantLogEnableMsg ()
	The network representation for the log enable message.
virtual const DtNetAssistantLogEnableMsg *	netAssistantLogEnableMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantLogEnableMsg 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 DtAssistantLogEnableMsg defines a wrapper for the RTI Assistant logging enable message used by the Assistant to command an RTI component to enable logging.

Constructor & Destructor Documentation

DtAssistantLogEnableMsg::DtAssistantLogEnableMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

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

Referenced by clone(), and create().

DtAssistantLogEnableMsg::DtAssistantLogEnableMsg	(	const DtNetAssistantLogEnableMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

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

DtAssistantLogEnableMsg::~DtAssistantLogEnableMsg ( )

virtual

Destructor.

Member Function Documentation

void DtAssistantLogEnableMsg::addCallback ( DtRtiAssistantClient *  conn, DtAssistantLogEnableCb  cb, void *  usr  )

static

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

References DtRtiAssistantClient::addMsgCallback(), and DtAssistantLogEnableMsgKind.

Referenced by DtForwarderObserverForAssistant::DtForwarderObserverForAssistant(), DtRtiexecObserverForAssistant::DtRtiexecObserverForAssistant(), and DtFederateMgr::postJoinInit().

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

virtual

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

Implements DtAssistantMsg.

References DtAssistantLogEnableMsg(), and netAssistantLogEnableMsg().

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

static

Creators.

References DtAssistantLogEnableMsg().

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

static

References DtAssistantLogEnableMsg().

DtAssistantMsgKind DtAssistantLogEnableMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantLogEnableMsg message.

Implements DtAssistantMsg.

References DtAssistantLogEnableMsgKind.

Referenced by DtAssistantLogEnableMsg().

bool DtAssistantLogEnableMsg::isEnable ( ) const

virtual

Get enable/disable status.

References DtNetAssistantLogEnableMsg::enableLogging, and netAssistantLogEnableMsg().

Referenced by printData(), and DtFederateMgr::processAssistantEnableLogging().

int DtAssistantLogEnableMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantLogEnableMsg().

DtNetAssistantLogEnableMsg * DtAssistantLogEnableMsg::netAssistantLogEnableMsg ( )

protectedvirtual

The network representation for the log enable message.

Referenced by clone(), isEnable(), and setEnable().

const DtNetAssistantLogEnableMsg * DtAssistantLogEnableMsg::netAssistantLogEnableMsg ( ) const

protectedvirtual

void DtAssistantLogEnableMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

References isEnable().

void DtAssistantLogEnableMsg::removeCallback ( DtRtiAssistantClient *  conn, DtAssistantLogEnableCb  cb, void *  usr  )

static

References DtAssistantLogEnableMsgKind, and DtRtiAssistantClient::removeMsgCallback().

Referenced by DtRtiexecObserverForAssistant::~DtRtiexecObserverForAssistant().

void DtAssistantLogEnableMsg::setEnable ( bool  val )

virtual

Set enable/disable status.

References DtNetAssistantLogEnableMsg::enableLogging, and netAssistantLogEnableMsg().

Referenced by DtRtiAssistantServer::sendLogEnableMsg().

---

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

• assistantLogEnableMsg.h
• assistantLogEnableMsg.cxx