The DtAssistantRtiexecCompInfoMsg defines a wrapper for the RTI Assistant component information message used to send information about an rtiexec component to its connected RTI Assistant. More...

Inheritance diagram for DtAssistantRtiexecCompInfoMsg:

Collaboration diagram for DtAssistantRtiexecCompInfoMsg:

Public Member Functions
	DtAssistantRtiexecCompInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantRtiexecCompInfoMsg (const DtNetAssistantRtiexecCompInfoMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantRtiexecCompInfoMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setTcpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set TCP forwarder IP address.
virtual MAKRti::DtInetAddr	tcpAddress () const
	Get TCP forwarder IP address.
virtual void	setTcpPort (int port)
	Set forwarder TCP port number.
virtual int	tcpPort () const
	Get forwarder TCP port number.
virtual void	setTcpIfAddress (const MAKRti::DtInetAddr &ipAddr)
	Set TCP interface IP address.
virtual MAKRti::DtInetAddr	tcpIfAddress () const
	Get TCP interface IP address.
virtual void	setUdpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set best effort IP address.
virtual MAKRti::DtInetAddr	udpAddress () const
	Get best effort IP address.
virtual void	setUdpIfAddress (const MAKRti::DtInetAddr &ipAddr)
	Set UDP interface IP address.
virtual MAKRti::DtInetAddr	udpIfAddress () const
	Get UDP interface IP address.
virtual void	setUdpPort (int port)
	Set forwarder UDP port number.
virtual int	udpPort () const
	Get forwarder UDP port number.
virtual void	setFullCompliance (bool val)
	Set the flag indicating if rtiexec is running with full compliance.
virtual bool	fullCompliance () const
	Get the flag indicating if rtiexec is running with full compliance.
virtual void	setIsConnected (bool connected)
	Set whether or not the rtiexec has successfully connected to a forwarder.
virtual bool	isConnected () const
	Get whether the rtiexec has successfully connected to a forwarder.
virtual void	setHostName (const MAKRti::DtString &name)
	Set rtiexec host name.
virtual MAKRti::DtString	hostName () const
	Get rtiexec host name.
virtual void	setLogFilename (const MAKRti::DtFilename &filename)
	Set component log filename.
virtual MAKRti::DtFilename	logFilename () const
	Get component log filename.
virtual void	setNotifyLevel (DtNotifyLevelType level)
	Set notify level.
virtual DtNotifyLevelType	notifyLevel () const
	Get notify level.
virtual void	setLicServer (const MAKRti::DtString &server)
	Set the license server used by the rtiexec.
virtual MAKRti::DtString	licServer () const
	Get rtiexec license server.
virtual int	forwarderPort () const
	Get the forwarder port.
virtual void	setForwarderPort (int forwarderPortToUse)
	Set the forwarder port.
virtual MAKRti::DtInetAddr	additionalForwarderConnection () const
	Get the optional additional forwarder to connect to.
virtual void	setAdditionalForwarderConnection (const MAKRti::DtInetAddr &addr)
	Set the optional additional forwarder to connect to.
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 void	printSrcDest () 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 DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantServer conn, DtAssistantRtiexecCompInfoCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantRtiexecCompInfoCb 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 void	setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily fam)
	Set the IP address family.
virtual MAKRti::DtInetUtils::DtInetAddrFamily	addressFamily () const
	Get the IP address family.
virtual DtNetAssistantRtiexecCompInfoMsg *	netAssistantRtiexecCompInfoMsg ()
	The network representation for the rtiexec component information.
virtual const DtNetAssistantRtiexecCompInfoMsg *	netAssistantRtiexecCompInfoMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantRtiexecCompInfoMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setHostNameSize (unsigned long size)
	Set/Get rtiexec host name size.
virtual unsigned long	hostNameSize () const
virtual const char *	hostNamePtr () const
	Return pointer to rtiexec host name location in message.
virtual char *	hostNamePtr ()
virtual void	setLogFilenameSize (unsigned long size)
	Set/Get log filename size.
virtual unsigned long	logFilenameSize () const
virtual const char *	logFilenamePtr () const
	Return pointer to component name location in message.
virtual char *	logFilenamePtr ()
virtual void	setLicServerSize (unsigned long size)
	Set/Get license server size.
virtual unsigned long	licServerSize () const
virtual const char *	licServerPtr () const
	Return pointer to license server location in message.
virtual char *	licServerPtr ()
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 DtAssistantRtiexecCompInfoMsg defines a wrapper for the RTI Assistant component information message used to send information about an rtiexec component to its connected RTI Assistant.

Constructor & Destructor Documentation

DtAssistantRtiexecCompInfoMsg::DtAssistantRtiexecCompInfoMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

DtAssistantRtiexecCompInfoMsg::DtAssistantRtiexecCompInfoMsg	(	const DtNetAssistantRtiexecCompInfoMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

virtual DtAssistantRtiexecCompInfoMsg::~DtAssistantRtiexecCompInfoMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtAssistantRtiexecCompInfoMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantRtiexecCompInfoCb	cb,
		void *	usr
	)

static

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

virtual MAKRti::DtInetAddr DtAssistantRtiexecCompInfoMsg::additionalForwarderConnection ( ) const

virtual

Get the optional additional forwarder to connect to.

virtual MAKRti::DtInetUtils::DtInetAddrFamily DtAssistantRtiexecCompInfoMsg::addressFamily ( ) const

protectedvirtual

Get the IP address family.

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

virtual

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

Implements DtAssistantMsg.

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

static

Creators.

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

static

virtual int DtAssistantRtiexecCompInfoMsg::forwarderPort ( ) const

virtual

Get the forwarder port.

virtual bool DtAssistantRtiexecCompInfoMsg::fullCompliance ( ) const

virtual

Get the flag indicating if rtiexec is running with full compliance.

virtual MAKRti::DtString DtAssistantRtiexecCompInfoMsg::hostName ( ) const

virtual

Get rtiexec host name.

virtual const char* DtAssistantRtiexecCompInfoMsg::hostNamePtr ( ) const

protectedvirtual

Return pointer to rtiexec host name location in message.

virtual char* DtAssistantRtiexecCompInfoMsg::hostNamePtr ( )

protectedvirtual

virtual unsigned long DtAssistantRtiexecCompInfoMsg::hostNameSize ( ) const

protectedvirtual

virtual DtAssistantMsgKind DtAssistantRtiexecCompInfoMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantRtiexecCompInfoMsg message.

Implements DtAssistantMsg.

virtual bool DtAssistantRtiexecCompInfoMsg::isConnected ( ) const

virtual

Get whether the rtiexec has successfully connected to a forwarder.

virtual MAKRti::DtString DtAssistantRtiexecCompInfoMsg::licServer ( ) const

virtual

Get rtiexec license server.

virtual const char* DtAssistantRtiexecCompInfoMsg::licServerPtr ( ) const

protectedvirtual

Return pointer to license server location in message.

virtual char* DtAssistantRtiexecCompInfoMsg::licServerPtr ( )

protectedvirtual

virtual unsigned long DtAssistantRtiexecCompInfoMsg::licServerSize ( ) const

protectedvirtual

virtual MAKRti::DtFilename DtAssistantRtiexecCompInfoMsg::logFilename ( ) const

virtual

Get component log filename.

virtual const char* DtAssistantRtiexecCompInfoMsg::logFilenamePtr ( ) const

protectedvirtual

Return pointer to component name location in message.

virtual char* DtAssistantRtiexecCompInfoMsg::logFilenamePtr ( )

protectedvirtual

virtual unsigned long DtAssistantRtiexecCompInfoMsg::logFilenameSize ( ) const

protectedvirtual

virtual int DtAssistantRtiexecCompInfoMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantRtiexecCompInfoMsg* DtAssistantRtiexecCompInfoMsg::netAssistantRtiexecCompInfoMsg ( )

protectedvirtual

The network representation for the rtiexec component information.

virtual const DtNetAssistantRtiexecCompInfoMsg* DtAssistantRtiexecCompInfoMsg::netAssistantRtiexecCompInfoMsg ( ) const

protectedvirtual

virtual DtNotifyLevelType DtAssistantRtiexecCompInfoMsg::notifyLevel ( ) const

virtual

Get notify level.

virtual void DtAssistantRtiexecCompInfoMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantRtiexecCompInfoMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantRtiexecCompInfoCb	cb,
		void *	usr
	)

static

virtual void DtAssistantRtiexecCompInfoMsg::setAdditionalForwarderConnection ( const MAKRti::DtInetAddr & addr )

virtual

Set the optional additional forwarder to connect to.

virtual void DtAssistantRtiexecCompInfoMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily fam )

protectedvirtual

Set the IP address family.

virtual void DtAssistantRtiexecCompInfoMsg::setForwarderPort ( int forwarderPortToUse )

virtual

Set the forwarder port.

virtual void DtAssistantRtiexecCompInfoMsg::setFullCompliance ( bool val )

virtual

Set the flag indicating if rtiexec is running with full compliance.

virtual void DtAssistantRtiexecCompInfoMsg::setHostName ( const MAKRti::DtString & name )

virtual

Set rtiexec host name.

virtual void DtAssistantRtiexecCompInfoMsg::setHostNameSize ( unsigned long size )

protectedvirtual

Set/Get rtiexec host name size.

virtual void DtAssistantRtiexecCompInfoMsg::setIsConnected ( bool connected )

virtual

Set whether or not the rtiexec has successfully connected to a forwarder.

virtual void DtAssistantRtiexecCompInfoMsg::setLicServer ( const MAKRti::DtString & server )

virtual

Set the license server used by the rtiexec.

virtual void DtAssistantRtiexecCompInfoMsg::setLicServerSize ( unsigned long size )

protectedvirtual

Set/Get license server size.

virtual void DtAssistantRtiexecCompInfoMsg::setLogFilename ( const MAKRti::DtFilename & filename )

virtual

Set component log filename.

virtual void DtAssistantRtiexecCompInfoMsg::setLogFilenameSize ( unsigned long size )

protectedvirtual

Set/Get log filename size.

virtual void DtAssistantRtiexecCompInfoMsg::setNotifyLevel ( DtNotifyLevelType level )

virtual

Set notify level.

virtual void DtAssistantRtiexecCompInfoMsg::setTcpAddress ( const MAKRti::DtInetAddr & ipAddr )

virtual

Set TCP forwarder IP address.

virtual void DtAssistantRtiexecCompInfoMsg::setTcpIfAddress ( const MAKRti::DtInetAddr & ipAddr )

virtual

Set TCP interface IP address.

virtual void DtAssistantRtiexecCompInfoMsg::setTcpPort ( int port )

virtual

Set forwarder TCP port number.

virtual void DtAssistantRtiexecCompInfoMsg::setUdpAddress ( const MAKRti::DtInetAddr & ipAddr )

virtual

Set best effort IP address.

virtual void DtAssistantRtiexecCompInfoMsg::setUdpIfAddress ( const MAKRti::DtInetAddr & ipAddr )

virtual

Set UDP interface IP address.

virtual void DtAssistantRtiexecCompInfoMsg::setUdpPort ( int port )

virtual

Set forwarder UDP port number.

virtual MAKRti::DtInetAddr DtAssistantRtiexecCompInfoMsg::tcpAddress ( ) const

virtual

Get TCP forwarder IP address.

virtual MAKRti::DtInetAddr DtAssistantRtiexecCompInfoMsg::tcpIfAddress ( ) const

virtual

Get TCP interface IP address.

virtual int DtAssistantRtiexecCompInfoMsg::tcpPort ( ) const

virtual

Get forwarder TCP port number.

virtual MAKRti::DtInetAddr DtAssistantRtiexecCompInfoMsg::udpAddress ( ) const

virtual

Get best effort IP address.

virtual MAKRti::DtInetAddr DtAssistantRtiexecCompInfoMsg::udpIfAddress ( ) const

virtual

Get UDP interface IP address.

virtual int DtAssistantRtiexecCompInfoMsg::udpPort ( ) const

virtual

Get forwarder UDP port number.

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

assistantRtiexecCompInfoMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation