VR-Exchange 2.2 API Documentation
List of all members | Public Types | Public Member Functions | Static Public Member Functions
MAKVrExchange::DtTranslationDiagnosticMessage Class Reference

Used by brokers to report translation diagnostic reports. More...

Inheritance diagram for MAKVrExchange::DtTranslationDiagnosticMessage:
Inheritance graph
[legend]

Public Types

typedef
DtPortalControlMessageTemplate
< DtTranslationDiagnosticMessageKind
BaseClassType
typedef void(* TranslationDebuggingMessageCallbackType )(const DtTranslationDiagnosticMessage &message, void *userData)
- Public Types inherited from MAKVrExchange::DtPortalControlMessageTemplate< DtTranslationDiagnosticMessageKind >
typedef void(* DtPortalControlMessageCb )(const DtPortalControlMessageTemplate< V_MessageKind > &msg, void *usr)
- Public Types inherited from MAKVrExchange::DtPortalControlMessage
typedef void(* MessageCbFcn )(const DtPortalMessage &message, void *usr)

Public Member Functions

 DtTranslationDiagnosticMessage ()
 DtTranslationDiagnosticMessage (const DtTranslationDiagnosticMessage &m)
virtual ~DtTranslationDiagnosticMessage ()
DtTranslationDiagnosticMessageoperator= (const DtTranslationDiagnosticMessage &m)
virtual unsigned int netSize () const
 Returns the network size of this message in bytes.
virtual void writeSelfToBuffer (void *buffer) const
 Writes this message to a buffer of size netSize()
virtual void readSelfFromBuffer (const void *buffer)
 Reads and sets values for this message from the buffer passed.
virtual std::ostream & printDataToStream (std::ostream &stream) const
 Prints the internal state of this message to the stream passed.
Attributes
 DtDEC_ATTRIBUTE (DtString, ObjectName, objectName)
 The name of the object being translated.
 DtDEC_ATTRIBUTE (DtString, IncomingState, incomingState)
 The incoming state (before translation).
 DtDEC_ATTRIBUTE (DtString, OutgoingState, outgoingState)
 The outgoing state (after translation).
- Public Member Functions inherited from MAKVrExchange::DtPortalControlMessageTemplate< DtTranslationDiagnosticMessageKind >
 DtPortalControlMessageTemplate ()
virtual ~DtPortalControlMessageTemplate ()
virtual DtPortalMessageKind kind () const
 Returns the message kind, and is required for all subclasses of DtPortalMessage.
- Public Member Functions inherited from MAKVrExchange::DtPortalControlMessage
 DtPortalControlMessage ()
 The Default CTOR.
virtual ~DtPortalControlMessage ()
 The Default DTOR.
 DtPortalControlMessage (const DtPortalControlMessage &original)
 The Default Copy CTOR.
 DtDEC_ATTRIBUTE (DtString, BrokerName, brokerName)
 The name of the broker sending the message.
 DtDEC_ATTRIBUTE (DtU32, BrokerId, brokerId)
 The broker ID - Use Determined by message type.
- Public Member Functions inherited from MAKVrExchange::DtPortalMessage
 DtPortalMessage ()
 The default CTOR.
virtual ~DtPortalMessage ()
 The default DTOR.
 DtPortalMessage (const DtPortalMessage &other)
 Copy CTOR, this class is copyable.
DtPortalMessageoperator= (const DtPortalMessage &other)
 Assignment Operator, this class is copyable.
virtual unsigned int serialNumber () const
 Returns a unique identifier for this message.
virtual DtU32 sendingBrokerId () const
 Returns the ID of the sending broker.
virtual DtTime timeSent () const
 The Time that the message was sent.
virtual DtTime timeReceived () const
 The time that this message was received.
virtual void setTimeSent (const DtTime &tm) const
 This method should be considered private and not be used.
virtual void setTimeReceived (const DtTime &tm) const
 This method should be considered private and not be used.
virtual void setSendingBrokerId (const DtU32 &id) const
 This method should be considered private and not be used.
virtual void setSerialNumber (unsigned int i) const
 This method should be considered private and not be used.

Static Public Member Functions

static DtPortalMessagecreate ()
static void addCallback (DtPortalConnection *connection, TranslationDebuggingMessageCallbackType callbackFunction, void *userData)
static void removeCallback (DtPortalConnection *connection, TranslationDebuggingMessageCallbackType callbackFunction, void *userData)
- Static Public Member Functions inherited from MAKVrExchange::DtPortalControlMessageTemplate< DtTranslationDiagnosticMessageKind >
static void addCallback (DtPortalConnection *pConn, DtPortalControlMessageCb cb, void *usr)
static void removeCallback (DtPortalConnection *pConn, DtPortalControlMessageCb cb, void *usr)

Additional Inherited Members

- Static Public Attributes inherited from MAKVrExchange::DtPortalControlMessageTemplate< DtTranslationDiagnosticMessageKind >
static const DtPortalMessageKind theKind
- Protected Member Functions inherited from MAKVrExchange::DtPortalMessage
char * encode (const DtString &val, char *buffer) const
char * encode (const DtU8 &val, char *buffer) const
char * encode (const DtU16 &val, char *buffer) const
char * encode (const DtU32 &val, char *buffer) const
char * encode (const DtU64 &val, char *buffer) const
char * encode (const DtFloat32 &val, char *buffer) const
char * encode (const DtFloat64 &val, char *buffer) const
char * encode (const DtVector &val, char *buffer) const
char * encode (const DtTaitBryan &val, char *buffer) const
char * encode (const bool &val, char *buffer) const
char * encode (const std::vector< char > &val, char *buffer) const
char * encode (const std::vector< DtU16 > &val, char *buffer) const
char * encode (const std::vector< DtU32 > &val, char *buffer) const
char * encode (const DtAttributeValuePairList &val, char *buffer) const
char * encode (const std::vector< DtString > &val, char *buffer) const
char * encode (const DtSilentAggregateArray &val, char *buffer) const
char * encode (const DtSilentEntityArray &val, char *buffer) const
char * encode (const DtVariableLengthData &val, char *buffer) const
char * encode (const DtAttributeValuePair &val, char *buffer) const
char * encode (const DtFixedLengthData &value, char *buffer) const
char * encode (const DtFixedLengthDataArray &value, char *buffer) const
char * encode (const DtAggregateVariableDatum &val, char *buffer) const
char * encode (const DtAggregateVariableDatumArray &val, char *buffer) const
char * encode (const DtEmitterBeamData &data, char *buffer) const
char * encode (const DtEmitterBeamList &container, char *buffer) const
char * encode (const DtEntityIdentifier &value, char *buffer) const
char * encode (const DtEntityType &value, char *buffer) const
char * encode (const DtArticulatedPartCollection &value, char *buffer) const
char * encode (const DtAttachedPartCollection &value, char *buffer) const
char * encode (const DtIffAtcNavaidsAltParm4 &value, char *buffer) const
const char * decode (DtString &val, const char *buffer) const
const char * decode (DtU8 &val, const char *buffer) const
const char * decode (DtU16 &val, const char *buffer) const
const char * decode (DtU32 &val, const char *buffer) const
const char * decode (DtU64 &val, const char *buffer) const
const char * decode (DtFloat32 &val, const char *buffer) const
const char * decode (DtFloat64 &val, const char *buffer) const
const char * decode (DtVector &val, const char *buffer) const
const char * decode (DtTaitBryan &val, const char *buffer) const
const char * decode (bool &val, const char *buffer) const
const char * decode (std::vector< char > &val, const char *buffer) const
const char * decode (std::vector< DtU16 > &val, const char *buffer) const
const char * decode (std::vector< DtU32 > &val, const char *buffer) const
const char * decode (DtAttributeValuePairList &val, const char *buffer) const
const char * decode (std::vector< DtString > &val, const char *buffer) const
const char * decode (DtSilentAggregateArray &val, const char *buffer) const
const char * decode (DtSilentEntityArray &val, const char *buffer) const
const char * decode (DtVariableLengthData &val, const char *buffer) const
const char * decode (DtAttributeValuePair &val, const char *buffer) const
const char * decode (DtFixedLengthData &value, const char *buffer) const
const char * decode (DtFixedLengthDataArray &value, const char *buffer) const
const char * decode (DtAggregateVariableDatum &val, const char *buffer) const
const char * decode (DtAggregateVariableDatumArray &val, const char *buffer) const
const char * decode (DtEmitterBeamData &data, const char *buffer) const
const char * decode (DtEmitterBeamList &container, const char *buffer) const
const char * decode (DtEntityIdentifier &value, const char *buffer) const
const char * decode (DtEntityType &value, const char *buffer) const
const char * decode (DtArticulatedPartCollection &value, const char *buffer) const
const char * decode (DtAttachedPartCollection &value, const char *buffer) const
const char * decode (DtIffAtcNavaidsAltParm4 &value, const char *buffer) const
int getSize (const DtString &val) const
int getSize (const DtVector &v) const
int getSize (const DtU8 &v) const
int getSize (const DtU16 &v) const
int getSize (const DtU32 &v) const
int getSize (const DtU64 &v) const
int getSize (const DtFloat32 &v) const
int getSize (const DtFloat64 &v) const
int getSize (const bool &v) const
int getSize (const DtTaitBryan &v) const
int getSize (const std::vector< char > &v) const
int getSize (const std::vector< DtU16 > &v) const
int getSize (const std::vector< DtU32 > &v) const
int getSize (const DtAttributeValuePairList &v) const
int getSize (const std::vector< DtString > &v) const
int getSize (const DtSilentAggregateArray &v) const
int getSize (const DtSilentEntityArray &v) const
int getSize (const DtVariableLengthData &v) const
int getSize (const DtAttributeValuePair &v) const
int getSize (const DtFixedLengthData &value) const
int getSize (const DtFixedLengthDataArray &value) const
int getSize (const DtAggregateVariableDatum &v) const
int getSize (const DtAggregateVariableDatumArray &v) const
int getSize (const DtEmitterBeamData &data) const
int getSize (const DtEmitterBeamList &container) const
int getSize (const DtEntityIdentifier &value) const
int getSize (const DtEntityType &value) const
int getSize (const DtArticulatedPartCollection &value) const
int getSize (const DtAttachedPartCollection &value) const
int getSize (const DtIffAtcNavaidsAltParm4 &value) const
- Protected Attributes inherited from MAKVrExchange::DtPortalMessage
DtU32 myMutableSerialNumber
 mutable because it can be set by the PConnection.
DtU32 myMutableSendingBrokerId
 mutable because it can be set by the PConnection.
DtTime myMutableSentTimeStamp
 mutable because it can be set by the PConnection.
DtTime myMutableReceivedTimeStamp
 mutable because it can be set by the PConnection.

Detailed Description

Used by brokers to report translation diagnostic reports.

These reports are similar in form to the translator debugging output.

Member Typedef Documentation

typedef void(* MAKVrExchange::DtTranslationDiagnosticMessage::TranslationDebuggingMessageCallbackType)(const DtTranslationDiagnosticMessage &message, void *userData)

Constructor & Destructor Documentation

MAKVrExchange::DtTranslationDiagnosticMessage::DtTranslationDiagnosticMessage ( )
MAKVrExchange::DtTranslationDiagnosticMessage::DtTranslationDiagnosticMessage ( const DtTranslationDiagnosticMessage m)
virtual MAKVrExchange::DtTranslationDiagnosticMessage::~DtTranslationDiagnosticMessage ( )
virtual

Member Function Documentation

static DtPortalMessage* MAKVrExchange::DtTranslationDiagnosticMessage::create ( )
static
DtTranslationDiagnosticMessage& MAKVrExchange::DtTranslationDiagnosticMessage::operator= ( const DtTranslationDiagnosticMessage m)
virtual unsigned int MAKVrExchange::DtTranslationDiagnosticMessage::netSize ( ) const
virtual

Returns the network size of this message in bytes.

Reimplemented from MAKVrExchange::DtPortalControlMessage.

virtual void MAKVrExchange::DtTranslationDiagnosticMessage::writeSelfToBuffer ( void *  buffer) const
virtual

Writes this message to a buffer of size netSize()

Reimplemented from MAKVrExchange::DtPortalControlMessage.

virtual void MAKVrExchange::DtTranslationDiagnosticMessage::readSelfFromBuffer ( const void *  buffer)
virtual

Reads and sets values for this message from the buffer passed.

Reimplemented from MAKVrExchange::DtPortalControlMessage.

virtual std::ostream& MAKVrExchange::DtTranslationDiagnosticMessage::printDataToStream ( std::ostream &  str) const
virtual

Prints the internal state of this message to the stream passed.

Reimplemented from MAKVrExchange::DtPortalControlMessage.

static void MAKVrExchange::DtTranslationDiagnosticMessage::addCallback ( DtPortalConnection connection,
TranslationDebuggingMessageCallbackType  callbackFunction,
void *  userData 
)
static
static void MAKVrExchange::DtTranslationDiagnosticMessage::removeCallback ( DtPortalConnection connection,
TranslationDebuggingMessageCallbackType  callbackFunction,
void *  userData 
)
static
MAKVrExchange::DtTranslationDiagnosticMessage::DtDEC_ATTRIBUTE ( DtString  ,
ObjectName  ,
objectName   
)

The name of the object being translated.

MAKVrExchange::DtTranslationDiagnosticMessage::DtDEC_ATTRIBUTE ( DtString  ,
IncomingState  ,
incomingState   
)

The incoming state (before translation).

MAKVrExchange::DtTranslationDiagnosticMessage::DtDEC_ATTRIBUTE ( DtString  ,
OutgoingState  ,
outgoingState   
)

The outgoing state (after translation).


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

Document ID: Generated on Mon Apr 15 17:15:50 EDT 2013 from SVN revision 126154
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)