![]() |
MAK RTIspy API Documentation for HLA 1.3
|
The DtAssistantShowDialogMsg defines a wrapper for the messages sent to and from the Assistant to deliver commands to display a dialog. More...
Inheritance diagram for DtAssistantShowDialogMsg:
Collaboration diagram for DtAssistantShowDialogMsg:Public Types | |
| enum | DtAssistantShowDialogEnum { DoNotShowDialog, ShowConnections, ShowNotificationHistory, ShowFederations, ShowNetworkComponents, ShowMessageDump } |
Public Member Functions | |
| DtAssistantShowDialogMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| DtAssistantShowDialogMsg (const DtNetAssistantShowDialogMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| DtAssistantShowDialogMsg (DtAssistantShowDialogEnum showDialog, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| virtual | ~DtAssistantShowDialogMsg () |
| Destructor. | |
| virtual DtAssistantMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. | |
| virtual void | setShowDialog (DtAssistantShowDialogEnum showDialog) |
| Get / Set the show dialog command value. | |
| virtual DtAssistantShowDialogEnum | showDialog () const |
| virtual void | printData () const |
| Print the data section. | |
Public Member Functions inherited from DtAssistantMsg | |
| virtual | ~DtAssistantMsg () |
| Destructor. | |
| virtual DtNetAssistantMsgHeader * | netHeader () 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) |
Static Public Member Functions | |
| static DtAssistantMsg * | create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creator. | |
| static DtAssistantMsg * | create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creator. | |
| static void | addCallback (DtRtiAssistantServer *conn, DtAssistantShowDialogMsgCb cb, void *usr) |
| Callback management. | |
| static void | removeCallback (DtRtiAssistantServer *conn, DtAssistantShowDialogMsgCb 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. | |
Protected Member Functions | |
| virtual DtNetAssistantShowDialogMsg * | netAssistantShowDialogMsg () |
| The network representation. | |
| virtual const DtNetAssistantShowDialogMsg * | netAssistantShowDialogMsg () const |
| virtual DtAssistantMsgKind | internalMsgKind () |
| Returns the kind of a DtAssistantShowDialogMsg Msg. | |
| virtual int | minSize () const |
| Returns minimum size of a message, including header. | |
Protected Member Functions inherited from DtAssistantMsg | |
| DtAssistantMsg () | |
| Constructor. | |
| virtual void | sizeChanged (int size) |
| Called whenever size is changed using changeSize, or insert/deleteBytes. | |
| void | initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer) |
| Called by ctor, so not virtual. | |
| 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. | |
| virtual void | adjustBytes (void *address, int numBytes) |
| Adjust the numBytes starting at the indicated address. | |
| virtual void | resizeForSrcDestInfo () |
| Allocates memory at the end of the message for source/destination information needed when sending messages between assistants. | |
| virtual const DtNetAssistantSrcDestInfo * | srcDestInfoPtr () const |
| Return pointer to source/destination information in the message. | |
| virtual DtNetAssistantSrcDestInfo * | srcDestInfoPtr () |
| virtual void | setSourceHostSize (unsigned long size) |
| Set/Get source host name text size. | |
| virtual unsigned long | sourceHostSize () const |
| virtual const char * | sourceHostPtr () const |
| Return pointer to source host name in message. | |
| virtual char * | sourceHostPtr () |
The DtAssistantShowDialogMsg defines a wrapper for the messages sent to and from the Assistant to deliver commands to display a dialog.
| DtAssistantShowDialogMsg::DtAssistantShowDialogMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructor.
References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().
| DtAssistantShowDialogMsg::DtAssistantShowDialogMsg | ( | const DtNetAssistantShowDialogMsg * | netRep, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
Constructor.
References DtNetAssistantShowDialogMsg::header, and DtAssistantMsg::initAssistantMsg().
| DtAssistantShowDialogMsg::DtAssistantShowDialogMsg | ( | DtAssistantShowDialogMsg::DtAssistantShowDialogEnum | showDialog, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), minSize(), and setShowDialog().
|
virtual |
Destructor.
|
static |
Callback management.
References DtRtiAssistantServer::addMsgCallback(), and DtAssistantShowDialogMsgKind.
Referenced by DtAssistantTrayIconMgr::DtAssistantTrayIconMgr().
|
virtual |
Return a copy/empty object of the same type as this.
Implements DtAssistantMsg.
References DtAssistantShowDialogMsg(), and netAssistantShowDialogMsg().
|
static |
Creator.
References DtAssistantShowDialogMsg().
|
static |
Creator.
References DtAssistantShowDialogMsg().
|
protectedvirtual |
Returns the kind of a DtAssistantShowDialogMsg Msg.
Implements DtAssistantMsg.
References DtAssistantShowDialogMsgKind.
Referenced by DtAssistantShowDialogMsg().
|
protectedvirtual |
Returns minimum size of a message, including header.
Referenced by DtAssistantShowDialogMsg().
|
protectedvirtual |
The network representation.
Referenced by clone(), setShowDialog(), and showDialog().
|
protectedvirtual |
|
virtual |
|
static |
References DtAssistantShowDialogMsgKind, and DtRtiAssistantServer::removeMsgCallback().
Referenced by DtAssistantTrayIconMgr::~DtAssistantTrayIconMgr().
|
virtual |
Get / Set the show dialog command value.
References netAssistantShowDialogMsg(), DtNetAssistantShowDialogMsg::showDialog, and showDialog().
Referenced by DtAssistantShowDialogMsg(), and DtRtiAssistantToAssistantClient::sendShowDialogMsg().
|
virtual |
References netAssistantShowDialogMsg(), and DtNetAssistantShowDialogMsg::showDialog.
Referenced by printData(), DtAssistantTrayIconMgr::processShowDialogMsg(), and setShowDialog().