MAK RTIspy API Documentation for HLA 1516
List of all members | Public Member Functions
DtAssistantFederateRespMsg Class Reference

The DtAssistantFederateRespMsg defines the RTI Assistant message used by one Assistant to respond to a request from another Assistant for information on any federates that match the specified criteria. More...

+ Inheritance diagram for DtAssistantFederateRespMsg:
+ Collaboration diagram for DtAssistantFederateRespMsg:

Public Member Functions

 DtASTNT_DECLARE_STANDARD_MSG_METHODS (DtAssistantFederateRespMsg) DtASTNT_DECLARE_PEER_CALLBACK_METHODS(DtAssistantFederateRespMsg) DtDECLARE_UNSIGNED_PARAMETER_METHODS(UdpPort
 DtDECLARE_UNSIGNED_PARAMETER_METHODS (TcpPort, 16) DtDECLARE_UNSIGNED_PARAMETER_METHODS(ReliableAddressFamily
 DtDECLARE_UNSIGNED_PARAMETER_METHODS (BestEffortAddressFamily, 32) DtDECLARE_INET_ADDR_PARAMETER_METHODS(ReliableIpAddress) DtDECLARE_INET_ADDR_PARAMETER_METHODS(BestEffortIpAddress) DtDECLARE_UNSIGNED_PARAMETER_METHODS(ForwarderPort
 DtDECLARE_BOOL_PARAMETER_METHODS (UseRtiexec) DtDECLARE_UNSIGNED_PARAMETER_METHODS(Pad1
 DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS (NumFederates, 16) DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS(FederateTypesLength
 DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS (FederateNamesLength, 16) DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS(FederateProcessesLength
 DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS (FederationNamesLength, 16) DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS(LbtsStringsLength
 DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS (LookaheadStringsLength, 16) DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS(TimeStringsLength
 DtDECLARE_UNSIGNED_ARRAY_PARAMETER_METHODS (FederateHandles, 32, 16) DtDECLARE_INT_ARRAY_PARAMETER_METHODS(CompIds
 DtDECLARE_ENUMERATION_ARRAY_PARAMETER_METHODS (HlaVersions, DtHlaVersionId, 16, 16) DtDECLARE_BOOL_ARRAY_PARAMETER_METHODS(IsConstrained
 DtDECLARE_BOOL_ARRAY_PARAMETER_METHODS (IsRegulating, 16) DtDECLARE_BOOL_ARRAY_PARAMETER_METHODS(AreStatsAvailable
 DtDECLARE_STRING_ARRAY_PARAMETER_METHODS (FederateTypes, 16) DtDECLARE_STRING_ARRAY_PARAMETER_METHODS(FederateNames
 DtDECLARE_STRING_ARRAY_PARAMETER_METHODS (FederateProcesses, 16) DtDECLARE_STRING_ARRAY_PARAMETER_METHODS(FederationNames
 DtDECLARE_STRING_ARRAY_PARAMETER_METHODS (LbtsStrings, 16) DtDECLARE_STRING_ARRAY_PARAMETER_METHODS(LookaheadStrings
- Public Member Functions inherited from DtAssistantTemplateMsg
virtual ~DtAssistantTemplateMsg ()
 Destructor.
unsigned addParameter (DtRtiBaseMsgParam *param)
 Adds a new parameter to this message.
virtual void printData () const
 Print the data section. Message parameters must be created first.
- Public Member Functions inherited from DtAssistantMsg
virtual ~DtAssistantMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const =0
 Return a copy/empty object of the same type as this.
virtual DtNetAssistantMsgHeadernetHeader () 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)

Additional Inherited Members

- 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 inherited from DtAssistantTemplateMsg
 DtAssistantTemplateMsg (DtAssistantMsgKind msgKind)
 Constructor.
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of this message.
virtual int minSize () const
 Returns minimum size of a message, including header.
- Protected Attributes inherited from DtAssistantTemplateMsg
DtNetAssistantMsgHeaderParammyHeaderParam
 The parameter which points to the message header.
std::vector< DtRtiBaseMsgParam * > myMsgParams
 The list of other message parameters.
DtAssistantMsgKind myMsgKind
 The message kind.
int myMinSize
 The minimum size needed for this message.

Detailed Description

The DtAssistantFederateRespMsg defines the RTI Assistant message used by one Assistant to respond to a request from another Assistant for information on any federates that match the specified criteria.

Member Function Documentation

DtAssistantFederateRespMsg::DtASTNT_DECLARE_STANDARD_MSG_METHODS ( DtAssistantFederateRespMsg  )
DtAssistantFederateRespMsg::DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS ( NumFederates  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS ( FederateNamesLength  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS ( FederationNamesLength  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_ARRAY_SIZE_PARAMETER_METHODS ( LookaheadStringsLength  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_BOOL_ARRAY_PARAMETER_METHODS ( IsRegulating  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_BOOL_PARAMETER_METHODS ( UseRtiexec  )
DtAssistantFederateRespMsg::DtDECLARE_ENUMERATION_ARRAY_PARAMETER_METHODS ( HlaVersions  ,
DtHlaVersionId  ,
16  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_STRING_ARRAY_PARAMETER_METHODS ( FederateTypes  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_STRING_ARRAY_PARAMETER_METHODS ( FederateProcesses  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_STRING_ARRAY_PARAMETER_METHODS ( LbtsStrings  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_UNSIGNED_ARRAY_PARAMETER_METHODS ( FederateHandles  ,
32  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_UNSIGNED_PARAMETER_METHODS ( TcpPort  ,
16   
)
DtAssistantFederateRespMsg::DtDECLARE_UNSIGNED_PARAMETER_METHODS ( BestEffortAddressFamily  ,
32   
)

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

Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)