MAK RTIspy API Documentation for HLA Evolved
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantLrcCompInfoMsg Class Reference

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:

List of all members.

Public Member Functions

 DtAssistantLrcCompInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantLrcCompInfoMsg (const DtNetAssistantLrcCompInfoMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantLrcCompInfoMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void setIpAddress (const MAKRti::DtInetAddr &ipOrHost)
 Set the RTI reliable IP address.
virtual MAKRti::DtInetAddr ipAddress () const
 Get the RTI reliable IP address.
virtual void setBestEffortIpAddress (const MAKRti::DtInetAddr &ipAddr)
 Set the RTI best effort IP address.
virtual MAKRti::DtInetAddr bestEffortIpAddress () const
 Get the RTI best effort IP address.
virtual void setNetworkInterfaceAddress (const MAKRti::DtInetAddr &addr)
 Set the address of the network interface being used.
virtual MAKRti::DtInetAddr networkInterfaceAddress () const
 Get the address of the network interface being used.
virtual void setUdpPort (int port)
 Set the RTI UDP port number.
virtual int udpPort () const
 Get the RTI UDP port number.
virtual void setTcpPort (int port)
 Set the RTI TCP port number.
virtual int tcpPort () const
 Get the RTI TCP port number.
virtual void setUseRtiexec (bool val)
 Set whether LRC is using an rtiexec.
virtual bool useRtiexec () const
 Get whether LRC is using an rtiexec.
virtual void setFullCompliance (bool val)
 Set whether LRC is fully compliant.
virtual bool fullCompliance () const
 Get whether LRC is fully compliant.
virtual void setHlaVersion (DtHlaVersionId val)
 Set HLA version.
virtual DtHlaVersionId hlaVersion () const
 Get HLA version.
virtual void setWebSpyIpAddress (const MAKRti::DtInetAddr &ipAddr)
 Set the web spy host IP address.
virtual MAKRti::DtInetAddr webSpyIpAddress () const
 Get the web spy host IP address.
virtual void setWebSpyPort (int port)
 Set the web spy port number.
virtual int webSpyPort () const
 Get the web spy port number.
virtual void setWebSpyId (int id)
 Set the web spy ID.
virtual int webSpyId () const
 Get the web spy ID.
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 setName (const MAKRti::DtString &name)
 Set LRC component name.
virtual void setFederateName (const MAKRti::DtString &fedName)
 Set Federate Name.
virtual void setProcessName (const MAKRti::DtString &processName)
 Set process name.
virtual void setProcessId (unsigned long processId)
 Set the process ID.
virtual void setCommandArgs (const MAKRti::DtString &commandArgs)
 Set the command arguments.
virtual MAKRti::DtString name () const
 Get LRC component name.
virtual MAKRti::DtString federateName () const
 Get Federate Name.
virtual MAKRti::DtString processName () const
 Get process name.
virtual unsigned long processId () const
 Get process ID.
virtual MAKRti::DtString commandArgs () const
 Get command arguments.
virtual void setFederateHandle (unsigned long handle)
 Set LRC federate handle.
virtual unsigned long federateHandle () const
 Get LRC federate handle.
virtual void setFederationHandle (unsigned long handle)
 Set LRC's federation handle.
virtual unsigned long federationHandle () const
 Get LRC's federation handle.
virtual void setFederationName (const MAKRti::DtString &name)
 Set LRC's federation name.
virtual MAKRti::DtString federationName () const
 Get LRC's federation name.
virtual void setLicServer (const MAKRti::DtString &server)
 Set the license server used by the component.
virtual MAKRti::DtString licServer () const
 Get LRC license server.
virtual void setForwarderPort (int port)
 Set the forwarder port.
virtual int forwarderPort () const
 Get the forwarder port.
virtual void printData () const
 Print the data section.

Static Public Member Functions

static DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators.
static DtAssistantMsgcreate (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.
static void removeCallback (DtRtiAssistantServer *conn, DtAssistantLrcCompInfoCb cb, void *usr)

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
DtNetAssistantLrcCompInfoMsg
netAssistantLrcCompInfoMsg ()
 The network representation for the component information.
virtual const
DtNetAssistantLrcCompInfoMsg
netAssistantLrcCompInfoMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantLrcCompInfoMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual void setLogFilenameSize (unsigned long size)
 Set/Get log filename size.
virtual unsigned long logFilenameSize () const
virtual const char * logFilenamePtr () const
 Return pointer to filename location in message.
virtual char * logFilenamePtr ()
virtual void setNameSize (unsigned long size)
 Set/Get component name size.
virtual unsigned long nameSize () const
virtual const char * namePtr () const
 Return pointer to component name location in message.
virtual char * namePtr ()
virtual void setFederateNameSize (unsigned long size)
 Set/Get federate name size.
virtual unsigned long federateNameSize () const
virtual const char * federateNamePtr () const
 Return pointer to federate name location in mesage.
virtual char * federateNamePtr ()
virtual void setProcessNameSize (unsigned long size)
 set/get process name size
virtual unsigned long processNameSize () const
virtual const char * processNamePtr () const
 Return pointer to process name location in message.
virtual char * processNamePtr ()
virtual void setCommandArgsSize (unsigned long size)
 set/get command args size
virtual unsigned long commandArgsSize () const
virtual const char * commandArgsPtr () const
 Return pointer to command args location in the message.
virtual char * commandArgsPtr ()
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 ()
virtual void setFederationNameSize (unsigned long size)
 Set/Get the federation name size.
virtual unsigned long federationNameSize () const
virtual const char * federationNamePtr () const
 Return pointer to the federation name location in message.
virtual char * federationNamePtr ()

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.

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

Referenced by clone(), and create().

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

Destructor.


Member Function Documentation

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantLrcCompInfoMsgKind.

Referenced by DtAssistantComponentMgr::DtAssistantComponentMgr().

DtInetUtils::DtInetAddrFamily DtAssistantLrcCompInfoMsg::addressFamily ( ) const [protected, virtual]

Get the IP address family.

References netAssistantLrcCompInfoMsg().

Referenced by bestEffortIpAddress(), ipAddress(), and networkInterfaceAddress().

DtInetAddr DtAssistantLrcCompInfoMsg::bestEffortIpAddress ( ) const [virtual]

Get the RTI best effort IP address.

References addressFamily(), and netAssistantLrcCompInfoMsg().

Referenced by printData(), and DtAssistantComponentMgr::processLrcCompInfoMsg().

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

Implements DtAssistantMsg.

References DtAssistantLrcCompInfoMsg(), and netAssistantLrcCompInfoMsg().

DtString DtAssistantLrcCompInfoMsg::commandArgs ( ) const [virtual]

Get command arguments.

References commandArgsPtr(), and commandArgsSize().

Referenced by DtAssistantComponentMgr::processLrcCompInfoMsg().

const char * DtAssistantLrcCompInfoMsg::commandArgsPtr ( ) const [protected, virtual]

Return pointer to command args location in the message.

References processNamePtr(), and processNameSize().

Referenced by commandArgs(), licServerPtr(), and setCommandArgs().

char * DtAssistantLrcCompInfoMsg::commandArgsPtr ( ) [protected, virtual]
unsigned long DtAssistantLrcCompInfoMsg::commandArgsSize ( ) const [protected, virtual]
DtAssistantMsg * DtAssistantLrcCompInfoMsg::create ( const DtNetAssistantMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
) [static]

Creators.

References DtAssistantLrcCompInfoMsg().

DtAssistantMsg * DtAssistantLrcCompInfoMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER) [static]
unsigned long DtAssistantLrcCompInfoMsg::federateHandle ( ) const [virtual]
DtString DtAssistantLrcCompInfoMsg::federateName ( ) const [virtual]
const char * DtAssistantLrcCompInfoMsg::federateNamePtr ( ) const [protected, virtual]

Return pointer to federate name location in mesage.

References federationNamePtr(), and federationNameSize().

Referenced by federateName(), and setFederateName().

char * DtAssistantLrcCompInfoMsg::federateNamePtr ( ) [protected, virtual]
unsigned long DtAssistantLrcCompInfoMsg::federateNameSize ( ) const [protected, virtual]
unsigned long DtAssistantLrcCompInfoMsg::federationHandle ( ) const [virtual]
DtString DtAssistantLrcCompInfoMsg::federationName ( ) const [virtual]

Get LRC's federation name.

References federationNamePtr(), and federationNameSize().

Referenced by printData(), and DtAssistantComponentMgr::processLrcCompInfoMsg().

const char * DtAssistantLrcCompInfoMsg::federationNamePtr ( ) const [protected, virtual]

Return pointer to the federation name location in message.

References licServerPtr(), and licServerSize().

Referenced by federateNamePtr(), federationName(), and setFederationName().

char * DtAssistantLrcCompInfoMsg::federationNamePtr ( ) [protected, virtual]

References licServerPtr(), and licServerSize().

unsigned long DtAssistantLrcCompInfoMsg::federationNameSize ( ) const [protected, virtual]

Returns the kind of a DtAssistantLrcCompInfoMsg message.

Implements DtAssistantMsg.

References DtAssistantLrcCompInfoMsgKind.

Referenced by DtAssistantLrcCompInfoMsg().

DtInetAddr DtAssistantLrcCompInfoMsg::ipAddress ( ) const [virtual]

Get the RTI reliable IP address.

References addressFamily(), and netAssistantLrcCompInfoMsg().

Referenced by printData(), and DtAssistantComponentMgr::processLrcCompInfoMsg().

DtString DtAssistantLrcCompInfoMsg::licServer ( ) const [virtual]

Get LRC license server.

References licServerPtr(), and licServerSize().

Referenced by printData(), and DtAssistantComponentMgr::processLrcCompInfoMsg().

const char * DtAssistantLrcCompInfoMsg::licServerPtr ( ) const [protected, virtual]

Return pointer to license server location in message.

References commandArgsPtr(), and commandArgsSize().

Referenced by federationNamePtr(), licServer(), and setLicServer().

char * DtAssistantLrcCompInfoMsg::licServerPtr ( ) [protected, virtual]
unsigned long DtAssistantLrcCompInfoMsg::licServerSize ( ) const [protected, virtual]
DtFilename DtAssistantLrcCompInfoMsg::logFilename ( ) const [virtual]

Get component log filename.

References logFilenamePtr(), and logFilenameSize().

Referenced by printData(), and DtAssistantComponentMgr::processLrcCompInfoMsg().

const char * DtAssistantLrcCompInfoMsg::logFilenamePtr ( ) const [protected, virtual]

Return pointer to filename location in message.

References netAssistantLrcCompInfoMsg().

Referenced by logFilename(), and setLogFilename().

char * DtAssistantLrcCompInfoMsg::logFilenamePtr ( ) [protected, virtual]
unsigned long DtAssistantLrcCompInfoMsg::logFilenameSize ( ) const [protected, virtual]
int DtAssistantLrcCompInfoMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantLrcCompInfoMsg().

DtString DtAssistantLrcCompInfoMsg::name ( ) const [virtual]

Get LRC component name.

References namePtr(), and nameSize().

Referenced by printData(), and DtAssistantComponentMgr::processLrcCompInfoMsg().

const char * DtAssistantLrcCompInfoMsg::namePtr ( ) const [protected, virtual]

Return pointer to component name location in message.

References logFilenameSize(), and netAssistantLrcCompInfoMsg().

Referenced by name(), and setName().

char * DtAssistantLrcCompInfoMsg::namePtr ( ) [protected, virtual]
unsigned long DtAssistantLrcCompInfoMsg::nameSize ( ) const [protected, virtual]

Get the address of the network interface being used.

References addressFamily(), and netAssistantLrcCompInfoMsg().

Referenced by DtAssistantComponentMgr::processLrcCompInfoMsg().

DtNotifyLevelType DtAssistantLrcCompInfoMsg::notifyLevel ( ) const [virtual]
void DtAssistantLrcCompInfoMsg::printData ( ) const [virtual]
unsigned long DtAssistantLrcCompInfoMsg::processId ( ) const [virtual]
DtString DtAssistantLrcCompInfoMsg::processName ( ) const [virtual]

Get process name.

References processNamePtr(), and processNameSize().

Referenced by DtAssistantComponentMgr::processLrcCompInfoMsg().

const char * DtAssistantLrcCompInfoMsg::processNamePtr ( ) const [protected, virtual]

Return pointer to process name location in message.

References logFilenameSize(), nameSize(), and netAssistantLrcCompInfoMsg().

Referenced by commandArgsPtr(), processName(), and setProcessName().

char * DtAssistantLrcCompInfoMsg::processNamePtr ( ) [protected, virtual]
unsigned long DtAssistantLrcCompInfoMsg::processNameSize ( ) const [protected, virtual]
void DtAssistantLrcCompInfoMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily  fam) [protected, virtual]
void DtAssistantLrcCompInfoMsg::setBestEffortIpAddress ( const MAKRti::DtInetAddr &  ipAddr) [virtual]
void DtAssistantLrcCompInfoMsg::setCommandArgs ( const MAKRti::DtString &  commandArgs) [virtual]
void DtAssistantLrcCompInfoMsg::setCommandArgsSize ( unsigned long  size) [protected, virtual]

set/get command args size

References DtNetAssistantLrcCompInfoMsg::commandArgsSize, and netAssistantLrcCompInfoMsg().

Referenced by setCommandArgs().

void DtAssistantLrcCompInfoMsg::setFederateHandle ( unsigned long  handle) [virtual]
void DtAssistantLrcCompInfoMsg::setFederateName ( const MAKRti::DtString &  fedName) [virtual]
void DtAssistantLrcCompInfoMsg::setFederateNameSize ( unsigned long  size) [protected, virtual]

Set/Get federate name size.

References DtNetAssistantLrcCompInfoMsg::federateNameSize, and netAssistantLrcCompInfoMsg().

Referenced by setFederateName().

void DtAssistantLrcCompInfoMsg::setFederationHandle ( unsigned long  handle) [virtual]
void DtAssistantLrcCompInfoMsg::setFederationName ( const MAKRti::DtString &  name) [virtual]
void DtAssistantLrcCompInfoMsg::setFederationNameSize ( unsigned long  size) [protected, virtual]

Set/Get the federation name size.

References DtNetAssistantLrcCompInfoMsg::federationNameSize, and netAssistantLrcCompInfoMsg().

Referenced by setFederationName().

void DtAssistantLrcCompInfoMsg::setForwarderPort ( int  port) [virtual]
void DtAssistantLrcCompInfoMsg::setIpAddress ( const MAKRti::DtInetAddr &  ipOrHost) [virtual]
void DtAssistantLrcCompInfoMsg::setLicServer ( const MAKRti::DtString &  server) [virtual]

Set the license server used by the component.

References rti1516e::insertBytes(), licServerPtr(), licServerSize(), and setLicServerSize().

Referenced by DtRtiAssistantLrcClient::sendClientInfo().

void DtAssistantLrcCompInfoMsg::setLicServerSize ( unsigned long  size) [protected, virtual]

Set/Get license server size.

References DtNetAssistantLrcCompInfoMsg::licServerSize, and netAssistantLrcCompInfoMsg().

Referenced by setLicServer().

void DtAssistantLrcCompInfoMsg::setLogFilename ( const MAKRti::DtFilename &  filename) [virtual]
void DtAssistantLrcCompInfoMsg::setLogFilenameSize ( unsigned long  size) [protected, virtual]

Set/Get log filename size.

References DtNetAssistantLrcCompInfoMsg::logFilenameSize, and netAssistantLrcCompInfoMsg().

Referenced by setLogFilename().

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

Set LRC component name.

References rti1516e::insertBytes(), namePtr(), nameSize(), and setNameSize().

Referenced by DtRtiAssistantLrcClient::sendClientInfo().

void DtAssistantLrcCompInfoMsg::setNameSize ( unsigned long  size) [protected, virtual]

Set/Get component name size.

References DtNetAssistantLrcCompInfoMsg::nameSize, and netAssistantLrcCompInfoMsg().

Referenced by setName().

void DtAssistantLrcCompInfoMsg::setNetworkInterfaceAddress ( const MAKRti::DtInetAddr &  addr) [virtual]
void DtAssistantLrcCompInfoMsg::setNotifyLevel ( DtNotifyLevelType  level) [virtual]
void DtAssistantLrcCompInfoMsg::setProcessId ( unsigned long  processId) [virtual]
void DtAssistantLrcCompInfoMsg::setProcessName ( const MAKRti::DtString &  processName) [virtual]
void DtAssistantLrcCompInfoMsg::setProcessNameSize ( unsigned long  size) [protected, virtual]

set/get process name size

References netAssistantLrcCompInfoMsg(), and DtNetAssistantLrcCompInfoMsg::processNameSize.

Referenced by setProcessName().

void DtAssistantLrcCompInfoMsg::setTcpPort ( int  port) [virtual]
void DtAssistantLrcCompInfoMsg::setUdpPort ( int  port) [virtual]

Set whether LRC is using an rtiexec.

References netAssistantLrcCompInfoMsg(), and DtNetAssistantLrcCompInfoMsg::useRtiexec.

Referenced by DtRtiAssistantLrcClient::sendClientInfo().

void DtAssistantLrcCompInfoMsg::setWebSpyId ( int  id) [virtual]
void DtAssistantLrcCompInfoMsg::setWebSpyIpAddress ( const MAKRti::DtInetAddr &  ipAddr) [virtual]
void DtAssistantLrcCompInfoMsg::setWebSpyPort ( int  port) [virtual]
int DtAssistantLrcCompInfoMsg::tcpPort ( ) const [virtual]
int DtAssistantLrcCompInfoMsg::udpPort ( ) const [virtual]
int DtAssistantLrcCompInfoMsg::webSpyId ( ) const [virtual]
DtInetAddr DtAssistantLrcCompInfoMsg::webSpyIpAddress ( ) const [virtual]

Get the web spy host IP address.

References netAssistantLrcCompInfoMsg().

Referenced by printData(), and DtAssistantComponentMgr::processLrcCompInfoMsg().

int DtAssistantLrcCompInfoMsg::webSpyPort ( ) const [virtual]

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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)