![]() |
VR-Exchange 2.6 API Documentation
|
DtPortalObject are messages which also serve as state repositories for simulated objects. More...

Public Member Functions | |
| DtPortalObject (DtPortalMessageKind kind, const DtString &name) | |
| CTOR. | |
| DtPortalObject (const DtPortalObject &other) | |
| Copy CTOR. | |
| virtual | ~DtPortalObject () |
| Virtual DTOR. | |
| virtual DtPortalObject & | operator= (const DtPortalObject &other) |
| Assignment operator. | |
| virtual unsigned int | netSize () const |
| NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected. | |
| virtual void | writeSelfToBuffer (void *buffer, int bufferSize) const |
| Writes this message into the memory buffer provided by buffer. | |
| virtual void | readSelfFromBuffer (const void *buffer, int bufferSize) |
| Reads this message from the memory buffer into this object. | |
| virtual std::ostream & | printDataToStream (std::ostream &str) const |
| Prints the current state of this message to the stream specified by str. | |
Equality operators. | |
| virtual bool | operator== (const DtPortalObject &other) const |
| virtual bool | operator!= (const DtPortalObject &other) const |
Data Exchange Attributes | |
| DtDEC_ATTRIBUTE (DtString, Name, name) | |
| Message Name attribute. | |
| 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. | |
| DtDEC_ATTRIBUTE (bool, Filtered, isFiltered) | |
| Indicates whether this object is filtered (not to be published). | |
| DtDEC_ATTRIBUTE (DtAttributeValuePairList, AttributeValuePairList, attributeValuePairList) | |
| The Attribute Value Pair List for the class. | |
| DtDEC_ATTRIBUTE (bool, IsUpdated, isUpdated) | |
| Indicates whether this object has been updated. | |
Additional Inherited Members | |
| int | getSize (const std::pair< T1, T2 > &value) const |
| char * | encode (const std::pair< T1, T2 > &value, char *buffer, int &bufferSize) const |
| const char * | decode (std::pair< T1, T2 > &value, const char *buffer, int &bufferSize) const |
| int | getSize (const std::list< T > &value) const |
| char * | encode (const std::list< T > &value, char *buffer, int &bufferSize) const |
| const char * | decode (std::list< T > &value, const char *buffer, int &bufferSize) const |
| int | getSize (const std::vector< T > &value) const |
| char * | encode (const std::vector< T > &value, char *buffer, int &bufferSize) const |
| const char * | decode (std::vector< T > &value, const char *buffer, int &bufferSize) const |
| int | getSize (const std::map< T1, T2 > &value) const |
| char * | encode (const std::map< T1, T2 > &value, char *buffer, int &bufferSize) const |
| const char * | decode (std::map< T1, T2 > &value, const char *buffer, int &bufferSize) const |
DtPortalObject are messages which also serve as state repositories for simulated objects.
All DtPortalObjects can be marked as final, meaning the object is to be destroyed. All instances also have a unique identifier.
| MAKVrExchange::DtPortalObject::DtPortalObject | ( | DtPortalMessageKind | kind, |
| const DtString & | name | ||
| ) |
CTOR.
| MAKVrExchange::DtPortalObject::DtPortalObject | ( | const DtPortalObject & | other | ) |
Copy CTOR.
|
virtual |
Virtual DTOR.
| MAKVrExchange::DtPortalObject::DtDEC_ATTRIBUTE | ( | DtString | , |
| Name | , | ||
| name | |||
| ) |
Message Name attribute.
Message Name is a string representation of this object's type. This is used by the GUI to print the kind of object.
| MAKVrExchange::DtPortalObject::DtDEC_ATTRIBUTE | ( | DtString | , |
| Identifier | , | ||
| identifier | |||
| ) |
Every object must have a unique Identifier which is of type string.
This method sets that identifier.
| MAKVrExchange::DtPortalObject::DtDEC_ATTRIBUTE | ( | bool | , |
| FinalMessage | , | ||
| finalMessage | |||
| ) |
If true this is the final message for this object, and the object has been deleted.
| MAKVrExchange::DtPortalObject::DtDEC_ATTRIBUTE | ( | bool | , |
| Filtered | , | ||
| isFiltered | |||
| ) |
Indicates whether this object is filtered (not to be published).
| MAKVrExchange::DtPortalObject::DtDEC_ATTRIBUTE | ( | DtAttributeValuePairList | , |
| AttributeValuePairList | , | ||
| attributeValuePairList | |||
| ) |
The Attribute Value Pair List for the class.
| MAKVrExchange::DtPortalObject::DtDEC_ATTRIBUTE | ( | bool | , |
| IsUpdated | , | ||
| isUpdated | |||
| ) |
Indicates whether this object has been updated.
Note: This method is not published, it is for internal publishing logic.
|
virtual |
NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.
Reimplemented from MAKVrExchange::DtPortalMessage.
Reimplemented in MAKVrExchange::DtPortalVrfAggregate, MAKVrExchange::DtPortalEntity, MAKVrExchange::DtPortalIffObject, MAKVrExchange::DtPortalBaseEntity, MAKVrExchange::DtPortalPointObject, MAKVrExchange::DtPortalDiGuy, MAKVrExchange::DtPortalAggregate, MAKVrExchange::DtPortalArealObject, MAKVrExchange::DtPortalAirMission, MAKVrExchange::DtPortalEmitterSystemObject, MAKVrExchange::DtPortalEnvironmentProcessObject, MAKVrExchange::DtPortalDesignatorObject, MAKVrExchange::DtPortalBeFacilityAirbase, MAKVrExchange::DtPortalRadioTransmitterObject, MAKVrExchange::DtPortalVrfBackEndObject, MAKVrExchange::DtPortalGriddedDataObject, MAKVrExchange::DtPortalActiveSonar, MAKVrExchange::DtPortalBeFacility, MAKVrExchange::DtPortalBasicEncyclopedia, MAKVrExchange::DtPortalBeDmpi, DtPortalFruit, MAKVrExchange::DtPortalPropulsionNoiseObject, MAKVrExchange::DtPortalEnvironmentObject, MAKVrExchange::DtPortalAdditionalPassiveActivitiesObject, MAKVrExchange::DtPortalEmbeddedSystem, MAKVrExchange::DtPortalGenericObject, MAKVrExchange::DtPortalRadioReceiverObject, DtPortalTimeMgmtObject, MAKVrExchange::DtPortalLinearObject, and MAKVrExchange::DtPortalUnderwaterAcousticObject.
|
virtual |
|
virtual |
Assignment operator.
|
virtual |
|
virtual |
Prints the current state of this message to the stream specified by str.
Objects which add attributes must override this method to print them.
Reimplemented from MAKVrExchange::DtPortalMessage.
Reimplemented in MAKVrExchange::DtPortalVrfAggregate, MAKVrExchange::DtPortalEntity, MAKVrExchange::DtPortalIffObject, MAKVrExchange::DtPortalBaseEntity, MAKVrExchange::DtPortalPointObject, MAKVrExchange::DtPortalDiGuy, MAKVrExchange::DtPortalAggregate, MAKVrExchange::DtPortalArealObject, MAKVrExchange::DtPortalAirMission, MAKVrExchange::DtPortalEmitterSystemObject, MAKVrExchange::DtPortalEnvironmentProcessObject, MAKVrExchange::DtPortalDesignatorObject, MAKVrExchange::DtPortalBeFacilityAirbase, MAKVrExchange::DtPortalRadioTransmitterObject, MAKVrExchange::DtPortalVrfBackEndObject, MAKVrExchange::DtPortalGriddedDataObject, MAKVrExchange::DtPortalActiveSonar, MAKVrExchange::DtPortalBeFacility, DtPortalFruit, MAKVrExchange::DtPortalBasicEncyclopedia, MAKVrExchange::DtPortalBeDmpi, MAKVrExchange::DtPortalPropulsionNoiseObject, MAKVrExchange::DtPortalEnvironmentObject, MAKVrExchange::DtPortalAdditionalPassiveActivitiesObject, MAKVrExchange::DtPortalEmbeddedSystem, MAKVrExchange::DtPortalGenericObject, MAKVrExchange::DtPortalRadioReceiverObject, DtPortalTimeMgmtObject, MAKVrExchange::DtPortalLinearObject, and MAKVrExchange::DtPortalUnderwaterAcousticObject.
|
virtual |
Reads this message from the memory buffer into this object.
The buffer must be initialized and be at least netSize() bytes long. Objects which add attributes must override this method to read them.
Reimplemented from MAKVrExchange::DtPortalMessage.
Reimplemented in MAKVrExchange::DtPortalVrfAggregate, MAKVrExchange::DtPortalEntity, MAKVrExchange::DtPortalIffObject, MAKVrExchange::DtPortalBaseEntity, MAKVrExchange::DtPortalPointObject, MAKVrExchange::DtPortalDiGuy, MAKVrExchange::DtPortalAggregate, MAKVrExchange::DtPortalArealObject, MAKVrExchange::DtPortalAirMission, MAKVrExchange::DtPortalEmitterSystemObject, MAKVrExchange::DtPortalEnvironmentProcessObject, MAKVrExchange::DtPortalDesignatorObject, MAKVrExchange::DtPortalBeFacilityAirbase, MAKVrExchange::DtPortalRadioTransmitterObject, MAKVrExchange::DtPortalVrfBackEndObject, MAKVrExchange::DtPortalGriddedDataObject, MAKVrExchange::DtPortalActiveSonar, MAKVrExchange::DtPortalBeFacility, DtPortalFruit, MAKVrExchange::DtPortalBasicEncyclopedia, MAKVrExchange::DtPortalBeDmpi, MAKVrExchange::DtPortalPropulsionNoiseObject, MAKVrExchange::DtPortalEnvironmentObject, MAKVrExchange::DtPortalAdditionalPassiveActivitiesObject, MAKVrExchange::DtPortalEmbeddedSystem, MAKVrExchange::DtPortalGenericObject, MAKVrExchange::DtPortalRadioReceiverObject, DtPortalTimeMgmtObject, MAKVrExchange::DtPortalLinearObject, and MAKVrExchange::DtPortalUnderwaterAcousticObject.
|
virtual |
Writes this message into the memory buffer provided by buffer.
The buffer must already be allocated and be at least netSize() bytes long. Objects which add attributes must override this method to write them.
Reimplemented from MAKVrExchange::DtPortalMessage.
Reimplemented in MAKVrExchange::DtPortalVrfAggregate, MAKVrExchange::DtPortalEntity, MAKVrExchange::DtPortalIffObject, MAKVrExchange::DtPortalBaseEntity, MAKVrExchange::DtPortalPointObject, MAKVrExchange::DtPortalDiGuy, MAKVrExchange::DtPortalAggregate, MAKVrExchange::DtPortalArealObject, MAKVrExchange::DtPortalAirMission, MAKVrExchange::DtPortalEmitterSystemObject, MAKVrExchange::DtPortalEnvironmentProcessObject, MAKVrExchange::DtPortalDesignatorObject, MAKVrExchange::DtPortalBeFacilityAirbase, MAKVrExchange::DtPortalRadioTransmitterObject, MAKVrExchange::DtPortalVrfBackEndObject, MAKVrExchange::DtPortalGriddedDataObject, MAKVrExchange::DtPortalActiveSonar, MAKVrExchange::DtPortalBeFacility, DtPortalFruit, MAKVrExchange::DtPortalBasicEncyclopedia, MAKVrExchange::DtPortalBeDmpi, MAKVrExchange::DtPortalPropulsionNoiseObject, MAKVrExchange::DtPortalEnvironmentObject, MAKVrExchange::DtPortalAdditionalPassiveActivitiesObject, MAKVrExchange::DtPortalEmbeddedSystem, MAKVrExchange::DtPortalGenericObject, MAKVrExchange::DtPortalRadioReceiverObject, DtPortalTimeMgmtObject, MAKVrExchange::DtPortalLinearObject, and MAKVrExchange::DtPortalUnderwaterAcousticObject.