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

Inheritance diagram for DtAssistantLrcCompInfoMsg:

Collaboration diagram for DtAssistantLrcCompInfoMsg:

Public Member Functions
	DtAssistantLrcCompInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors. More...

	DtAssistantLrcCompInfoMsg (const DtNetAssistantLrcCompInfoMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)

virtual	~DtAssistantLrcCompInfoMsg ()
	Destructor. More...

virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this. More...

virtual void	setTcpAddress (const MAKRti::DtInetAddr &ipOrHost)
	Set the RTI TCP IP address (used for reliable). More...

virtual MAKRti::DtInetAddr	tcpAddress () const
	Get the RTI TCP IP address (reliable ). More...

virtual void	setTcpPort (int port)
	Set the RTI TCP port number. More...

virtual int	tcpPort () const
	Get the RTI TCP port number. More...

virtual void	setTcpInterface (const MAKRti::DtInetAddr &addr)
	Set the address of the network interface being used for TCP. More...

virtual MAKRti::DtInetAddr	tcpInterface () const
	Get the address of the interface being used for TCP. More...

virtual void	setUdpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set the RTI UDP IP address (used for best effort). More...

virtual MAKRti::DtInetAddr	udpAddress () const
	Get the RTI UDP IP address (best effort). More...

virtual void	setUdpPort (int port)
	Set the RTI UDP port number. More...

virtual int	udpPort () const
	Get the RTI UDP port number. More...

virtual void	setUdpInterface (const MAKRti::DtInetAddr &addr)
	Set the address of the network interface being used for UDP. More...

virtual MAKRti::DtInetAddr	udpInterface () const
	Get the address of the interface being used for UDP. More...

virtual void	setUseRtiexec (bool val)
	Set whether LRC is using an rtiexec. More...

virtual bool	useRtiexec () const
	Get whether LRC is using an rtiexec. More...

virtual void	setIsNetStatsEnabled (bool val)
	Set whether LRC has net stats enabled. More...

virtual bool	isNetStatsEnabled () const
	Get whether LRC's net stats are enabled. More...

virtual void	setFullCompliance (bool val)
	Set whether LRC is fully compliant. More...

virtual bool	fullCompliance () const
	Get whether LRC is fully compliant. More...

virtual void	setHlaVersion (DtHlaVersionId val)
	Set HLA version. More...

virtual DtHlaVersionId	hlaVersion () const
	Get HLA version. More...

virtual void	setLogFilename (const MAKRti::DtFilename &filename)
	Set component log filename. More...

virtual MAKRti::DtFilename	logFilename () const
	Get component log filename. More...

virtual void	setNotifyLevel (DtNotifyLevelType level)
	Set notify level. More...

virtual DtNotifyLevelType	notifyLevel () const
	Get notify level. More...

virtual void	setName (const MAKRti::DtString &name)
	Set LRC component name. More...

virtual void	setFederateName (const MAKRti::DtString &fedName)
	Set Federate Name. More...

virtual void	setProcessName (const MAKRti::DtString &processName)
	Set process name. More...

virtual void	setProcessId (unsigned long processId)
	Set the process ID. More...

virtual void	setCommandArgs (const MAKRti::DtString &commandArgs)
	Set the command arguments. More...

virtual MAKRti::DtString	name () const
	Get LRC component name. More...

virtual MAKRti::DtString	federateName () const
	Get Federate Name. More...

virtual MAKRti::DtString	processName () const
	Get process name. More...

virtual unsigned long	processId () const
	Get process ID. More...

virtual MAKRti::DtString	commandArgs () const
	Get command arguments. More...

virtual void	setFederateHandle (unsigned long handle)
	Set LRC federate handle. More...

virtual unsigned long	federateHandle () const
	Get LRC federate handle. More...

virtual void	setFederationHandle (unsigned long handle)
	Set LRC's federation handle. More...

virtual unsigned long	federationHandle () const
	Get LRC's federation handle. More...

virtual void	setFederationName (const MAKRti::DtString &name)
	Set LRC's federation name. More...

virtual MAKRti::DtString	federationName () const
	Get LRC's federation name. More...

virtual void	setLicServer (const MAKRti::DtString &server)
	Set the license server used by the component. More...

virtual MAKRti::DtString	licServer () const
	Get LRC license server. More...

virtual void	setForwarderPort (int port)
	Set the forwarder port. More...

virtual int	forwarderPort () const
	Get the forwarder port. More...

virtual void	printData () const
	Print the data section. More...

Public Member Functions inherited from DtAssistantMsg
virtual	~DtAssistantMsg ()
	Destructor. More...

virtual DtNetAssistantMsgHeader *	netHeader () const
	Get header of network representation. More...

virtual int	version () const
	Return the message version. More...

virtual bool	isValidVersion () const
	Returns bool: message version is valid? More...

virtual DtAssistantMsgKind	msgKind () const
	Get the message kind. More...

virtual void	print () const
	Printing functions. More...

virtual void	printHeader () const

virtual void	printSrcDest () const

virtual bool	isOk () const
	Message is good? More...

bool	isAssistantToAssistantMessage () const
	Returns whether or not this message contains source/destination information included in messages sent between assistants. More...

virtual MAKRti::DtInetAddr	sourceAddr () const
	Get/Set the IP address of the source of this message. More...

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

virtual int	sourceId () const
	Get/Set the ID of the source of this message. More...

virtual void	setSourceId (int id)

virtual MAKRti::DtString	sourceHost () const
	Get/Set the host name of the source of this message. More...

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

virtual MAKRti::DtInetAddr	destAddr () const
	Get/Set the IP address of the destination of this message. More...

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

virtual int	destId () const
	Get/Set the ID of the destination of this message. More...

virtual void	setDestId (int id)

virtual int	compId () const
	Get/Set the related component's connection ID. More...

virtual void	setCompId (int compId)

virtual const DtAssistantUuid &	sourceUuid () const
	Get/Set the uuid of the source of this message. More...

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. More...

virtual void	setIsForeign (bool isForeignDestination)

virtual DtU32	sequence () const
	Get/Set sequence number Assistant-to-Assistant messages only. More...

virtual void	setSequence (DtU32 sequenceNumber)

Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators. More...

static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)

static void	addCallback (DtRtiAssistantServer conn, DtAssistantLrcCompInfoCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type. More...

static void	removeCallback (DtRtiAssistantServer conn, DtAssistantLrcCompInfoCb 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. More...

Protected Member Functions
virtual void	setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily fam)
	Set the IP address family. More...

virtual MAKRti::DtInetUtils::DtInetAddrFamily	addressFamily () const
	Get the IP address family. More...

virtual DtNetAssistantLrcCompInfoMsg *	netAssistantLrcCompInfoMsg ()
	The network representation for the component information. More...

virtual const DtNetAssistantLrcCompInfoMsg *	netAssistantLrcCompInfoMsg () const

virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantLrcCompInfoMsg message. More...

virtual int	minSize () const
	Returns minimum size of a message, including header. More...

virtual void	setLogFilenameSize (unsigned long size)
	Set/Get log filename size. More...

virtual unsigned long	logFilenameSize () const

virtual const char *	logFilenamePtr () const
	Return pointer to filename location in message. More...

virtual char *	logFilenamePtr ()

virtual void	setNameSize (unsigned long size)
	Set/Get component name size. More...

virtual unsigned long	nameSize () const

virtual const char *	namePtr () const
	Return pointer to component name location in message. More...

virtual char *	namePtr ()

virtual void	setFederateNameSize (unsigned long size)
	Set/Get federate name size. More...

virtual unsigned long	federateNameSize () const

virtual const char *	federateNamePtr () const
	Return pointer to federate name location in mesage. More...

virtual char *	federateNamePtr ()

virtual void	setProcessNameSize (unsigned long size)
	set/get process name size More...

virtual unsigned long	processNameSize () const

virtual const char *	processNamePtr () const
	Return pointer to process name location in message. More...

virtual char *	processNamePtr ()

virtual void	setCommandArgsSize (unsigned long size)
	set/get command args size More...

virtual unsigned long	commandArgsSize () const

virtual const char *	commandArgsPtr () const
	Return pointer to command args location in the message. More...

virtual char *	commandArgsPtr ()

virtual void	setLicServerSize (unsigned long size)
	Set/Get license server size. More...

virtual unsigned long	licServerSize () const

virtual const char *	licServerPtr () const
	Return pointer to license server location in message. More...

virtual char *	licServerPtr ()

virtual void	setFederationNameSize (unsigned long size)
	Set/Get the federation name size. More...

virtual unsigned long	federationNameSize () const

virtual const char *	federationNamePtr () const
	Return pointer to the federation name location in message. More...

virtual char *	federationNamePtr ()

Protected Member Functions inherited from DtAssistantMsg
	DtAssistantMsg ()
	Constructor. More...

virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes. More...

void	initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual. More...

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. More...

virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated address. More...

virtual void	resizeForSrcDestInfo ()
	Allocates memory at the end of the message for source/destination information needed when sending messages between assistants. More...

virtual const DtNetAssistantSrcDestInfo *	srcDestInfoPtr () const
	Return pointer to source/destination information in the message. More...

virtual DtNetAssistantSrcDestInfo *	srcDestInfoPtr ()

virtual void	setSourceHostSize (unsigned long size)
	Set/Get source host name text size. More...

virtual unsigned long	sourceHostSize () const

virtual const char *	sourceHostPtr () const
	Return pointer to source host name in message. More...

virtual char *	sourceHostPtr ()

Detailed Description

The DtAssistantLrcCompInfoMsg defines a wrapper for the RTI Assistant component information message used to send information about an LRC component to its connected RTI Assistant.

Constructor & Destructor Documentation

DtAssistantLrcCompInfoMsg::DtAssistantLrcCompInfoMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

DtAssistantLrcCompInfoMsg::DtAssistantLrcCompInfoMsg	(	const DtNetAssistantLrcCompInfoMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

virtual DtAssistantLrcCompInfoMsg::~DtAssistantLrcCompInfoMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtAssistantLrcCompInfoMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantLrcCompInfoCb	cb,
		void *	usr
	)

static

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

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

protectedvirtual

Get the IP address family.

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

virtual

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

Implements DtAssistantMsg.

virtual MAKRti::DtString DtAssistantLrcCompInfoMsg::commandArgs ( ) const

virtual

Get command arguments.

virtual const char* DtAssistantLrcCompInfoMsg::commandArgsPtr ( ) const

protectedvirtual

Return pointer to command args location in the message.

virtual char* DtAssistantLrcCompInfoMsg::commandArgsPtr ( )

protectedvirtual

virtual unsigned long DtAssistantLrcCompInfoMsg::commandArgsSize ( ) const

protectedvirtual

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

static

Creators.

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

static

virtual unsigned long DtAssistantLrcCompInfoMsg::federateHandle ( ) const

virtual

Get LRC federate handle.

virtual MAKRti::DtString DtAssistantLrcCompInfoMsg::federateName ( ) const

virtual

Get Federate Name.

virtual const char* DtAssistantLrcCompInfoMsg::federateNamePtr ( ) const

protectedvirtual

Return pointer to federate name location in mesage.

virtual char* DtAssistantLrcCompInfoMsg::federateNamePtr ( )

protectedvirtual

virtual unsigned long DtAssistantLrcCompInfoMsg::federateNameSize ( ) const

protectedvirtual

virtual unsigned long DtAssistantLrcCompInfoMsg::federationHandle ( ) const

virtual

Get LRC's federation handle.

virtual MAKRti::DtString DtAssistantLrcCompInfoMsg::federationName ( ) const

virtual

Get LRC's federation name.

virtual const char* DtAssistantLrcCompInfoMsg::federationNamePtr ( ) const

protectedvirtual

Return pointer to the federation name location in message.

virtual char* DtAssistantLrcCompInfoMsg::federationNamePtr ( )

protectedvirtual

virtual unsigned long DtAssistantLrcCompInfoMsg::federationNameSize ( ) const

protectedvirtual

virtual int DtAssistantLrcCompInfoMsg::forwarderPort ( ) const

virtual

Get the forwarder port.

virtual bool DtAssistantLrcCompInfoMsg::fullCompliance ( ) const

virtual

Get whether LRC is fully compliant.

virtual DtHlaVersionId DtAssistantLrcCompInfoMsg::hlaVersion ( ) const

virtual

Get HLA version.

virtual DtAssistantMsgKind DtAssistantLrcCompInfoMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantLrcCompInfoMsg message.

Implements DtAssistantMsg.

virtual bool DtAssistantLrcCompInfoMsg::isNetStatsEnabled ( ) const

virtual

Get whether LRC's net stats are enabled.

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

virtual

Get LRC license server.

virtual const char* DtAssistantLrcCompInfoMsg::licServerPtr ( ) const

protectedvirtual

Return pointer to license server location in message.

virtual char* DtAssistantLrcCompInfoMsg::licServerPtr ( )

protectedvirtual

virtual unsigned long DtAssistantLrcCompInfoMsg::licServerSize ( ) const

protectedvirtual

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

virtual

Get component log filename.

virtual const char* DtAssistantLrcCompInfoMsg::logFilenamePtr ( ) const

protectedvirtual

Return pointer to filename location in message.

virtual char* DtAssistantLrcCompInfoMsg::logFilenamePtr ( )

protectedvirtual

virtual unsigned long DtAssistantLrcCompInfoMsg::logFilenameSize ( ) const

protectedvirtual

virtual int DtAssistantLrcCompInfoMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual MAKRti::DtString DtAssistantLrcCompInfoMsg::name ( ) const

virtual

Get LRC component name.

virtual const char* DtAssistantLrcCompInfoMsg::namePtr ( ) const

protectedvirtual

Return pointer to component name location in message.

virtual char* DtAssistantLrcCompInfoMsg::namePtr ( )

protectedvirtual

virtual unsigned long DtAssistantLrcCompInfoMsg::nameSize ( ) const

protectedvirtual

virtual DtNetAssistantLrcCompInfoMsg* DtAssistantLrcCompInfoMsg::netAssistantLrcCompInfoMsg ( )

protectedvirtual

The network representation for the component information.

virtual const DtNetAssistantLrcCompInfoMsg* DtAssistantLrcCompInfoMsg::netAssistantLrcCompInfoMsg ( ) const

protectedvirtual

virtual DtNotifyLevelType DtAssistantLrcCompInfoMsg::notifyLevel ( ) const

virtual

Get notify level.

virtual void DtAssistantLrcCompInfoMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

virtual unsigned long DtAssistantLrcCompInfoMsg::processId ( ) const

virtual

Get process ID.

virtual MAKRti::DtString DtAssistantLrcCompInfoMsg::processName ( ) const

virtual

Get process name.

virtual const char* DtAssistantLrcCompInfoMsg::processNamePtr ( ) const

protectedvirtual

Return pointer to process name location in message.

virtual char* DtAssistantLrcCompInfoMsg::processNamePtr ( )

protectedvirtual

virtual unsigned long DtAssistantLrcCompInfoMsg::processNameSize ( ) const

protectedvirtual

static void DtAssistantLrcCompInfoMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantLrcCompInfoCb	cb,
		void *	usr
	)

static

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

protectedvirtual

Set the IP address family.

virtual void DtAssistantLrcCompInfoMsg::setCommandArgs ( const MAKRti::DtString & commandArgs )

virtual

Set the command arguments.

virtual void DtAssistantLrcCompInfoMsg::setCommandArgsSize ( unsigned long size )

protectedvirtual

set/get command args size

virtual void DtAssistantLrcCompInfoMsg::setFederateHandle ( unsigned long handle )

virtual

Set LRC federate handle.

virtual void DtAssistantLrcCompInfoMsg::setFederateName ( const MAKRti::DtString & fedName )

virtual

Set Federate Name.

virtual void DtAssistantLrcCompInfoMsg::setFederateNameSize ( unsigned long size )

protectedvirtual

Set/Get federate name size.

virtual void DtAssistantLrcCompInfoMsg::setFederationHandle ( unsigned long handle )

virtual

Set LRC's federation handle.

virtual void DtAssistantLrcCompInfoMsg::setFederationName ( const MAKRti::DtString & name )

virtual

Set LRC's federation name.

virtual void DtAssistantLrcCompInfoMsg::setFederationNameSize ( unsigned long size )

protectedvirtual

Set/Get the federation name size.

virtual void DtAssistantLrcCompInfoMsg::setForwarderPort ( int port )

virtual

Set the forwarder port.

virtual void DtAssistantLrcCompInfoMsg::setFullCompliance ( bool val )

virtual

Set whether LRC is fully compliant.

virtual void DtAssistantLrcCompInfoMsg::setHlaVersion ( DtHlaVersionId val )

virtual

Set HLA version.

virtual void DtAssistantLrcCompInfoMsg::setIsNetStatsEnabled ( bool val )

virtual

Set whether LRC has net stats enabled.

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

virtual

Set the license server used by the component.

virtual void DtAssistantLrcCompInfoMsg::setLicServerSize ( unsigned long size )

protectedvirtual

Set/Get license server size.

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

virtual

Set component log filename.

virtual void DtAssistantLrcCompInfoMsg::setLogFilenameSize ( unsigned long size )

protectedvirtual

Set/Get log filename size.

virtual void DtAssistantLrcCompInfoMsg::setName ( const MAKRti::DtString & name )

virtual

Set LRC component name.

virtual void DtAssistantLrcCompInfoMsg::setNameSize ( unsigned long size )

protectedvirtual

Set/Get component name size.

virtual void DtAssistantLrcCompInfoMsg::setNotifyLevel ( DtNotifyLevelType level )

virtual

Set notify level.

virtual void DtAssistantLrcCompInfoMsg::setProcessId ( unsigned long processId )

virtual

Set the process ID.

virtual void DtAssistantLrcCompInfoMsg::setProcessName ( const MAKRti::DtString & processName )

virtual

Set process name.

virtual void DtAssistantLrcCompInfoMsg::setProcessNameSize ( unsigned long size )

protectedvirtual

set/get process name size

virtual void DtAssistantLrcCompInfoMsg::setTcpAddress ( const MAKRti::DtInetAddr & ipOrHost )

virtual

Set the RTI TCP IP address (used for reliable).

virtual void DtAssistantLrcCompInfoMsg::setTcpInterface ( const MAKRti::DtInetAddr & addr )

virtual

Set the address of the network interface being used for TCP.

virtual void DtAssistantLrcCompInfoMsg::setTcpPort ( int port )

virtual

Set the RTI TCP port number.

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

virtual

Set the RTI UDP IP address (used for best effort).

virtual void DtAssistantLrcCompInfoMsg::setUdpInterface ( const MAKRti::DtInetAddr & addr )

virtual

Set the address of the network interface being used for UDP.

virtual void DtAssistantLrcCompInfoMsg::setUdpPort ( int port )

virtual

Set the RTI UDP port number.

virtual void DtAssistantLrcCompInfoMsg::setUseRtiexec ( bool val )

virtual

Set whether LRC is using an rtiexec.

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

virtual

Get the RTI TCP IP address (reliable ).

virtual MAKRti::DtInetAddr DtAssistantLrcCompInfoMsg::tcpInterface ( ) const

virtual

Get the address of the interface being used for TCP.

virtual int DtAssistantLrcCompInfoMsg::tcpPort ( ) const

virtual

Get the RTI TCP port number.

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

virtual

Get the RTI UDP IP address (best effort).

virtual MAKRti::DtInetAddr DtAssistantLrcCompInfoMsg::udpInterface ( ) const

virtual

Get the address of the interface being used for UDP.

virtual int DtAssistantLrcCompInfoMsg::udpPort ( ) const

virtual

Get the RTI UDP port number.

virtual bool DtAssistantLrcCompInfoMsg::useRtiexec ( ) const

virtual

Get whether LRC is using an rtiexec.

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

assistantLrcCompInfoMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation