 |
VR-Exchange 2.1 API Documentation
|
|
VR-Exchange 2.1 API Documentation
|
Represents aggregated entity objects in a simulation. More...
Public Member Functions | |
| DtPortalAggregate () | |
| virtual | ~DtPortalAggregate () |
| DtPortalAggregate (const DtPortalAggregate &other) | |
| DtPortalAggregate & | operator= (const DtPortalAggregate &other) |
| bool | operator!= (const DtPortalAggregate &other) const |
| bool | operator== (const DtPortalAggregate &other) const |
| virtual DtPortalMessageKind | kind () const |
| Returns the message kind of this object. | |
| 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 &str) const |
| Prints the current state of this message to the stream specified by str. | |
Data Exchange Attributes | |
The Attributes of the Portal Aggregate Object | |
| DtDEC_ATTRIBUTE (DtU32, ForceId, forceId) | |
| The Force Identifier. An Enumeration. | |
| DtDEC_ATTRIBUTE (DtU32, AggregateState, aggregateState) | |
| The aggregate state. An Enumeration. | |
| DtDEC_ATTRIBUTE (DtU32, Formation, formation) | |
| The Formation of the aggregate, an enumeration. | |
| DtDEC_ATTRIBUTE (DtString, AggregateType, aggregateType) | |
| The Type of the aggregate in the form "1:1:1:1:1:1" as specified by the enumerations document. | |
| DtDEC_ATTRIBUTE (DtString, EntityIdentifier, entityIdentifer) | |
| The Aggregates Entity Identifier in the form "1:1:1". | |
| DtDEC_ATTRIBUTE (DtString, MarkingText, markingText) | |
| The Marking text of the attribute, typicaly used by SAFs. | |
| DtDEC_ATTRIBUTE (DtU32, MarkingCharacterSet, markingCharacterSet) | |
| The character set used for the marking text. | |
| DtDEC_ATTRIBUTE (DtVector, Dimensions, dimensions) | |
| The boundin box of the aggregate. | |
| DtDEC_ATTRIBUTE (std::vector< DtString >, Subaggregates, subaggregates) | |
| A vector of SubAggregate Identifiers. | |
| DtDEC_ATTRIBUTE (std::vector< DtString >, Entities, entities) | |
| A vector of Sub Entities contained in this aggregate. | |
| DtDEC_ATTRIBUTE (DtSilentAggregateArray, SilentAggregates, silentAggregates) | |
| An Array of silent aggregates. | |
| DtDEC_ATTRIBUTE (DtSilentEntityArray, SilentEntities, silentEntities) | |
| An Array of silent entities. | |
| DtDEC_ATTRIBUTE (DtAggregateVariableDatumArray, VariableDatums, variableDatums) | |
| An array of Variable datums encoded following the DIS standard. | |
 Public Member Functions inherited from MAKVrExchange::DtPortalBaseEntity | |
| DtPortalBaseEntity () | |
| The Default CTOR. | |
| virtual | ~DtPortalBaseEntity () |
| The Default DTOR. | |
| DtPortalBaseEntity (const DtPortalBaseEntity &other) | |
| The default Copy CTOR. | |
| DtPortalBaseEntity & | operator= (const DtPortalBaseEntity &other) |
| The default Assignment operator. | |
| bool | operator!= (const DtPortalBaseEntity &other) const |
| bool | operator== (const DtPortalBaseEntity &other) const |
| DtDEC_ATTRIBUTE (DtU32, Algorithm, algorithm) | |
| The DR algorithm enumeration as specified in the DIS Enumerations Document. | |
| DtDEC_ATTRIBUTE (bool, Frozen, frozen) | |
| A flag to tell if the object is frozen. | |
| DtDEC_ATTRIBUTE (DtEntityIdentifier, EntityId, entityId) | |
| The DIS Entity ID in the form of a string, if its known. | |
| DtDEC_ATTRIBUTE (DtEntityType, EntityType, entityType) | |
| Matches DIS Entity Type Requirements, in the form "1:1:1:1:1:1" as a string. | |
| DtDEC_ATTRIBUTE (DtVector, Location, location) | |
| Geocentric Coordinates as defined by the DIS Standard. | |
| DtDEC_ATTRIBUTE (DtVector, Velocity, velocity) | |
| Meters per second in Geocentric Coordinates as defined by the DIS Standard. | |
| DtDEC_ATTRIBUTE (DtVector, Acceleration, acceleration) | |
| Meters per second second in Geocentric Coordinates as defined by the DIS Standard. | |
| DtDEC_ATTRIBUTE (DtVector, RotationalVelocity, rotationalVelocity) | |
| The rotational velocity of the object as defined by the DIS Standard. | |
| DtDEC_ATTRIBUTE (DtTaitBryan, Orientation, orientation) | |
| The orientation of this object as defined by the DIS Standard. | |
| DtDEC_ATTRIBUTE (DtString, HostId, hostId) | |
| The Name of the object this object is part of. | |
| DtDEC_ATTRIBUTE (DtU32, Nature, nature) | |
| The Nature or purpose for joining the part to the host entity. | |
| DtDEC_ATTRIBUTE (DtU32, PartPosition, partPosition) | |
| Specifies the Part Position with respect to the host entity. | |
| DtDEC_ATTRIBUTE (DtU32, StationName, stationName) | |
| The station name where this entity is located in the host entity. | |
| DtDEC_ATTRIBUTE (DtU32, StationNumber, stationNumber) | |
| The number of the preticular station, or cargo hold etc. | |
| DtDEC_ATTRIBUTE (DtVector, RelativePosition, relativePosition) | |
| The relative position of this entity in regards to the host entity. | |
| DtDEC_ATTRIBUTE (DtFloat64, Range, range) | |
| The Range of this entity from the host entity. | |
| DtDEC_ATTRIBUTE (DtFloat64, Bearing, bearing) | |
| The Bearing of this entity in relation to the host entity. | |
| DtDEC_ATTRIBUTE (DtVector, RelativeLocation, relativeLocation) | |
| The RelativeLocation of the object if we are embarked or attached to another object. | |
| DtDEC_ATTRIBUTE (DtVector, RelativeVelocity, relativeVelocity) | |
| The relative velocity of this in relation to the host. | |
| DtDEC_ATTRIBUTE (DtVector, RelativeAcceleration, relativeAcceleration) | |
| The relative acceleration of this object in relation to the host. | |
| DtDEC_ATTRIBUTE (bool, RelativeFrozen, relativeFrozen) | |
| A flag to indicate the object is Frozen to the hostObject. | |
| DtDEC_ATTRIBUTE (DtU32, RelativeAlgorithm, relativeAlgorithm) | |
| An Enumeration indicating the DR algorithm to use for relative position as defined by the DIS Standard. | |
| DtDEC_ATTRIBUTE (DtVector, RelativeRotationalVelocity, relativeRotationalVelocity) | |
| The Name of the object this object is part of. | |
| DtDEC_ATTRIBUTE (DtTaitBryan, RelativeOrientation, relativeOrientation) | |
| The relative orientation of this object in relation to the host. | |
| Public Member Functions inherited from MAKVrExchange::DtPortalBaseObject | |
| DtPortalBaseObject () | |
| The Default CTOR. | |
| virtual | ~DtPortalBaseObject () |
| The Default DTOR. | |
| DtPortalBaseObject (const DtPortalBaseObject &other) | |
| The default Copy CTOR. | |
| DtPortalBaseObject & | operator= (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 DtAttributeValuePairList & | attributeValuePairList () |
| Public Member Functions inherited from MAKVrExchange::DtPortalObject | |
| DtPortalObject () | |
| virtual | ~DtPortalObject () |
| DtPortalObject (const DtPortalObject &other) | |
| DtPortalObject & | operator= (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 | |
Static Public Member Functions | |
| static DtPortalMessage * | create () |
| A creator function for this class. | |
Static Public Attributes | |
| static const DtPortalMessageKind | theKind |
| Static Public Attributes inherited from MAKVrExchange::DtPortalBaseEntity | |
| static const DtPortalMessageKind | theKind |
| Static Public Attributes inherited from MAKVrExchange::DtPortalBaseObject | |
| static const DtPortalMessageKind | theKind |
Additional Inherited Members | |
| Protected Member Functions inherited from MAKVrExchange::DtPortalMessage | |
| Protected Attributes inherited from MAKVrExchange::DtPortalBaseObject | |
| DtAttributeValuePairList | myAttributeValuePairList |
| DtPortalMessageKind | myMessageKind |
| DtString | myObjectName |
Represents aggregated entity objects in a simulation.
| MAKVrExchange::DtPortalAggregate::DtPortalAggregate | ( | ) |
|
virtual |
| MAKVrExchange::DtPortalAggregate::DtPortalAggregate | ( | const DtPortalAggregate & | other | ) |
| DtPortalAggregate& MAKVrExchange::DtPortalAggregate::operator= | ( | const DtPortalAggregate & | other | ) |
| bool MAKVrExchange::DtPortalAggregate::operator!= | ( | const DtPortalAggregate & | other | ) | const |
| bool MAKVrExchange::DtPortalAggregate::operator== | ( | const DtPortalAggregate & | other | ) | 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::DtPortalBaseEntity.
References theKind.
|
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::DtPortalBaseEntity.
|
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::DtPortalBaseEntity.
|
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::DtPortalBaseEntity.
|
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::DtPortalBaseEntity.
|
virtual |
Prints the current state of this message to the stream specified by str.
Reimplemented from MAKVrExchange::DtPortalBaseEntity.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtU32 | , |
| ForceId | , | ||
| forceId | |||
| ) |
The Force Identifier. An Enumeration.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtU32 | , |
| AggregateState | , | ||
| aggregateState | |||
| ) |
The aggregate state. An Enumeration.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtU32 | , |
| Formation | , | ||
| formation | |||
| ) |
The Formation of the aggregate, an enumeration.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtString | , |
| AggregateType | , | ||
| aggregateType | |||
| ) |
The Type of the aggregate in the form "1:1:1:1:1:1" as specified by the enumerations document.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtString | , |
| EntityIdentifier | , | ||
| entityIdentifer | |||
| ) |
The Aggregates Entity Identifier in the form "1:1:1".
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtString | , |
| MarkingText | , | ||
| markingText | |||
| ) |
The Marking text of the attribute, typicaly used by SAFs.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtU32 | , |
| MarkingCharacterSet | , | ||
| markingCharacterSet | |||
| ) |
The character set used for the marking text.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtVector | , |
| Dimensions | , | ||
| dimensions | |||
| ) |
The boundin box of the aggregate.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | std::vector< DtString > | , |
| Subaggregates | , | ||
| subaggregates | |||
| ) |
A vector of SubAggregate Identifiers.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | std::vector< DtString > | , |
| Entities | , | ||
| entities | |||
| ) |
A vector of Sub Entities contained in this aggregate.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtSilentAggregateArray | , |
| SilentAggregates | , | ||
| silentAggregates | |||
| ) |
An Array of silent aggregates.
These are sub aggregates which are not simulated.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtSilentEntityArray | , |
| SilentEntities | , | ||
| silentEntities | |||
| ) |
An Array of silent entities.
These are entities which are not simulated.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtAggregateVariableDatumArray | , |
| VariableDatums | , | ||
| variableDatums | |||
| ) |
An array of Variable datums encoded following the DIS standard.
|
inlinestatic |
A creator function for this class.
Reimplemented from MAKVrExchange::DtPortalBaseEntity.
|
static |
Referenced by kind().