VR-Exchange 2.2 API Documentation
List of all members | Public Member Functions | Static Public Member Functions | Static Public Attributes
DtPortalTimeMgmtObject Class Reference

Represents the current time state of the HLA broker. More...

Inheritance diagram for DtPortalTimeMgmtObject:
Inheritance graph
[legend]

Public Member Functions

 DtPortalTimeMgmtObject ()
 Constructor.
virtual ~DtPortalTimeMgmtObject ()
 Destructor.
 DtPortalTimeMgmtObject (const DtPortalTimeMgmtObject &)
 Copy constructor.
DtPortalTimeMgmtObjectoperator= (const DtPortalTimeMgmtObject &original)
 Assignment operator.
int operator== (const DtPortalTimeMgmtObject &rightOperand) const
 Compare operator.
int operator!= (const DtPortalTimeMgmtObject &rightOperand) const
 Compare operator.
virtual const char * objectKindName () const
 Returns a string representation of this object's type.
virtual unsigned int netSize () const
 Returns the network size of this object.
virtual void writeSelfToBuffer (void *buffer) const
 Writes this message into the memory buffer provided by buffer.
virtual void readSelfFromBuffer (const void *buffer)
 Fills in values in this message from the byte array specified by buffer.
virtual std::ostream & printDataToStream (std::ostream &stream) const
 Prints the current state of this message to the stream specified by str.
virtual
MAKVrExchange::DtPortalMessageKind 
kind () const
 Returns the message kind of this object.
Data Exchange Attributes

The Attributes of the Time Management State Object

 DtDEC_ATTRIBUTE (DtFloat64, Lbts, lbts)
 The Entity identifier of the Host Object.
- Public Member Functions inherited from MAKVrExchange::DtPortalBaseObject
 DtPortalBaseObject ()
 The Default CTOR.
virtual ~DtPortalBaseObject ()
 The Default DTOR.
 DtPortalBaseObject (const DtPortalBaseObject &other)
 The default Copy CTOR.
DtPortalBaseObjectoperator= (const DtPortalBaseObject &other)
 The default Assignment operator.
bool operator!= (const DtPortalBaseObject &other) const
bool operator== (const DtPortalBaseObject &other) const
virtual void setKind (DtPortalMessageKind kind)
virtual void setObjectKindName (const char *name)
virtual void setAttributeValuePairList (const DtAttributeValuePairList &val)
virtual const
DtAttributeValuePairList
attributeValuePairList () const
virtual DtAttributeValuePairListattributeValuePairList ()
- Public Member Functions inherited from MAKVrExchange::DtPortalObject
 DtPortalObject ()
virtual ~DtPortalObject ()
 DtPortalObject (const DtPortalObject &other)
DtPortalObjectoperator= (const DtPortalObject &other)
bool operator!= (const DtPortalObject &other) const
bool operator== (const DtPortalObject &other) const
virtual bool isFiltered () const
 NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.
virtual void setFiltered (bool value)
 DtDEC_ATTRIBUTE (DtString, Identifier, identifier)
 Every object must have a unique Identifier which is of type string.
 DtDEC_ATTRIBUTE (bool, FinalMessage, finalMessage)
 If true this is the final message for this object, and the object has been deleted.
- 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 Public Attributes

static const
MAKVrExchange::DtPortalMessageKind 
theKind
 Unique ID for for each subclass of DtPortalMessage.
- Static Public Attributes inherited from MAKVrExchange::DtPortalBaseObject
static const DtPortalMessageKind theKind

Additional Inherited Members

- 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::DtPortalBaseObject
DtAttributeValuePairList myAttributeValuePairList
DtPortalMessageKind myMessageKind
DtString myObjectName

Detailed Description

Represents the current time state of the HLA broker.

Constructor & Destructor Documentation

DtPortalTimeMgmtObject::DtPortalTimeMgmtObject ( )

Constructor.

Referenced by create().

virtual DtPortalTimeMgmtObject::~DtPortalTimeMgmtObject ( )
virtual

Destructor.

DtPortalTimeMgmtObject::DtPortalTimeMgmtObject ( const DtPortalTimeMgmtObject )

Copy constructor.

Used for pass-by-value, explicit copy, and return by value.

Member Function Documentation

DtPortalTimeMgmtObject& DtPortalTimeMgmtObject::operator= ( const DtPortalTimeMgmtObject original)

Assignment operator.

int DtPortalTimeMgmtObject::operator== ( const DtPortalTimeMgmtObject rightOperand) const

Compare operator.

int DtPortalTimeMgmtObject::operator!= ( const DtPortalTimeMgmtObject rightOperand) const

Compare operator.

const char * DtPortalTimeMgmtObject::objectKindName ( ) const
inlinevirtual

Returns a string representation of this object's type.

This is used by the GUI to print the kind of object.

Reimplemented from MAKVrExchange::DtPortalBaseObject.

virtual unsigned int DtPortalTimeMgmtObject::netSize ( ) const
virtual

Returns the network size of this object.

The network size is the number of bytes needed to store this message in memory.

Reimplemented from MAKVrExchange::DtPortalBaseObject.

virtual void DtPortalTimeMgmtObject::writeSelfToBuffer ( void *  buffer) const
virtual

Writes this message into the memory buffer provided by buffer.

The Buffer must already be allocated and be at least netSize() bytes big.

Reimplemented from MAKVrExchange::DtPortalBaseObject.

virtual void DtPortalTimeMgmtObject::readSelfFromBuffer ( const void *  buffer)
virtual

Fills in values in this message from the byte array specified by buffer.

Buffer must be at least as big as netSize() bytes.

Reimplemented from MAKVrExchange::DtPortalBaseObject.

virtual std::ostream& DtPortalTimeMgmtObject::printDataToStream ( std::ostream &  str) const
virtual

Prints the current state of this message to the stream specified by str.

Reimplemented from MAKVrExchange::DtPortalBaseObject.

MAKVrExchange::DtPortalMessage * DtPortalTimeMgmtObject::create ( )
inlinestatic
MAKVrExchange::DtPortalMessageKind DtPortalTimeMgmtObject::kind ( ) const
inlinevirtual

Returns the message kind of this object.

The message Kind is unique integer. The kind is unique to all messages. Existing message kinds can be found in pMessageKinds.h

Reimplemented from MAKVrExchange::DtPortalBaseObject.

References theKind.

DtPortalTimeMgmtObject::DtDEC_ATTRIBUTE ( DtFloat64  ,
Lbts  ,
lbts   
)

The Entity identifier of the Host Object.

Member Data Documentation

const MAKVrExchange::DtPortalMessageKind DtPortalTimeMgmtObject::theKind
static

Unique ID for for each subclass of DtPortalMessage.

Note: Must be public.

Referenced by kind().


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)