 |
MAK RTIspy API Documentation for HLA 4
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
MAK RTIspy API Documentation for HLA 4
|
DtAssistantTemplateMsg defines a base class which can be subclassed to quickly produce a new Assistant messages based on templates and macros. More...
Inheritance diagram for DtAssistantTemplateMsg: Collaboration diagram for DtAssistantTemplateMsg:Public Member Functions | |
| virtual | ~DtAssistantTemplateMsg () |
| Destructor. More... | |
| unsigned | addParameter (DtRtiBaseMsgParam *param) |
| Adds a new parameter to this message. More... | |
| virtual void | printData () const |
| Print the data section. Message parameters must be created first. More... | |
| Public Member Functions inherited from DtAssistantMsg | |
| virtual | ~DtAssistantMsg () |
| Destructor. More... | |
| virtual DtAssistantMsg * | clone (bool copy=true) const =0 |
| Return a copy/empty object of the same type as this. 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) |
Protected Member Functions | |
| DtAssistantTemplateMsg (DtAssistantMsgKind msgKind) | |
| Constructor. More... | |
| virtual DtAssistantMsgKind | internalMsgKind () |
| Returns the kind of this message. More... | |
| virtual int | minSize () const |
| Returns minimum size of a message, including header. More... | |
| 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 () |
Protected Attributes | |
| DtNetAssistantMsgHeaderParam * | myHeaderParam |
| The parameter which points to the message header. More... | |
| std::vector< DtRtiBaseMsgParam * > | myMsgParams |
| The list of other message parameters. More... | |
| DtAssistantMsgKind | myMsgKind |
| The message kind. More... | |
| int | myMinSize |
| The minimum size needed for this message. More... | |
Friends | |
| class | DtNetAssistantMsgHeaderParam |
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. More... | |
DtAssistantTemplateMsg defines a base class which can be subclassed to quickly produce a new Assistant messages based on templates and macros.
To produce a new message class: 1) Declare your class a subclass of DtRtiTemplateMsg. 2) In your class definition use DtASTNT_DECLARE_STANDARD_MSG_METHODS. 3) In your class definition use at least one of the DtASTNT_DECLARE_*_CALLBACK_METHODS macros. 4) In your class definition use the parameter declaration macros defined in rtiTemplateMsgParams.h or any of the other template param files to declare your template parameters. 5) In your .cxx file use DtDEFINE_STANDARD_MSG_METHODS. 6) In your .cxx file use use at least one of the DtASTNT_DEFINE_*_CALLBACK_METHODS macros. 7) In your .cxx file, define a method of your class void addAllParameters() which contains calls to the macro ADD_PARAMETER (or any of the other type-specific versions) for each of your parameters. Make sure to add them in the proper order for byte alignment. The could will assert if you do not have a correct alignment. 8) In your .cxx file, use the parameter method definition macros defined in rtiTemplateMsgParams.h or any of the other template param files to define your get and set methods for each of your parameters. The unit tests for this class have several example messages. Check out testAssistantTemplateMsg.h and testAssistantTemplateMsg.cxx.
|
virtual |
Destructor.
|
protected |
Constructor.
| unsigned DtAssistantTemplateMsg::addParameter | ( | DtRtiBaseMsgParam * | param | ) |
Adds a new parameter to this message.
Returns the index of the new item in the parameter array. Parameters must be added in order. Take care to ensure proper alignment.
|
protectedvirtual |
Returns the kind of this message.
Implements DtAssistantMsg.
|
protectedvirtual |
Returns minimum size of a message, including header.
Message parameters must be created first.
|
virtual |
Print the data section. Message parameters must be created first.
Reimplemented from DtAssistantMsg.
|
friend |
|
protected |
The parameter which points to the message header.
|
protected |
The minimum size needed for this message.
|
protected |
The message kind.
|
protected |
The list of other message parameters.
