MAKVrExchange::DtPortalEntity Class Reference

Messages which represent Entities with state. More...

Inheritance diagram for MAKVrExchange::DtPortalEntity:

Public Member Functions
	DtPortalEntity ()
	The Default CTOR.
virtual	~DtPortalEntity ()
	The Default DTOR.
	DtPortalEntity (const DtPortalEntity &other)
DtPortalEntity &	operator= (const DtPortalEntity &other)
bool	operator!= (const DtPortalEntity &other) const
bool	operator== (const DtPortalEntity &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
Portal Entity Attributes
	DtDEC_ATTRIBUTE (DtU32, ForceId, forceId)
	Enumeration indicating the force this entity is associated with.
	DtDEC_ATTRIBUTE (DtU32, DamageState, damageState)
	Enumeration indicating if and how the entity is damaged.
	DtDEC_ATTRIBUTE (DtString, MarkingText, markingText)
	A description of the object.
	DtDEC_ATTRIBUTE (DtString, FederateId, federateId)
	The object name of the Federate this object is associated with.
	DtDEC_ATTRIBUTE (DtString, Guise, guise)
	The alternate entity type.
	DtDEC_ATTRIBUTE (DtU32, MarkingCharSet, markingCharSet)
	The character type set used for the Marking Text.
	DtDEC_ATTRIBUTE (bool, MissionKill, missionKill)
	True if the mission capability is disabled.
	DtDEC_ATTRIBUTE (bool, FirePowerDisabled, firePowerDisabled)
	True if the entity's fire power has been disabled.
	DtDEC_ATTRIBUTE (bool, Immobilized, immobilized)
	True if the entity is immobilized;.
	DtDEC_ATTRIBUTE (bool, IsConcealed, isConcealed)
	True if the entity is concealed.
	DtDEC_ATTRIBUTE (bool, EngineSmokeOn, engineSmokeOn)
	True if entity is creating engine smoke.
	DtDEC_ATTRIBUTE (bool, PowerPlantOn, powerPlantOn)
	True if the entities power plant is running.
	DtDEC_ATTRIBUTE (bool, RampDeployed, rampDeployed)
	True if the entity has a ramp which is deployed.
	DtDEC_ATTRIBUTE (bool, SmokePlumePresent, smokePlumePresent)
	True if the entity is generating smoke.
	DtDEC_ATTRIBUTE (bool, TentDeployed, tentDeployed)
	True if the entity has a tent that is deployed.
	DtDEC_ATTRIBUTE (bool, AfterburnerOn, afterburnerOn)
	True if the entity has an afterburner and it's on.
	DtDEC_ATTRIBUTE (bool, HasAmmunitionSupplyCap, hasAmmunitionSupplyCap)
	True if the entity has an Ammunition Supply Cap.
	DtDEC_ATTRIBUTE (bool, LauncherRaised, launcherRaised)
	True if the entity has a weapon launcher and its raised.
	DtDEC_ATTRIBUTE (bool, AntennaRaised, antennaRaised)
	True if the entity has an antenna and its raised.
	DtDEC_ATTRIBUTE (bool, FlamesPresent, flamesPresent)
	True if the entity is generating flames.
	DtDEC_ATTRIBUTE (bool, HasFuelSupplyCap, hasFuelSupplyCap)
	True if the entity has a fuel supply cap.
	DtDEC_ATTRIBUTE (bool, HasRecoveryCap, hasRecoveryCap)
	True if the entity has a recovery cap.
	DtDEC_ATTRIBUTE (bool, HasRepairCap, hasRepairCap)
	True if the entity has a repair cap.
	DtDEC_ATTRIBUTE (DtU32, HatchState, hatchState)
	Enumeration describing the hatch state as defined in the DIS Enumeration Standard.
	DtDEC_ATTRIBUTE (DtU32, LifeformState, lifeformState)
	Enumeration describing the state of a life form as defined in the DIS Enumeration Standard.
	DtDEC_ATTRIBUTE (DtU32, LightState, lightState)
	Enumeration describing the lighting of the object as defined by the DIS Enumeration Standard.
	DtDEC_ATTRIBUTE (DtU32, Density, density)
	Density of the object.
	DtDEC_ATTRIBUTE (DtU32, TrailState, trailState)
	Enumeration describing the trailing effects of the object.
	DtDEC_ATTRIBUTE (DtU32, CamouflageType, camouflageType)
	Enumeration describing the Camouflage of the object.
	DtDEC_ATTRIBUTE (DtU32, PrimaryWeaponState, primaryWeaponState)
	Enumeration describing the primary weapon state.
	DtDEC_ATTRIBUTE (DtU32, SecondaryWeaponState, secondaryWeaponState)
	Enumeration describing the secondary weapon state.
	DtDEC_ATTRIBUTE (DtU32, ComplianceState, complianceState)
	Enumeration as described by the DIS Enumerations document.
	DtDEC_ATTRIBUTE (DtArticulatedPartCollection, ArticulatedPartList, articulatedPartList)
	Articulated parts as encoded by DtArticulatedPartList.
	DtDEC_ATTRIBUTE (DtAttachedPartCollection, AttachedPartList, attachedPartList)
	Attached parts as encoded by DtAttachedPartList.
	DtDEC_ATTRIBUTE (DtString, DiGuyAction, diGuyAction)
	Enumeration indicating the force this entity is associated with.
	DtDEC_ATTRIBUTE (bool, DiGuyActionPaused, diGuyActionPaused)
	Enumeration indicating the force this entity is associated with.
	DtDEC_ATTRIBUTE (DtString, DiGuyAppearance, diGuyAppearance)
	Enumeration indicating the force this entity is associated with.
	DtDEC_ATTRIBUTE (DtString, DiGuyType, diGuyType)
	Enumeration indicating the force this entity is associated with.
	DtDEC_ATTRIBUTE (DtEntityIdentifier, DiGuyParent, diGuyParent)
	Enumeration indicating the force this entity is associated with.
	DtDEC_ATTRIBUTE (DtString, LVCID, lvcID)
	Enumeration indicating the force this entity is associated with.
	DtDEC_ATTRIBUTE (DtString, SideName, sideName)
	Enumeration indicating the force this entity is associated with.
	DtDEC_ATTRIBUTE (DtString, MySuperior, mySuperior)
	Enumeration indicating the force this entity is associated with.
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
	DtPortalMessage ()
	The default CTOR.
virtual	~DtPortalMessage ()
	The default DTOR.
	DtPortalMessage (const DtPortalMessage &other)
	Copy CTOR, this class is copyable.
DtPortalMessage &	operator= (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 DtPortalMessage *	create ()

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
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

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

(

)

The Default CTOR.

virtual MAKVrExchange::DtPortalEntity::~DtPortalEntity ( )

virtual

The Default DTOR.

MAKVrExchange::DtPortalEntity::DtPortalEntity

(

const DtPortalEntity &

other

)

Member Function Documentation

DtPortalEntity& MAKVrExchange::DtPortalEntity::operator=

(

const DtPortalEntity &

other

)

bool MAKVrExchange::DtPortalEntity::operator!=

(

const DtPortalEntity &

other

)

const

bool MAKVrExchange::DtPortalEntity::operator==

(

const DtPortalEntity &

other

)

const

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

Enumeration indicating the force this entity is associated with.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE	(	DtU32	,
		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	(	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	(	DtU32	,
		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	(	DtU32	,
		TrailState	,
		trailState
	)

Enumeration describing the trailing effects of the object.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE	(	DtU32	,
		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	(	DtString	,
		DiGuyAction	,
		diGuyAction
	)

Enumeration indicating the force this entity is associated with.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE	(	bool	,
		DiGuyActionPaused	,
		diGuyActionPaused
	)

Enumeration indicating the force this entity is associated with.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE	(	DtString	,
		DiGuyAppearance	,
		diGuyAppearance
	)

Enumeration indicating the force this entity is associated with.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE	(	DtString	,
		DiGuyType	,
		diGuyType
	)

Enumeration indicating the force this entity is associated with.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE	(	DtEntityIdentifier	,
		DiGuyParent	,
		diGuyParent
	)

Enumeration indicating the force this entity is associated with.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE	(	DtString	,
		LVCID	,
		lvcID
	)

Enumeration indicating the force this entity is associated with.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE	(	DtString	,
		SideName	,
		sideName
	)

Enumeration indicating the force this entity is associated with.

MAKVrExchange::DtPortalEntity::DtDEC_ATTRIBUTE	(	DtString	,
		MySuperior	,
		mySuperior
	)

Enumeration indicating the force this entity is associated with.

virtual DtPortalMessageKind MAKVrExchange::DtPortalEntity::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::DtPortalBaseEntity.

References theKind.

virtual const char* MAKVrExchange::DtPortalEntity::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::DtPortalBaseEntity.

virtual unsigned int MAKVrExchange::DtPortalEntity::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::DtPortalBaseEntity.

virtual void MAKVrExchange::DtPortalEntity::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::DtPortalBaseEntity.

virtual void MAKVrExchange::DtPortalEntity::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::DtPortalBaseEntity.

virtual std::ostream& MAKVrExchange::DtPortalEntity::printDataToStream ( std::ostream &  str ) const

virtual

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

Reimplemented from MAKVrExchange::DtPortalBaseEntity.

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

inlinestatic

Reimplemented from MAKVrExchange::DtPortalBaseEntity.

Member Data Documentation

const DtPortalMessageKind MAKVrExchange::DtPortalEntity::theKind

static

Referenced by kind().

---

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

• pEntity.h