MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantShmCompInfoMsg Class Reference

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

+ Inheritance diagram for DtAssistantShmCompInfoMsg:
+ Collaboration diagram for DtAssistantShmCompInfoMsg:

List of all members.

Public Member Functions

 DtAssistantShmCompInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantShmCompInfoMsg (const DtNetAssistantShmCompInfoMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantShmCompInfoMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void setIpAddress (const MAKRti::DtInetAddr &ipAddr)
 Set Shm's forwarder IP address.
virtual MAKRti::DtInetAddr ipAddress () const
 Get Shm's forwarder IP address.
virtual void setPort (int port)
 Set Shm's forwarder port number.
virtual int port () const
 Get Shm's forwarder port number.
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 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, DtAssistantShmCompInfoCb cb, void *usr)
 Adds or removes a callback with the given Assistant server for this message type.
static void removeCallback (DtRtiAssistantServer *conn, DtAssistantShmCompInfoCb 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
DtNetAssistantShmCompInfoMsg
netAssistantShmCompInfoMsg ()
 The network representation for the component information.
virtual const
DtNetAssistantShmCompInfoMsg
netAssistantShmCompInfoMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantShmCompInfoMsg 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 component name location in message.
virtual char * logFilenamePtr ()

Detailed Description

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


Constructor & Destructor Documentation

DtAssistantShmCompInfoMsg::DtAssistantShmCompInfoMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

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

Referenced by clone(), and create().

DtAssistantShmCompInfoMsg::DtAssistantShmCompInfoMsg ( const DtNetAssistantShmCompInfoMsg 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 DtAssistantShmCompInfoMsgKind.

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

Get the IP address family.

References netAssistantShmCompInfoMsg().

Referenced by ipAddress().

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

Implements DtAssistantMsg.

References DtAssistantShmCompInfoMsg(), and netAssistantShmCompInfoMsg().

DtAssistantMsg * DtAssistantShmCompInfoMsg::create ( const DtNetAssistantMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
) [static]

Creators.

References DtAssistantShmCompInfoMsg().

DtAssistantMsg * DtAssistantShmCompInfoMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER) [static]

Returns the kind of a DtAssistantShmCompInfoMsg message.

Implements DtAssistantMsg.

References DtAssistantShmCompInfoMsgKind.

Referenced by DtAssistantShmCompInfoMsg().

DtInetAddr DtAssistantShmCompInfoMsg::ipAddress ( ) const [virtual]

Get Shm's forwarder IP address.

References addressFamily(), and netAssistantShmCompInfoMsg().

DtFilename DtAssistantShmCompInfoMsg::logFilename ( ) const [virtual]

Get component log filename.

References logFilenamePtr(), and logFilenameSize().

Referenced by printData().

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

Return pointer to component name location in message.

References netAssistantShmCompInfoMsg().

Referenced by logFilename(), and setLogFilename().

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

Returns minimum size of a message, including header.

Referenced by DtAssistantShmCompInfoMsg().

DtNotifyLevelType DtAssistantShmCompInfoMsg::notifyLevel ( ) const [virtual]

Get notify level.

References netAssistantShmCompInfoMsg().

Referenced by printData().

int DtAssistantShmCompInfoMsg::port ( ) const [virtual]

Get Shm's forwarder port number.

References netAssistantShmCompInfoMsg(), and DtNetAssistantShmCompInfoMsg::port.

Referenced by setPort().

void DtAssistantShmCompInfoMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References logFilename(), and notifyLevel().

void DtAssistantShmCompInfoMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily  fam) [protected, virtual]

Set the IP address family.

References DtNetAssistantShmCompInfoMsg::addressFamily, and netAssistantShmCompInfoMsg().

Referenced by setIpAddress().

void DtAssistantShmCompInfoMsg::setIpAddress ( const MAKRti::DtInetAddr &  ipAddr) [virtual]
void DtAssistantShmCompInfoMsg::setLogFilename ( const MAKRti::DtFilename &  filename) [virtual]

Set component log filename.

References rti1516e::insertBytes(), logFilenamePtr(), logFilenameSize(), and setLogFilenameSize().

void DtAssistantShmCompInfoMsg::setLogFilenameSize ( unsigned long  size) [protected, virtual]

Set/Get log filename size.

References DtNetAssistantShmCompInfoMsg::logFilenameSize, and netAssistantShmCompInfoMsg().

Referenced by setLogFilename().

void DtAssistantShmCompInfoMsg::setNotifyLevel ( DtNotifyLevelType  level) [virtual]
void DtAssistantShmCompInfoMsg::setPort ( int  port) [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)