VR-Exchange 2.10 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Static Public Attributes
MAKVrExchange::DtPortalEntity Class Reference

Messages which represent Entities with state. More...

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

Public Member Functions

 DtPortalEntity ()
 CTOR. More...
 
 DtPortalEntity (const DtPortalEntity &other)
 Copy CTOR. More...
 
virtual ~DtPortalEntity ()
 Virtual DTOR. More...
 
DtPortalEntityoperator= (const DtPortalEntity &other)
 Assignment operator. More...
 
virtual unsigned int netSize () const
 
virtual void writeSelfToBuffer (void *buffer, int bufferSize) const
 Writes this message into the memory buffer provided by buffer. More...
 
virtual void readSelfFromBuffer (const void *buffer, int bufferSize)
 Reads this message from the memory buffer into this object. More...
 
virtual std::ostream & printDataToStream (std::ostream &str) const
 Prints the current state of this message to the stream specified by str. More...
 
Equality operators.
bool operator== (const DtPortalEntity &other) const
 
bool operator!= (const DtPortalEntity &other) const
 
Data Exchange Attributes
 DtDEC_ATTRIBUTE (DtU32, ForceId, forceId)
 Enumeration indicating the force this entity is associated with. More...
 
 DtDEC_ATTRIBUTE (DtU8, DamageState, damageState)
 Enumeration indicating if and how the entity is damaged. More...
 
 DtDEC_ATTRIBUTE (DtString, MarkingText, markingText)
 A description of the object. More...
 
 DtDEC_ATTRIBUTE (DtString, FederateId, federateId)
 The object name of the Federate this object is associated with. More...
 
 DtDEC_ATTRIBUTE (DtString, Guise, guise)
 The alternate entity type. More...
 
 DtDEC_ATTRIBUTE (DtU32, MarkingCharSet, markingCharSet)
 The character type set used for the Marking Text. More...
 
 DtDEC_ATTRIBUTE (bool, MissionKill, missionKill)
 True if the mission capability is disabled. More...
 
 DtDEC_ATTRIBUTE (DtU16, LiveEntityMeasuredSpeed, liveEntityMeasuredSpeed)
 The entity's own measurement of speed (e.g. More...
 
 DtDEC_ATTRIBUTE (bool, FirePowerDisabled, firePowerDisabled)
 True if the entity's fire power has been disabled. More...
 
 DtDEC_ATTRIBUTE (bool, Immobilized, immobilized)
 True if the entity is immobilized;. More...
 
 DtDEC_ATTRIBUTE (bool, IsConcealed, isConcealed)
 True if the entity is concealed. More...
 
 DtDEC_ATTRIBUTE (bool, EngineSmokeOn, engineSmokeOn)
 True if entity is creating engine smoke. More...
 
 DtDEC_ATTRIBUTE (bool, PowerPlantOn, powerPlantOn)
 True if the entities power plant is running. More...
 
 DtDEC_ATTRIBUTE (bool, RampDeployed, rampDeployed)
 True if the entity has a ramp which is deployed. More...
 
 DtDEC_ATTRIBUTE (bool, SmokePlumePresent, smokePlumePresent)
 True if the entity is generating smoke. More...
 
 DtDEC_ATTRIBUTE (bool, TentDeployed, tentDeployed)
 True if the entity has a tent that is deployed. More...
 
 DtDEC_ATTRIBUTE (bool, AfterburnerOn, afterburnerOn)
 True if the entity has an afterburner and it's on. More...
 
 DtDEC_ATTRIBUTE (bool, HasAmmunitionSupplyCap, hasAmmunitionSupplyCap)
 True if the entity has an Ammunition Supply Cap. More...
 
 DtDEC_ATTRIBUTE (bool, LauncherRaised, launcherRaised)
 True if the entity has a weapon launcher and its raised. More...
 
 DtDEC_ATTRIBUTE (bool, AntennaRaised, antennaRaised)
 True if the entity has an antenna and its raised. More...
 
 DtDEC_ATTRIBUTE (bool, FlamesPresent, flamesPresent)
 True if the entity is generating flames. More...
 
 DtDEC_ATTRIBUTE (bool, HasFuelSupplyCap, hasFuelSupplyCap)
 True if the entity has a fuel supply cap. More...
 
 DtDEC_ATTRIBUTE (bool, HasRecoveryCap, hasRecoveryCap)
 True if the entity has a recovery cap. More...
 
 DtDEC_ATTRIBUTE (bool, HasRepairCap, hasRepairCap)
 True if the entity has a repair cap. More...
 
 DtDEC_ATTRIBUTE (DtU8, HatchState, hatchState)
 Enumeration describing the hatch state as defined in the DIS Enumeration Standard. More...
 
 DtDEC_ATTRIBUTE (DtU32, LifeformState, lifeformState)
 Enumeration describing the state of a life form as defined in the DIS Enumeration Standard. More...
 
 DtDEC_ATTRIBUTE (DtU32, LightState, lightState)
 Enumeration describing the lighting of the object as defined by the DIS Enumeration Standard. More...
 
 DtDEC_ATTRIBUTE (DtU32, Density, density)
 Density of the object. More...
 
 DtDEC_ATTRIBUTE (DtU8, TrailState, trailState)
 Enumeration describing the trailing effects of the object. More...
 
 DtDEC_ATTRIBUTE (DtU8, CamouflageType, camouflageType)
 Enumeration describing the Camouflage of the object. More...
 
 DtDEC_ATTRIBUTE (DtU32, PrimaryWeaponState, primaryWeaponState)
 Enumeration describing the primary weapon state. More...
 
 DtDEC_ATTRIBUTE (DtU32, SecondaryWeaponState, secondaryWeaponState)
 Enumeration describing the secondary weapon state. More...
 
 DtDEC_ATTRIBUTE (DtU32, ComplianceState, complianceState)
 Enumeration as described by the DIS Enumerations document. More...
 
 DtDEC_ATTRIBUTE (DtArticulatedPartCollection, ArticulatedPartList, articulatedPartList)
 Articulated parts as encoded by DtArticulatedPartList. More...
 
 DtDEC_ATTRIBUTE (DtAttachedPartCollection, AttachedPartList, attachedPartList)
 Attached parts as encoded by DtAttachedPartList. More...
 
SEES PDU Attributes.
 DtDEC_ATTRIBUTE (DtU16, InfraredSigRepIndex, infraredSigRepIndex)
 
 DtDEC_ATTRIBUTE (DtU16, AcousticSigRepIndex, acousticSigRepIndex)
 
 DtDEC_ATTRIBUTE (DtU16, RadarSigRepIndex, radarSigRepIndex)
 
 DtDEC_ATTRIBUTE (DtPropulsionSystemDataList, PropulsionSystemData, propulsionSystemData)
 
 DtDEC_ATTRIBUTE (DtNozzleSystemDataList, NozzleSystemData, nozzleSystemData)
 
Afmstt UniqueEntity attributes.
 DtDEC_ATTRIBUTE (DtString, LVCID, lvcID)
 
 DtDEC_ATTRIBUTE (DtString, SideName, sideName)
 
 DtDEC_ATTRIBUTE (DtString, MySuperior, mySuperior)
 
NETN Physical Entity Attributes.

These attributes are defined in the NETN-Physical FOM module.

 DtDEC_ATTRIBUTE (DtU8, Status, status)
 Indicates if this platform currently is being simulated or not. More...
 
 DtDEC_ATTRIBUTE (DtVrlUuid, UniqueId, uniqueId)
 A unique identifier for the object (UUID as string). More...
 
 DtDEC_ATTRIBUTE (DtVrlUuid, SourceUnit, sourceUnit)
 Reference to an active NETN_Aggregate instance from which this physical entity was divided (UUID as string). More...
 
 DtDEC_ATTRIBUTE (std::vector< DtVrlUuid >, EmbeddedUnitList, embeddedUnitList)
 Reference to platforms or lifeforms embarked on this platform. More...
 
 DtDEC_ATTRIBUTE (std::wstring, Callsign, callsign)
 A callsign used to address the platform. More...
 
 DtDEC_ATTRIBUTE (DtU16, Activity, activity)
 The current activity of the platform (AggregateMissionEnum value). More...
 
 DtDEC_ATTRIBUTE (std::wstring, SymbolId, symbolId)
 A symbol identifier represented as a string. More...
 
 DtDEC_ATTRIBUTE (DtU8, DestinationPointType, destinationPointType)
 Indicates whether destination is a location (false) or UUID (true). More...
 
 DtDEC_ATTRIBUTE (DtVrlUuid, DestinationUuid, destinationUuid)
 The current destination of movement (as UUID reference string). More...
 
 DtDEC_ATTRIBUTE (DtVector, DestinationLocation, destinationLocation)
 The current destination of movement (as location coordinates). More...
 
 DtDEC_ATTRIBUTE (DtU8, RoutePathType, routePathType)
 Indicates whether route is waypoints (false) or UUID (true). More...
 
 DtDEC_ATTRIBUTE (DtVrlUuid, RouteUuid, routeUuid)
 The current path of movement (as UUID reference string). More...
 
 DtDEC_ATTRIBUTE (std::vector< DtVector >, RouteWaypoints, routeWaypoints)
 The current path of movement (as waypoints). More...
 
- Public Member Functions inherited from MAKVrExchange::DtPortalBaseEntity
 DtPortalBaseEntity (DtPortalMessageKind kind, const DtString &name)
 CTOR. More...
 
 DtPortalBaseEntity (const DtPortalBaseEntity &other)
 Copy CTOR. More...
 
virtual ~DtPortalBaseEntity ()
 Virtual DTOR. More...
 
DtPortalBaseEntityoperator= (const DtPortalBaseEntity &other)
 Assignment operator. More...
 
 DtDEC_ATTRIBUTE (DtU32, Algorithm, algorithm)
 The DR algorithm enumeration as specified in the DIS Enumerations Document. More...
 
 DtDEC_ATTRIBUTE (bool, Frozen, frozen)
 A flag to tell if the object is frozen. More...
 
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. More...
 
 DtDEC_ATTRIBUTE (DtEntityType, EntityType, entityType)
 Matches DIS Entity Type Requirements, in the form "1:1:1:1:1:1" as a string. More...
 
 DtDEC_ATTRIBUTE (DtVector64, Location, location)
 Geocentric Coordinates as defined by the DIS Standard. More...
 
 DtDEC_ATTRIBUTE (DtVector32, Velocity, velocity)
 Meters per second in Geocentric Coordinates as defined by the DIS Standard. More...
 
 DtDEC_ATTRIBUTE (DtVector32, Acceleration, acceleration)
 Meters per second second in Geocentric Coordinates as defined by the DIS Standard. More...
 
 DtDEC_ATTRIBUTE (DtVector32, RotationalVelocity, rotationalVelocity)
 The rotational velocity of the object as defined by the DIS Standard. More...
 
 DtDEC_ATTRIBUTE (DtTaitBryan, Orientation, orientation)
 The orientation of this object as defined by the DIS Standard. More...
 
 DtDEC_ATTRIBUTE (DtString, HostId, hostId)
 The Name of the object this object is part of. More...
 
 DtDEC_ATTRIBUTE (DtU32, Nature, nature)
 The Nature or purpose for joining the part to the host entity. More...
 
 DtDEC_ATTRIBUTE (DtU32, PartPosition, partPosition)
 Specifies the Part Position with respect to the host entity. More...
 
 DtDEC_ATTRIBUTE (DtU32, StationName, stationName)
 The station name where this entity is located in the host entity. More...
 
 DtDEC_ATTRIBUTE (DtU32, StationNumber, stationNumber)
 The number of the preticular station, or cargo hold etc. More...
 
 DtDEC_ATTRIBUTE (DtVector, RelativePosition, relativePosition)
 The relative position of this entity in regards to the host entity. More...
 
 DtDEC_ATTRIBUTE (DtFloat64, Range, range)
 The Range of this entity from the host entity. More...
 
 DtDEC_ATTRIBUTE (DtFloat64, Bearing, bearing)
 The Bearing of this entity in relation to the host entity. More...
 
 DtDEC_ATTRIBUTE (DtVector64, RelativeLocation, relativeLocation)
 The RelativeLocation of the object if we are embarked or attached to another object. More...
 
 DtDEC_ATTRIBUTE (DtVector32, RelativeVelocity, relativeVelocity)
 The relative velocity of this in relation to the host. More...
 
 DtDEC_ATTRIBUTE (DtVector32, RelativeAcceleration, relativeAcceleration)
 The relative acceleration of this object in relation to the host. More...
 
 DtDEC_ATTRIBUTE (bool, RelativeFrozen, relativeFrozen)
 A flag to indicate the object is Frozen to the hostObject. More...
 
 DtDEC_ATTRIBUTE (DtU32, RelativeAlgorithm, relativeAlgorithm)
 An Enumeration indicating the DR algorithm to use for relative position as defined by the DIS Standard. More...
 
 DtDEC_ATTRIBUTE (DtVector32, RelativeRotationalVelocity, relativeRotationalVelocity)
 The Name of the object this object is part of. More...
 
 DtDEC_ATTRIBUTE (DtTaitBryan, RelativeOrientation, relativeOrientation)
 The relative orientation of this object in relation to the host. More...
 
- Public Member Functions inherited from MAKVrExchange::DtPortalObject
 DtPortalObject (DtPortalMessageKind kind, const DtString &name)
 CTOR. More...
 
 DtPortalObject (const DtPortalObject &other)
 Copy CTOR. More...
 
virtual ~DtPortalObject ()
 Virtual DTOR. More...
 
virtual DtPortalObjectoperator= (const DtPortalObject &other)
 Assignment operator. More...
 
virtual bool operator== (const DtPortalObject &other) const
 
virtual bool operator!= (const DtPortalObject &other) const
 
 DtDEC_ATTRIBUTE (DtString, Name, name)
 Message Name attribute. More...
 
 DtDEC_ATTRIBUTE (DtString, Identifier, identifier)
 Every object must have a unique Identifier which is of type string. More...
 
 DtDEC_ATTRIBUTE (bool, FinalMessage, finalMessage)
 If true this is the final message for this object, and the object has been deleted. More...
 
 DtDEC_ATTRIBUTE (bool, Filtered, isFiltered)
 Indicates whether this object is filtered (not to be published). More...
 
 DtDEC_ATTRIBUTE (DtAttributeValuePairList, AttributeValuePairList, attributeValuePairList)
 The Attribute Value Pair List for the class. More...
 
 DtDEC_ATTRIBUTE (bool, IsUpdated, isUpdated)
 Indicates whether this object has been updated. More...
 
- Public Member Functions inherited from MAKVrExchange::DtPortalMessage
 DtPortalMessage (DtPortalMessageKind kind)
 CTOR. More...
 
 DtPortalMessage (const DtPortalMessage &other)
 Copy CTOR. More...
 
virtual ~DtPortalMessage ()
 Virtual DTOR. More...
 
virtual DtPortalMessageoperator= (const DtPortalMessage &other)
 Assignment operator. More...
 
virtual bool operator== (const DtPortalMessage &other) const
 
virtual bool operator!= (const DtPortalMessage &other) const
 
 DtDEC_ATTRIBUTE (DtPortalMessageKind, Kind, kind)
 Message Kind attribute. More...
 
virtual void setSerialNumber (unsigned int i) const
 This method should be considered private and not be used. More...
 
virtual unsigned int serialNumber () const
 Returns a unique identifier for this message. More...
 
virtual void setSendingBrokerId (const DtU32 &id) const
 This method should be considered private and not be used. More...
 
virtual DtU32 sendingBrokerId () const
 Returns the ID of the sending broker. More...
 
virtual void setTimeSent (const DtTime &tm) const
 This method should be considered private and not be used. More...
 
virtual DtTime timeSent () const
 The Time that the message was sent. More...
 
virtual void setTimeReceived (const DtTime &tm) const
 This method should be considered private and not be used. More...
 
virtual DtTime timeReceived () const
 The time that this message was received. More...
 

Static Public Member Functions

static DtPortalMessagecreate ()
 

Static Public Attributes

static const DtPortalMessageKind theKind
 NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected. More...
 

Additional Inherited Members

- Protected Member Functions inherited from MAKVrExchange::DtPortalMessage
virtual int getSize (const DtU8 &v) const
 
virtual char * encode (const DtU8 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtU8 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtU16 &v) const
 
virtual char * encode (const DtU16 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtU16 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtU32 &v) const
 
virtual char * encode (const DtU32 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtU32 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtU64 &v) const
 
virtual char * encode (const DtU64 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtU64 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtInt8 &v) const
 
virtual char * encode (const DtInt8 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtInt8 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtInt16 &v) const
 
virtual char * encode (const DtInt16 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtInt16 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtInt32 &v) const
 
virtual char * encode (const DtInt32 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtInt32 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtInt64 &v) const
 
virtual char * encode (const DtInt64 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtInt64 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtFloat32 &v) const
 
virtual char * encode (const DtFloat32 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtFloat32 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtFloat64 &v) const
 
virtual char * encode (const DtFloat64 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtFloat64 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtVector32 &v) const
 
virtual char * encode (const DtVector32 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtVector32 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtVector64 &v) const
 
virtual char * encode (const DtVector64 &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtVector64 &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtTaitBryan &v) const
 
virtual char * encode (const DtTaitBryan &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtTaitBryan &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtString &val) const
 
virtual char * encode (const DtString &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtString &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const std::wstring &val) const
 
virtual char * encode (const std::wstring &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (std::wstring &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtVrlUuid &val) const
 
virtual char * encode (const DtVrlUuid &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtVrlUuid &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const bool &v) const
 
virtual char * encode (const bool &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (bool &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtSilentEntity &v) const
 
virtual char * encode (const DtSilentEntity &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtSilentEntity &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtSilentAggregate &v) const
 
virtual char * encode (const DtSilentAggregate &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtSilentAggregate &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtVariableLengthData &v) const
 
virtual char * encode (const DtVariableLengthData &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtVariableLengthData &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtFixedLengthData &value) const
 
virtual char * encode (const DtFixedLengthData &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtFixedLengthData &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtAggregateVariableDatum &v) const
 
virtual char * encode (const DtAggregateVariableDatum &val, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtAggregateVariableDatum &val, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtEmitterBeamData &data) const
 
virtual char * encode (const DtEmitterBeamData &data, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtEmitterBeamData &data, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtLinearSegmentData &data) const
 
virtual char * encode (const DtLinearSegmentData &data, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtLinearSegmentData &data, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtActiveSonarBeamData &data) const
 
virtual char * encode (const DtActiveSonarBeamData &data, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtActiveSonarBeamData &data, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtEntityIdentifier &value) const
 
virtual char * encode (const DtEntityIdentifier &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtEntityIdentifier &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtEntityType &value) const
 
virtual char * encode (const DtEntityType &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtEntityType &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtSyntheticEnvironmentObjectType &value) const
 
virtual char * encode (const DtSyntheticEnvironmentObjectType &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtSyntheticEnvironmentObjectType &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtArticulatedPartCollection &value) const
 
virtual char * encode (const DtArticulatedPartCollection &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtArticulatedPartCollection &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtAttachedPartCollection &value) const
 
virtual char * encode (const DtAttachedPartCollection &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtAttachedPartCollection &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtIffAtcNavaidsAltParm4 &value) const
 
virtual char * encode (const DtIffAtcNavaidsAltParm4 &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtIffAtcNavaidsAltParm4 &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtSimulationAddress &value) const
 
virtual char * encode (const DtSimulationAddress &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtSimulationAddress &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtShaftRateData &value) const
 
virtual char * encode (const DtShaftRateData &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtShaftRateData &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtRingSectorsRecord &value) const
 
virtual char * encode (const DtRingSectorsRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtRingSectorsRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtPostureTransitionRecord &value) const
 
virtual char * encode (const DtPostureTransitionRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtPostureTransitionRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtMoppLevelTransitionRecord &value) const
 
virtual char * encode (const DtMoppLevelTransitionRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtMoppLevelTransitionRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtIndirectFirePowerRecord &value) const
 
virtual char * encode (const DtIndirectFirePowerRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtIndirectFirePowerRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtRangedPowerRecord &value) const
 
virtual char * encode (const DtRangedPowerRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtRangedPowerRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtEffectModifierRecord &value) const
 
virtual char * encode (const DtEffectModifierRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtEffectModifierRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtTypedQuantityRecord &value) const
 
virtual char * encode (const DtTypedQuantityRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtTypedQuantityRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtCasualtyReportRecord &value) const
 
virtual char * encode (const DtCasualtyReportRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtCasualtyReportRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtTypedAmountRecord &value) const
 
virtual char * encode (const DtTypedAmountRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtTypedAmountRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtEWAttackRecord &value) const
 
virtual char * encode (const DtEWAttackRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtEWAttackRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtEWAttackDefendingRecord &value) const
 
virtual char * encode (const DtEWAttackDefendingRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtEWAttackDefendingRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtTypedRateRecord &value) const
 
virtual char * encode (const DtTypedRateRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtTypedRateRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtAmountRecord &value) const
 
virtual char * encode (const DtAmountRecord &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtAmountRecord &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtSensorContactInfo &value) const
 
virtual char * encode (const DtSensorContactInfo &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtSensorContactInfo &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtPropulsionSystemData &value) const
 
virtual char * encode (const DtPropulsionSystemData &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtPropulsionSystemData &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtNozzleSystemData &value) const
 
virtual char * encode (const DtNozzleSystemData &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtNozzleSystemData &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtVrxRecordSetList &value) const
 
virtual char * encode (const DtVrxRecordSetList &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtVrxRecordSetList &value, const char *buffer, int &bufferSize) const
 
virtual int getSize (const DtPatchIdentifier &value) const
 
virtual char * encode (const DtPatchIdentifier &value, char *buffer, int &bufferSize) const
 
virtual const char * decode (DtPatchIdentifier &value, const char *buffer, int &bufferSize) const
 
template<typename T1 , typename T2 >
int getSize (const std::pair< T1, T2 > &value) const
 
template<typename T1 , typename T2 >
char * encode (const std::pair< T1, T2 > &value, char *buffer, int &bufferSize) const
 
template<typename T1 , typename T2 >
const char * decode (std::pair< T1, T2 > &value, const char *buffer, int &bufferSize) const
 
template<typename T >
int getSize (const std::list< T > &value) const
 
template<typename T >
char * encode (const std::list< T > &value, char *buffer, int &bufferSize) const
 
template<typename T >
const char * decode (std::list< T > &value, const char *buffer, int &bufferSize) const
 
template<typename T >
int getSize (const std::vector< T > &value) const
 
template<typename T >
char * encode (const std::vector< T > &value, char *buffer, int &bufferSize) const
 
template<typename T >
const char * decode (std::vector< T > &value, const char *buffer, int &bufferSize) const
 
template<typename T1 , typename T2 >
int getSize (const std::map< T1, T2 > &value) const
 
template<typename T1 , typename T2 >
char * encode (const std::map< T1, T2 > &value, char *buffer, int &bufferSize) const
 
template<typename T1 , typename T2 >
const char * decode (std::map< T1, T2 > &value, const char *buffer, int &bufferSize) const
 
- Protected Attributes inherited from MAKVrExchange::DtPortalMessage
DtU32 myMutableSerialNumber
 Mutable because it can be set by the PConnection. More...
 
DtU32 myMutableSendingBrokerId
 Mutable because it can be set by the PConnection. More...
 
DtTime myMutableSentTimeStamp
 Mutable because it can be set by the PConnection. More...
 
DtTime myMutableReceivedTimeStamp
 Mutable because it can be set by the PConnection. More...
 

Detailed Description

Messages which represent Entities with state.

This class can be considered a state repository as well as a message.

Constructor & Destructor Documentation

MAKVrExchange::DtPortalEntity::DtPortalEntity ( )

CTOR.

Referenced by create().

MAKVrExchange::DtPortalEntity::DtPortalEntity ( const DtPortalEntity other)

Copy CTOR.

virtual MAKVrExchange::DtPortalEntity::~DtPortalEntity ( )
virtual

Virtual DTOR.

Member Function Documentation

DtPortalMessage * MAKVrExchange::DtPortalEntity::create ( )
inlinestatic

References DtPortalEntity().

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU32  ,
ForceId  ,
forceId   
)

Enumeration indicating the force this entity is associated with.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU8  ,
DamageState  ,
damageState   
)

Enumeration indicating if and how the entity is damaged.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtString  ,
MarkingText  ,
markingText   
)

A description of the object.

This is usually the Bumper Number of the object.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtString  ,
FederateId  ,
federateId   
)

The object name of the Federate this object is associated with.

This is only applicable to HLA

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtString  ,
Guise  ,
guise   
)

The alternate entity type.

This is an entity type and should be a string in the form "1:1:1:1:1:1:1".

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU32  ,
MarkingCharSet  ,
markingCharSet   
)

The character type set used for the Marking Text.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
MissionKill  ,
missionKill   
)

True if the mission capability is disabled.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU16  ,
LiveEntityMeasuredSpeed  ,
liveEntityMeasuredSpeed   
)

The entity's own measurement of speed (e.g.

air speed for aircraft), in decimeters per second.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
FirePowerDisabled  ,
firePowerDisabled   
)

True if the entity's fire power has been disabled.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
Immobilized  ,
immobilized   
)

True if the entity is immobilized;.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
IsConcealed  ,
isConcealed   
)

True if the entity is concealed.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
EngineSmokeOn  ,
engineSmokeOn   
)

True if entity is creating engine smoke.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
PowerPlantOn  ,
powerPlantOn   
)

True if the entities power plant is running.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
RampDeployed  ,
rampDeployed   
)

True if the entity has a ramp which is deployed.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
SmokePlumePresent  ,
smokePlumePresent   
)

True if the entity is generating smoke.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
TentDeployed  ,
tentDeployed   
)

True if the entity has a tent that is deployed.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
AfterburnerOn  ,
afterburnerOn   
)

True if the entity has an afterburner and it's on.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
HasAmmunitionSupplyCap  ,
hasAmmunitionSupplyCap   
)

True if the entity has an Ammunition Supply Cap.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
LauncherRaised  ,
launcherRaised   
)

True if the entity has a weapon launcher and its raised.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
AntennaRaised  ,
antennaRaised   
)

True if the entity has an antenna and its raised.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
FlamesPresent  ,
flamesPresent   
)

True if the entity is generating flames.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
HasFuelSupplyCap  ,
hasFuelSupplyCap   
)

True if the entity has a fuel supply cap.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
HasRecoveryCap  ,
hasRecoveryCap   
)

True if the entity has a recovery cap.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( bool  ,
HasRepairCap  ,
hasRepairCap   
)

True if the entity has a repair cap.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU8  ,
HatchState  ,
hatchState   
)

Enumeration describing the hatch state as defined in the DIS Enumeration Standard.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU32  ,
LifeformState  ,
lifeformState   
)

Enumeration describing the state of a life form as defined in the DIS Enumeration Standard.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU32  ,
LightState  ,
lightState   
)

Enumeration describing the lighting of the object as defined by the DIS Enumeration Standard.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU32  ,
Density  ,
density   
)

Density of the object.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU8  ,
TrailState  ,
trailState   
)

Enumeration describing the trailing effects of the object.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU8  ,
CamouflageType  ,
camouflageType   
)

Enumeration describing the Camouflage of the object.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU32  ,
PrimaryWeaponState  ,
primaryWeaponState   
)

Enumeration describing the primary weapon state.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU32  ,
SecondaryWeaponState  ,
secondaryWeaponState   
)

Enumeration describing the secondary weapon state.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU32  ,
ComplianceState  ,
complianceState   
)

Enumeration as described by the DIS Enumerations document.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtArticulatedPartCollection  ,
ArticulatedPartList  ,
articulatedPartList   
)

Articulated parts as encoded by DtArticulatedPartList.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtAttachedPartCollection  ,
AttachedPartList  ,
attachedPartList   
)

Attached parts as encoded by DtAttachedPartList.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU16  ,
InfraredSigRepIndex  ,
infraredSigRepIndex   
)
MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU16  ,
AcousticSigRepIndex  ,
acousticSigRepIndex   
)
MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU16  ,
RadarSigRepIndex  ,
radarSigRepIndex   
)
MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtPropulsionSystemDataList  ,
PropulsionSystemData  ,
propulsionSystemData   
)
MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtNozzleSystemDataList  ,
NozzleSystemData  ,
nozzleSystemData   
)
MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtString  ,
LVCID  ,
lvcID   
)
MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtString  ,
SideName  ,
sideName   
)
MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtString  ,
MySuperior  ,
mySuperior   
)
MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU8  ,
Status  ,
status   
)

Indicates if this platform currently is being simulated or not.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtVrlUuid  ,
UniqueId  ,
uniqueId   
)

A unique identifier for the object (UUID as string).

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtVrlUuid  ,
SourceUnit  ,
sourceUnit   
)

Reference to an active NETN_Aggregate instance from which this physical entity was divided (UUID as string).

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( std::vector< DtVrlUuid >  ,
EmbeddedUnitList  ,
embeddedUnitList   
)

Reference to platforms or lifeforms embarked on this platform.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( std::wstring  ,
Callsign  ,
callsign   
)

A callsign used to address the platform.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU16  ,
Activity  ,
activity   
)

The current activity of the platform (AggregateMissionEnum value).

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( std::wstring  ,
SymbolId  ,
symbolId   
)

A symbol identifier represented as a string.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU8  ,
DestinationPointType  ,
destinationPointType   
)

Indicates whether destination is a location (false) or UUID (true).

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtVrlUuid  ,
DestinationUuid  ,
destinationUuid   
)

The current destination of movement (as UUID reference string).

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtVector  ,
DestinationLocation  ,
destinationLocation   
)

The current destination of movement (as location coordinates).

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtU8  ,
RoutePathType  ,
routePathType   
)

Indicates whether route is waypoints (false) or UUID (true).

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( DtVrlUuid  ,
RouteUuid  ,
routeUuid   
)

The current path of movement (as UUID reference string).

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE ( std::vector< DtVector >  ,
RouteWaypoints  ,
routeWaypoints   
)

The current path of movement (as waypoints).

virtual unsigned int MAKVrExchange::DtPortalEntity::netSize ( ) const
virtual

NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.

Reimplemented from MAKVrExchange::DtPortalBaseEntity.

bool MAKVrExchange::DtPortalEntity::operator!= ( const DtPortalEntity other) const
DtPortalEntity& MAKVrExchange::DtPortalEntity::operator= ( const DtPortalEntity other)

Assignment operator.

bool MAKVrExchange::DtPortalEntity::operator== ( const DtPortalEntity other) const
virtual std::ostream& MAKVrExchange::DtPortalEntity::printDataToStream ( std::ostream &  str) 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 void MAKVrExchange::DtPortalEntity::readSelfFromBuffer ( const void *  buffer,
int  bufferSize 
)
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 void MAKVrExchange::DtPortalEntity::writeSelfToBuffer ( void *  buffer,
int  bufferSize 
) const
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.

Member Data Documentation

const DtPortalMessageKind MAKVrExchange::DtPortalEntity::theKind
static

NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.


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

Document ID: Generated on Mon May 25 18:45:12 EDT 2026 from SVN revision 289111
Copyright © 2005-2026 MAK Technologies. All Rights Reserved (www.mak.com)