 |
VR-Exchange 2.4 API Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Exchange 2.4 API Documentation
|
Represents aggregated entity objects in a simulation. More...
Public Member Functions | |
| DtPortalAggregate () | |
| CTOR. | |
| DtPortalAggregate (const DtPortalAggregate &other) | |
| Copy CTOR. | |
| virtual | ~DtPortalAggregate () |
| Virtual DTOR. | |
| DtPortalAggregate & | operator= (const DtPortalAggregate &other) |
| Assignment operator. | |
| virtual unsigned int | netSize () const |
| virtual void | writeSelfToBuffer (void *buffer) const |
| Writes this message into the memory buffer provided by buffer. | |
| virtual void | readSelfFromBuffer (const void *buffer) |
| 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. | |
| bool | operator== (const DtPortalAggregate &other) const |
| bool | operator!= (const DtPortalAggregate &other) const |
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. | |
| DtDEC_ATTRIBUTE (DtString, LVCID, lvcID) | |
| An unique identifier specified by the OBS xml file. | |
| DtDEC_ATTRIBUTE (DtString, SideName, sideName) | |
| An optional attribute specifing the side to which the object instance belongs. | |
| DtDEC_ATTRIBUTE (DtString, MySuperior, mySuperior) | |
| An optional reference to the LVCID of this object's superior. | |
| DtDEC_ATTRIBUTE (DtU32, DamageState, damageState) | |
| The overall damage state of the aggregate. | |
| DtDEC_ATTRIBUTE (bool, Immobilized, immobilized) | |
| The overall immobilized state of the aggregate. | |
| DtDEC_ATTRIBUTE (bool, FirePowerDisabled, firePowerDisabled) | |
| The overall fire power disabled state of the aggregate. | |
 Public Member Functions inherited from MAKVrExchange::DtPortalBaseEntity | |
| DtPortalBaseEntity (DtPortalMessageKind kind, const DtString &name) | |
| CTOR. | |
| DtPortalBaseEntity (const DtPortalBaseEntity &other) | |
| Copy CTOR. | |
| virtual | ~DtPortalBaseEntity () |
| Virtual DTOR. | |
| DtPortalBaseEntity & | operator= (const DtPortalBaseEntity &other) |
| Assignment operator. | |
| 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. | |
| bool | operator!= (const DtPortalBaseEntity &other) const |
| bool | operator== (const DtPortalBaseEntity &other) const |
| 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::DtPortalObject | |
| 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 bool | operator== (const DtPortalObject &other) const |
| virtual bool | operator!= (const DtPortalObject &other) const |
| 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. | |
| Public Member Functions inherited from MAKVrExchange::DtPortalMessage | |
Static Public Member Functions | |
| static DtPortalMessage * | create () |
Static Public Attributes | |
| static const DtPortalMessageKind | theKind |
| NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected. | |
Additional Inherited Members | |
| Protected Member Functions inherited from MAKVrExchange::DtPortalMessage | |
| Protected Attributes inherited from MAKVrExchange::DtPortalMessage |
Represents aggregated entity objects in a simulation.
| MAKVrExchange::DtPortalAggregate::DtPortalAggregate | ( | ) |
CTOR.
Referenced by create().
| MAKVrExchange::DtPortalAggregate::DtPortalAggregate | ( | const DtPortalAggregate & | other | ) |
Copy CTOR.
|
virtual |
Virtual DTOR.
|
inlinestatic |
References DtPortalAggregate().
| 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.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtString | , |
| LVCID | , | ||
| lvcID | |||
| ) |
An unique identifier specified by the OBS xml file.
Entites can not participate in JLVC scenarios without this information.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtString | , |
| SideName | , | ||
| sideName | |||
| ) |
An optional attribute specifing the side to which the object instance belongs.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtString | , |
| MySuperior | , | ||
| mySuperior | |||
| ) |
An optional reference to the LVCID of this object's superior.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | DtU32 | , |
| DamageState | , | ||
| damageState | |||
| ) |
The overall damage state of the aggregate.
This is an enumeration.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | bool | , |
| Immobilized | , | ||
| immobilized | |||
| ) |
The overall immobilized state of the aggregate.
| MAKVrExchange::DtPortalAggregate::DtDEC_ATTRIBUTE | ( | bool | , |
| FirePowerDisabled | , | ||
| firePowerDisabled | |||
| ) |
The overall fire power disabled state of the aggregate.
|
virtual |
NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.
Reimplemented from MAKVrExchange::DtPortalBaseEntity.
| bool MAKVrExchange::DtPortalAggregate::operator!= | ( | const DtPortalAggregate & | other | ) | const |
| DtPortalAggregate& MAKVrExchange::DtPortalAggregate::operator= | ( | const DtPortalAggregate & | other | ) |
Assignment operator.
| bool MAKVrExchange::DtPortalAggregate::operator== | ( | const DtPortalAggregate & | other | ) | const |
|
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::DtPortalBaseEntity.
|
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::DtPortalBaseEntity.
|
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::DtPortalBaseEntity.
|
static |
NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.