MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantShowDialogMsg Class Reference

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. More...
 
 DtAssistantShowDialogMsg (const DtNetAssistantShowDialogMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor. More...
 
 DtAssistantShowDialogMsg (DtAssistantShowDialogEnum showDialog, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 
virtual ~DtAssistantShowDialogMsg ()
 Destructor. More...
 
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this. More...
 
virtual void setShowDialog (DtAssistantShowDialogEnum showDialog)
 Get / Set the show dialog command value. More...
 
virtual DtAssistantShowDialogEnum showDialog () const
 
virtual void printData () const
 Print the data section. More...
 
- Public Member Functions inherited from DtAssistantMsg
virtual ~DtAssistantMsg ()
 Destructor. More...
 
virtual DtNetAssistantMsgHeadernetHeader () 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 DtAssistantUuidsourceUuid () 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)
 

Static Public Member Functions

static DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator. More...
 
static DtAssistantMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator. More...
 
static void addCallback (DtRtiAssistantServer *conn, DtAssistantShowDialogMsgCb cb, void *usr)
 Callback management. More...
 
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. More...
 

Protected Member Functions

virtual
DtNetAssistantShowDialogMsg
netAssistantShowDialogMsg ()
 The network representation. More...
 
virtual const
DtNetAssistantShowDialogMsg
netAssistantShowDialogMsg () const
 
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantShowDialogMsg Msg. 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 DtNetAssistantSrcDestInfosrcDestInfoPtr ()
 
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 ()
 

Detailed Description

The DtAssistantShowDialogMsg defines a wrapper for the messages sent to and from the Assistant to deliver commands to display a dialog.

Member Enumeration Documentation

Enumerator
DoNotShowDialog 
ShowConnections 
ShowNotificationHistory 
ShowFederations 
ShowNetworkComponents 
ShowMessageDump 

Constructor & Destructor Documentation

DtAssistantShowDialogMsg::DtAssistantShowDialogMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

DtAssistantShowDialogMsg::DtAssistantShowDialogMsg ( const DtNetAssistantShowDialogMsg netRep,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Constructor.

DtAssistantShowDialogMsg::DtAssistantShowDialogMsg ( DtAssistantShowDialogEnum  showDialog,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
virtual DtAssistantShowDialogMsg::~DtAssistantShowDialogMsg ( )
virtual

Destructor.

Member Function Documentation

static void DtAssistantShowDialogMsg::addCallback ( DtRtiAssistantServer conn,
DtAssistantShowDialogMsgCb  cb,
void *  usr 
)
static

Callback management.

virtual DtAssistantMsg* DtAssistantShowDialogMsg::clone ( bool  copy = true) const
virtual

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

Implements DtAssistantMsg.

static DtAssistantMsg* DtAssistantShowDialogMsg::create ( const DtNetAssistantMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
static

Creator.

static DtAssistantMsg* DtAssistantShowDialogMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static

Creator.

virtual DtAssistantMsgKind DtAssistantShowDialogMsg::internalMsgKind ( )
protectedvirtual

Returns the kind of a DtAssistantShowDialogMsg Msg.

Implements DtAssistantMsg.

virtual int DtAssistantShowDialogMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantShowDialogMsg* DtAssistantShowDialogMsg::netAssistantShowDialogMsg ( )
protectedvirtual

The network representation.

virtual const DtNetAssistantShowDialogMsg* DtAssistantShowDialogMsg::netAssistantShowDialogMsg ( ) const
protectedvirtual
virtual void DtAssistantShowDialogMsg::printData ( ) const
virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantShowDialogMsg::removeCallback ( DtRtiAssistantServer conn,
DtAssistantShowDialogMsgCb  cb,
void *  usr 
)
static
virtual void DtAssistantShowDialogMsg::setShowDialog ( DtAssistantShowDialogEnum  showDialog)
virtual

Get / Set the show dialog command value.

virtual DtAssistantShowDialogEnum DtAssistantShowDialogMsg::showDialog ( ) const
virtual

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

Document ID: Generated on Mon Sep 7 15:40:32 EDT 2020 from SVN revision 217499
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)