VR-Link C# API Documentation
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
List of all members | Classes | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Properties | Static Private Member Functions | Private Attributes
EntityStateMessage Class Reference
+ Inheritance diagram for EntityStateMessage:
+ Collaboration diagram for EntityStateMessage:

Classes

class  ArtPart
 
class  AttPart
 
class  Parameter
 
class  PStruct
 
class  VNStruct
 

Public Types

enum  DeadReckoningAlgorithm {
  DeadReckoningAlgorithm.OTHER, DeadReckoningAlgorithm.STATIC, DeadReckoningAlgorithm.FPW, DeadReckoningAlgorithm.RPW,
  DeadReckoningAlgorithm.RVW, DeadReckoningAlgorithm.FVW, DeadReckoningAlgorithm.FPB, DeadReckoningAlgorithm.RPB,
  DeadReckoningAlgorithm.RVB, DeadReckoningAlgorithm.FVB
}
 
enum  ConstituentPartStationName {
  ConstituentPartStationName.OTHER =0, ConstituentPartStationName.AIRCRAFT_WINGSTATION =1, ConstituentPartStationName.SHIPS_FORWARD_GUNMOUNT_STARBOARD =2, ConstituentPartStationName.SHIPS_FORWARD_GUNMOUNT_PORT =3,
  ConstituentPartStationName.SHIPS_FORWARD_GUNMOUNT_CENTERLINE =4, ConstituentPartStationName.SHIPS_AFT_GUNMOUNT_STARBOARD =5, ConstituentPartStationName.SHIPS_AFT_GUNMOUNT_PORT =6, ConstituentPartStationName.SHIPS_AFT_GUNMOUNT_CENTERLINE =7,
  ConstituentPartStationName.FORWARD_TORPEDO_TUBE =8, ConstituentPartStationName.AFT_TORPEDO_TUBE =9, ConstituentPartStationName.BOMB_BAY =10, ConstituentPartStationName.CARGO_BAY =11,
  ConstituentPartStationName.TRUCK_BED =12, ConstituentPartStationName.TRAILER_BED =13, ConstituentPartStationName.WELL_DECk =14, ConstituentPartStationName.ON_STATION_RNG_BRG =15,
  ConstituentPartStationName.ON_STATION_XYZ =16
}
 
enum  TrailingEffects { TrailingEffects.NONE, TrailingEffects.SMALL, TrailingEffects.MEDIUM, TrailingEffects.LARGE }
 
enum  ForceType { ForceType.OTHER, ForceType.FRIENDLY, ForceType.OPPOSING, ForceType.NEUTRAL }
 
enum  LightType {
  LightType.LIGHTS =12, LightType.HEAD_LIGHTS =12, LightType.FLASH_LIGHTS =12, LightType.LANDING_LIGHTS =12,
  LightType.RUNNING_LIGHTS =12, LightType.TAIL_LIGHTS =13, LightType.NAVIGATION_LIGHTS =13, LightType.ANTI_COLLISION_LIGHTS =14,
  LightType.BRAKE_LIGHTS =14, LightType.FORMATION_LIGHTS =24, LightType.BLACK_OUT_LIGHTS =26, LightType.BLACK_OUT_BRAKE_LIGHTS =27,
  LightType.SPOT_LIGHTS =28, LightType.EXTERIOR_LIGHTS =28, LightType.EXTERNAL_LIGHTS =28, LightType.INTERIOR_LIGHTS =29,
  LightType.INTERNAL_LIGHTS =29
}
 
enum  ParameterTypes {
  ParameterTypes.POSITION = 1, ParameterTypes.POSITIONRATE = 2, ParameterTypes.EXTENSION = 3, ParameterTypes.EXTENSIONRATE = 4,
  ParameterTypes.X = 5, ParameterTypes.XRATE = 6, ParameterTypes.Y = 7, ParameterTypes.YRATE = 8,
  ParameterTypes.Z = 9, ParameterTypes.ZRATE = 10, ParameterTypes.AZIMUTH = 11, ParameterTypes.AZIMUTHRATE = 12,
  ParameterTypes.ELEVATION = 13, ParameterTypes.ELEVATIONRATE = 14, ParameterTypes.ROTATION = 15, ParameterTypes.ROTATIONRATE = 16
}
 
enum  WeaponState { WeaponState.NOWEAPON, WeaponState.STOWED, WeaponState.DEPLOYED, WeaponState.FIREPOSITION }
 
enum  ConstituentPartNature {
  ConstituentPartNature.OTHER =0, ConstituentPartNature.HOST_FIREABLE_MUNITION =1, ConstituentPartNature.MUNITION_CARRIED_AS_CARGO =2, ConstituentPartNature.FUEL_CARRIED_AS_CARGO =3,
  ConstituentPartNature.GUNMOUNT_ATTACHED_TO_HOST =4, ConstituentPartNature.COMPUTER_GENERATED_FORCES_CARRIED_AS_CARGO =5, ConstituentPartNature.VEHICLE_CARRIED_AS_CARGO =6, ConstituentPartNature.EMITTER_MOUNTED_ON_HOST =7,
  ConstituentPartNature.MOBILE_COMMAND_AND_CONTROL_ENTITY_CARRIED_ABOARD_HOST =8, ConstituentPartNature.ENTITY_STATIONED_AT =9, ConstituentPartNature.TEAM_MEMBER_IN_FORMATION_WITH =10
}
 
enum  ComplianceState {
  ComplianceState.NA, ComplianceState.DETAINED, ComplianceState.SURRENDER, ComplianceState.USING_FISTS,
  ComplianceState.VERBAL_ABUSE1, ComplianceState.VERBAL_ABUSE2, ComplianceState.VERBAL_ABUSE3, ComplianceState.PASSIVE_RESISTANCE1,
  ComplianceState.PASSIVE_RESISTANCE2, ComplianceState.PASSIVE_RESISTANCE3, ComplianceState.NON_LETHAL_WEAPON1, ComplianceState.NON_LETHAL_WEAPON2,
  ComplianceState.NON_LETHAL_WEAPON3, ComplianceState.NON_LETHAL_WEAPON4, ComplianceState.NON_LETHAL_WEAPON5, ComplianceState.NON_LETHAL_WEAPON6
}
 
enum  ConstituentPartPosition { ConstituentPartPosition.OTHER =0, ConstituentPartPosition.ON_TOP_OF =1, ConstituentPartPosition.INSIDE =2 }
 
enum  DamageState { DamageState.NONE, DamageState.SLIGHT, DamageState.MODERATE, DamageState.DESTROYED }
 
enum  LifeformState {
  LifeformState.NA, LifeformState.STANDING, LifeformState.WALKING, LifeformState.RUNNING,
  LifeformState.KNEELING, LifeformState.PRONE, LifeformState.CRAWLING, LifeformState.SWIMMING,
  LifeformState.PARACHUTING, LifeformState.JUMPING, LifeformState.SITTING, LifeformState.SQUATTING,
  LifeformState.CROUCHING, LifeformState.WADING, LifeformState.SURRENDERED, LifeformState.DETAINED
}
 
enum  HatchState {
  HatchState.NA, HatchState.CLOSED, HatchState.POPPED, HatchState.POPPEDANDPERSON,
  HatchState.OPEN, HatchState.OPENANDPERSON
}
 
enum  CamoflageType { CamoflageType.DESERT, CamoflageType.WINTER, CamoflageType.FOREST }
 

Public Member Functions

 EntityStateMessage ()
 
- Public Member Functions inherited from Message
 Message ()
 
virtual Byte[] encode ()
 

Public Attributes

const String theFullName ="EntityStateMessage"
 

Protected Member Functions

override int messageSize ()
 
override void serialize (ref BinaryWriter writer)
 
override void deserialize (ref BinaryReader reader)
 

Properties

static string theName [get]
 
string id [get, set]
 
string entityIdentifier [get, set]
 
EntityType type [get, set]
 
EntityType guise [get, set]
 
double lastSetTime [get, set]
 
Vector3d worldPosition [get, set]
 
Vector3f worldVelocity [get, set]
 
Vector3f worldAcceleration [get, set]
 
TaitBryan worldOrientation [get, set]
 
Vector3f rotationalVelocity [get, set]
 
DeadReckoningAlgorithm deadReckoningType [get, set]
 
bool frozenBit [get, set]
 
ForceType forceType [get, set]
 
string markingText [get, set]
 
UInt32 appearanceBits [get, set]
 
UInt32 capabilityBits [get, set]
 
LifeformState lifeformState [get, set]
 
List< ArtPart > articulatedParts [get, set]
 
List< AttPart > attachedParts [get, set]
 
UInt16 infraredSignatureIndex [get, set]
 
UInt16 acousticSignatureIndex [get, set]
 
UInt16 liveEntityMeasuredSpeed [get, set]
 
string hostGlobalId [get, set]
 
ConstituentPartNature partNature [get, set]
 
ConstituentPartPosition partPosition [get, set]
 
ConstituentPartStationName stationName [get, set]
 
UInt16 stationNumber [get, set]
 
Vector3f relativePosition [get, set]
 
float range [get, set]
 
float bearing [get, set]
 
List< PStruct > propulsionSystemsData [get, set]
 
List< VNStruct > vectoringNozzleSystemsData [get, set]
 
- Properties inherited from Message
String name [get]
 
double timeStamp [get, set]
 

Static Private Member Functions

static EntityStateMessage ()
 

Private Attributes

string myId = ""
 
string myEntityIdentifier = ""
 
EntityType myType =new EntityType()
 
EntityType myGuise =new EntityType()
 
double myLastSetTime
 
Vector3d myWorldPosition
 
Vector3f myWorldVelocity
 
Vector3f myWorldAcceleration
 
TaitBryan myWorldOrientation
 
Vector3f myRotationalVelocity
 
DeadReckoningAlgorithm myDeadReckoningType
 
bool myFrozenBit
 
ForceType myForceType
 
string myMarkingText = ""
 
UInt32 myAppearanceBits
 
UInt32 myCapabilityBits
 
LifeformState myLifeformState
 
List< ArtPart > myArticulatedParts =new List<ArtPart>()
 
List< AttPart > myAttachedParts =new List<AttPart>()
 
UInt16 myInfraredSignatureIndex
 
UInt16 myAcousticSignatureIndex
 
UInt16 myLiveEntityMeasuredSpeed
 
string myHostGlobalId = ""
 
ConstituentPartNature myPartNature
 
ConstituentPartPosition myPartPosition
 
ConstituentPartStationName myStationName
 
UInt16 myStationNumber
 
Vector3f myRelativePosition
 
float myRange
 
float myBearing
 
List< PStruct > myPropulsionSystemsData =new List<PStruct>()
 
List< VNStruct > myVectoringNozzleSystemsData =new List<VNStruct>()
 

Additional Inherited Members

- Static Public Member Functions inherited from Message
static Message decode (ref Byte[] bytes)
 
- Static Protected Member Functions inherited from Message
static Message createMessage (ref byte[] b)
 
- Protected Attributes inherited from Message
String myName
 
double myTimeStamp = -1.0
 
Type myTypeInfo
 

Member Enumeration Documentation

enum EntityStateMessage.CamoflageType
Enumerator
DESERT 
WINTER 
FOREST 
enum EntityStateMessage.ComplianceState
Enumerator
NA 
DETAINED 
SURRENDER 
USING_FISTS 
VERBAL_ABUSE1 
VERBAL_ABUSE2 
VERBAL_ABUSE3 
PASSIVE_RESISTANCE1 
PASSIVE_RESISTANCE2 
PASSIVE_RESISTANCE3 
NON_LETHAL_WEAPON1 
NON_LETHAL_WEAPON2 
NON_LETHAL_WEAPON3 
NON_LETHAL_WEAPON4 
NON_LETHAL_WEAPON5 
NON_LETHAL_WEAPON6 
enum EntityStateMessage.ConstituentPartNature
Enumerator
OTHER 
HOST_FIREABLE_MUNITION 
MUNITION_CARRIED_AS_CARGO 
FUEL_CARRIED_AS_CARGO 
GUNMOUNT_ATTACHED_TO_HOST 
COMPUTER_GENERATED_FORCES_CARRIED_AS_CARGO 
VEHICLE_CARRIED_AS_CARGO 
EMITTER_MOUNTED_ON_HOST 
MOBILE_COMMAND_AND_CONTROL_ENTITY_CARRIED_ABOARD_HOST 
ENTITY_STATIONED_AT 
TEAM_MEMBER_IN_FORMATION_WITH 
enum EntityStateMessage.ConstituentPartPosition
Enumerator
OTHER 
ON_TOP_OF 
INSIDE 
enum EntityStateMessage.ConstituentPartStationName
Enumerator
OTHER 
AIRCRAFT_WINGSTATION 
SHIPS_FORWARD_GUNMOUNT_STARBOARD 
SHIPS_FORWARD_GUNMOUNT_PORT 
SHIPS_FORWARD_GUNMOUNT_CENTERLINE 
SHIPS_AFT_GUNMOUNT_STARBOARD 
SHIPS_AFT_GUNMOUNT_PORT 
SHIPS_AFT_GUNMOUNT_CENTERLINE 
FORWARD_TORPEDO_TUBE 
AFT_TORPEDO_TUBE 
BOMB_BAY 
CARGO_BAY 
TRUCK_BED 
TRAILER_BED 
WELL_DECk 
ON_STATION_RNG_BRG 
ON_STATION_XYZ 
enum EntityStateMessage.DamageState
Enumerator
NONE 
SLIGHT 
MODERATE 
DESTROYED 
enum EntityStateMessage.DeadReckoningAlgorithm
Enumerator
OTHER 
STATIC 
FPW 
RPW 
RVW 
FVW 
FPB 
RPB 
RVB 
FVB 
enum EntityStateMessage.ForceType
Enumerator
OTHER 
FRIENDLY 
OPPOSING 
NEUTRAL 
enum EntityStateMessage.HatchState
Enumerator
NA 
CLOSED 
POPPED 
POPPEDANDPERSON 
OPEN 
OPENANDPERSON 
enum EntityStateMessage.LifeformState
Enumerator
NA 
STANDING 
WALKING 
RUNNING 
KNEELING 
PRONE 
CRAWLING 
SWIMMING 
PARACHUTING 
JUMPING 
SITTING 
SQUATTING 
CROUCHING 
WADING 
SURRENDERED 
DETAINED 
enum EntityStateMessage.LightType
Enumerator
LIGHTS 
HEAD_LIGHTS 
FLASH_LIGHTS 
LANDING_LIGHTS 
RUNNING_LIGHTS 
TAIL_LIGHTS 
NAVIGATION_LIGHTS 
ANTI_COLLISION_LIGHTS 
BRAKE_LIGHTS 
FORMATION_LIGHTS 
BLACK_OUT_LIGHTS 
BLACK_OUT_BRAKE_LIGHTS 
SPOT_LIGHTS 
EXTERIOR_LIGHTS 
EXTERNAL_LIGHTS 
INTERIOR_LIGHTS 
INTERNAL_LIGHTS 
enum EntityStateMessage.ParameterTypes
Enumerator
POSITION 
POSITIONRATE 
EXTENSION 
EXTENSIONRATE 
X 
XRATE 
Y 
YRATE 
Z 
ZRATE 
AZIMUTH 
AZIMUTHRATE 
ELEVATION 
ELEVATIONRATE 
ROTATION 
ROTATIONRATE 
enum EntityStateMessage.TrailingEffects
Enumerator
NONE 
SMALL 
MEDIUM 
LARGE 
enum EntityStateMessage.WeaponState
Enumerator
NOWEAPON 
STOWED 
DEPLOYED 
FIREPOSITION 

Constructor & Destructor Documentation

EntityStateMessage.EntityStateMessage ( )
inline

References Message.myName, and theFullName.

static EntityStateMessage.EntityStateMessage ( )
inlinestaticprivate

Member Function Documentation

override void EntityStateMessage.deserialize ( ref BinaryReader  reader)
inlineprotectedvirtual

Reimplemented from Message.

References myAcousticSignatureIndex, myAppearanceBits, myBearing, myCapabilityBits, myDeadReckoningType, myEntityIdentifier, myForceType, myFrozenBit, myHostGlobalId, myId, myInfraredSignatureIndex, myLastSetTime, myLifeformState, myLiveEntityMeasuredSpeed, myMarkingText, myPartNature, myPartPosition, myRange, myStationName, and myStationNumber.

override int EntityStateMessage.messageSize ( )
inlineprotectedvirtual

Reimplemented from Message.

References myArticulatedParts, myAttachedParts, myEntityIdentifier, myHostGlobalId, myId, myMarkingText, myPropulsionSystemsData, and myVectoringNozzleSystemsData.

override void EntityStateMessage.serialize ( ref BinaryWriter  writer)
inlineprotectedvirtual

Reimplemented from Message.

References makVrl.EntityType.category, makVrl.EntityType.country, makVrl.EntityType.domain, makVrl.EntityType.extra, makVrl.EntityType.kind, myAcousticSignatureIndex, myAppearanceBits, myArticulatedParts, myAttachedParts, myBearing, myCapabilityBits, myDeadReckoningType, myEntityIdentifier, myForceType, myFrozenBit, myGuise, myHostGlobalId, myId, myInfraredSignatureIndex, myLastSetTime, myLifeformState, myLiveEntityMeasuredSpeed, myMarkingText, myPartNature, myPartPosition, myPropulsionSystemsData, myRange, myStationName, myStationNumber, myType, myVectoringNozzleSystemsData, makVrl.EntityType.specific, and makVrl.EntityType.subCategory.

Member Data Documentation

UInt16 EntityStateMessage.myAcousticSignatureIndex
private

Referenced by deserialize(), and serialize().

UInt32 EntityStateMessage.myAppearanceBits
private

Referenced by deserialize(), and serialize().

List<ArtPart> EntityStateMessage.myArticulatedParts =new List<ArtPart>()
private

Referenced by messageSize(), and serialize().

List<AttPart> EntityStateMessage.myAttachedParts =new List<AttPart>()
private

Referenced by messageSize(), and serialize().

float EntityStateMessage.myBearing
private

Referenced by deserialize(), and serialize().

UInt32 EntityStateMessage.myCapabilityBits
private

Referenced by deserialize(), and serialize().

DeadReckoningAlgorithm EntityStateMessage.myDeadReckoningType
private

Referenced by deserialize(), and serialize().

string EntityStateMessage.myEntityIdentifier = ""
private

Referenced by deserialize(), messageSize(), and serialize().

ForceType EntityStateMessage.myForceType
private

Referenced by deserialize(), and serialize().

bool EntityStateMessage.myFrozenBit
private

Referenced by deserialize(), and serialize().

EntityType EntityStateMessage.myGuise =new EntityType()
private

Referenced by serialize().

string EntityStateMessage.myHostGlobalId = ""
private

Referenced by deserialize(), messageSize(), and serialize().

string EntityStateMessage.myId = ""
private

Referenced by deserialize(), messageSize(), and serialize().

UInt16 EntityStateMessage.myInfraredSignatureIndex
private

Referenced by deserialize(), and serialize().

double EntityStateMessage.myLastSetTime
private

Referenced by deserialize(), and serialize().

LifeformState EntityStateMessage.myLifeformState
private

Referenced by deserialize(), and serialize().

UInt16 EntityStateMessage.myLiveEntityMeasuredSpeed
private

Referenced by deserialize(), and serialize().

string EntityStateMessage.myMarkingText = ""
private

Referenced by deserialize(), messageSize(), and serialize().

ConstituentPartNature EntityStateMessage.myPartNature
private

Referenced by deserialize(), and serialize().

ConstituentPartPosition EntityStateMessage.myPartPosition
private

Referenced by deserialize(), and serialize().

List<PStruct> EntityStateMessage.myPropulsionSystemsData =new List<PStruct>()
private

Referenced by messageSize(), and serialize().

float EntityStateMessage.myRange
private

Referenced by deserialize(), and serialize().

Vector3f EntityStateMessage.myRelativePosition
private
Vector3f EntityStateMessage.myRotationalVelocity
private
ConstituentPartStationName EntityStateMessage.myStationName
private

Referenced by deserialize(), and serialize().

UInt16 EntityStateMessage.myStationNumber
private

Referenced by deserialize(), and serialize().

EntityType EntityStateMessage.myType =new EntityType()
private

Referenced by serialize().

List<VNStruct> EntityStateMessage.myVectoringNozzleSystemsData =new List<VNStruct>()
private

Referenced by messageSize(), and serialize().

Vector3f EntityStateMessage.myWorldAcceleration
private
TaitBryan EntityStateMessage.myWorldOrientation
private
Vector3d EntityStateMessage.myWorldPosition
private
Vector3f EntityStateMessage.myWorldVelocity
private
const String EntityStateMessage.theFullName ="EntityStateMessage"

Referenced by EntityStateMessage().

Property Documentation

UInt16 EntityStateMessage.acousticSignatureIndex
getset
UInt32 EntityStateMessage.appearanceBits
getset
List<ArtPart> EntityStateMessage.articulatedParts
getset
List<AttPart> EntityStateMessage.attachedParts
getset
float EntityStateMessage.bearing
getset
UInt32 EntityStateMessage.capabilityBits
getset
DeadReckoningAlgorithm EntityStateMessage.deadReckoningType
getset
string EntityStateMessage.entityIdentifier
getset
ForceType EntityStateMessage.forceType
getset
bool EntityStateMessage.frozenBit
getset
EntityType EntityStateMessage.guise
getset
string EntityStateMessage.hostGlobalId
getset
string EntityStateMessage.id
getset
UInt16 EntityStateMessage.infraredSignatureIndex
getset
double EntityStateMessage.lastSetTime
getset
LifeformState EntityStateMessage.lifeformState
getset
UInt16 EntityStateMessage.liveEntityMeasuredSpeed
getset
string EntityStateMessage.markingText
getset
ConstituentPartNature EntityStateMessage.partNature
getset
ConstituentPartPosition EntityStateMessage.partPosition
getset
List<PStruct> EntityStateMessage.propulsionSystemsData
getset
float EntityStateMessage.range
getset
Vector3f EntityStateMessage.relativePosition
getset
Vector3f EntityStateMessage.rotationalVelocity
getset
ConstituentPartStationName EntityStateMessage.stationName
getset
UInt16 EntityStateMessage.stationNumber
getset
string EntityStateMessage.theName
staticget

Referenced by makVrl.ReflectedEntityList.Dispose(), listen_Sharp.listen.init(), and makVrl.ReflectedEntityList.ReflectedEntityList().

EntityType EntityStateMessage.type
getset
List<VNStruct> EntityStateMessage.vectoringNozzleSystemsData
getset
Vector3f EntityStateMessage.worldAcceleration
getset
TaitBryan EntityStateMessage.worldOrientation
getset
Vector3d EntityStateMessage.worldPosition
getset
Vector3f EntityStateMessage.worldVelocity
getset
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Oct 16 00:12:25 EDT 2025 from SVN revision 280738
Copyright © 1992-2025 MAK Technologies. All Rights Reserved (www.mak.com)