event_pipe

event_pipe … end_event_pipe
event_pipe
   file <file-name>
   use_preset [ default | low | high | full ]
   disable <group-name>
   enable <group-name>
   maximum_mover_update_interval <time-value>
   entity_state_angle_threshold <angle-value>
   entity_state_position_threshold <length-value>
   disable_entity_state_thresholds
   entity_state_maximum_interval <time-value>
   visual_part_update_interval <time-value>
end_event_pipe

Overview

The event_pipe block allows the user to create a binary recording of simulation events.

Commands

file <file-name>

Specifies the name of the file to which the event recording is written. If the file already exists then it will be overwritten.

Note

To insert the run number in the file name use “%d”.

For example:

file events_%d.aer
use_preset [ default | low | high | full ]

Configures the messages that will be output. By default, the default preset is used. The messages output presets are as follows:

default & low:

  • BASE_DATA

  • ENTITY_STATE

  • DRAW

  • DETECTION_CHANGE

  • COMMENT

  • TRACK

  • XIO

  • AUX_DATA

  • ROUTE_CHANGED

  • ZONES

high:

  • BASE_DATA

  • ENTITY_STATE

  • DRAW

  • DETECTION_CHANGE

  • COMMENT

  • TRACK

  • XIO

  • AUX_DATA

  • ROUTE_CHANGED

  • TRACK_UPDATE

  • COMM_INFO

  • MESSAGE_RECEIVED

  • MESSAGE_TRANSMITTED

  • MESSAGE_HOP

  • BEHAVIOR_TREE

full:

  • BASE_DATA

  • ENTITY_STATE

  • DRAW

  • DETECTION_CHANGE

  • COMMENT

  • TRACK

  • XIO

  • AUX_DATA

  • ROUTE_CHANGED

  • TRACK_UPDATE

  • COMM_INFO

  • MESSAGE_RECEIVED

  • MESSAGE_TRANSMITTED

  • MESSAGE_HOP

  • BEHAVIOR_TREE

  • DETECTION_ATTEMPT

disable <group-name>
enable <group-name>

Specifies the names of the event groups to be included or excluded in the file. These commands are typically specified multiple times to select the events of interest. The commands are processed in order of appearance with each successive command selecting or deselecting events as appropriate.

The groups are listed below with the events associated with them.

BASE_DATA

ENTITY_STATE

DETECTION_CHANGE

TRACK

TRACK_UPDATE

DETECTION_ATTEMPT

DRAW

MESSAGE_RECEIVED

MESSAGE_TRANSMITTED

MESSAGE_HOP

COMM_INFO

COMMENT

XIO

AUX_DATA

ROUTE_CHANGED

ZONES

BEHAVIOR_TREE

maximum_mover_update_interval <time-value>

If this value is less than a mover’s update_interval, the mover will use this value instead. If this value is set to 0, the event_pipe will take no active role in mover update timing, which may cause odd behavior in movers with no update-interval.

Default: 5 seconds

entity_state_angle_threshold <angle-value>

Specifies an angle threshold to control entity-state publish rates. Every time a mover is updated, the previous orientation will be compared to the current orientation, and if the difference does not exceed the threshold, a new entity state will be ignored.

Default: 3 degrees

entity_state_position_threshold <length-value>

Specifies a length threshold to control entity-state publish rates. Every time a mover is updated, the extrapolated previous location will be compared to the current location, and if the length between them does not exceed the threshold, a new entity state will be ignored.

Default: 1 meter

disable_entity_state_thresholds

Disables the entity-state thresholds, causing entity-state to be published at the movers’ update intervals. This may be overwritten by further calls to entity_state_position_threshold or entity_state_angle_threshold.

entity_state_maximum_interval <time-value>

Specifies a maximum interval of time between entity-state updates. If a platform does not receive an update to its location within this interval, a new state, extrapolated from the last state, will be published.

Default: 10 seconds

visual_part_update_interval <time-value>

Specifies the update period at which visual part articulations will be published. Time values should be greater than zero. If unset, visual parts’ articulations will not be published.

Default: 0 seconds

Example

The following would show all events except those dealing with track updates

event_pipe
   file events.aer
   use_preset full
   disable TRACK_UPDATED
end_event_pipe

Messages

MsgEntityState

  • double simTime

  • uint8 simIndex

  • unsigned int platformIndex

  • double damageFactor

  • Vec3d locationWCS

  • bool velocityWCSvalid

  • Vec3f velocityWCS

  • bool accelerationWCSvalid

  • Vec3f accelerationWCS

  • bool orientationWCSvalid

  • Vec3f orientationWCS

  • bool fuelCurrentValid

  • double fuelCurrent

  • bool machNumberValid

  • double machNumber

MsgPlatformInfo

  • double simTime

  • uint8 simIndex

  • unsigned int platformIndex

  • bool nameValid

  • string name

  • bool typesValid

  • list<string> types

  • bool sideValid

  • string side

  • bool iconValid

  • string icon

  • bool markingValid

  • string marking

  • bool spatialDomainValid

  • SpatialDomain spatialDomain

  • bool commandChainsValid

  • list<CommandChain> commandChains

  • bool categoriesValid

  • list<string> categories

  • bool disIdValid

  • DisEntityId disId

  • bool fuelCapacityValid

  • double fuelCapacity

MsgLocalTrackCreated

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • Track_Id trackId

  • bool targetIndexValid

  • unsigned int targetIndex

MsgLocalTrackUpdate

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • Track track

MsgLocalTrackDrop

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • Track_Id trackId

  • bool targetIndexValid

  • unsigned int targetIndex

MsgLocalTrackCorrelation

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • Track_Id localTrackId

  • Track_Id addedTrackId

MsgLocalTrackDecorrelation

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • Track_Id localTrackId

  • Track_Id removedTrackId

MsgSensorModeChange

  • double simTime

  • uint8 simIndex

  • unsigned int platformIndex

  • string sensorName

  • string modeName

  • bool activate

MsgPlatformStatus

  • double simTime

  • uint8 simIndex

  • unsigned int platformIndex

  • bool broken

  • bool removed

MsgPlatformAppearanceChanged

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • unsigned int appearance

MsgPartStatus

  • double simTime

  • uint8 simIndex

  • unsigned int platformIndex

  • string partName

  • PartType partType

  • bool on

  • bool broken

  • bool disabled

MsgComment

  • double simTime

  • uint8 simIndex

  • string text

  • bool platformIndexValid

  • unsigned int platformIndex

MsgDetectAttempt

  • double simTime

  • uint8 simIndex

  • bool sensorPlatformIndexValid

  • unsigned int sensorPlatformIndex

  • bool sensorNameValid

  • string sensorName

  • bool targetPlatformIndexValid

  • unsigned int targetPlatformIndex

  • bool beamValid

  • int beam

  • bool rangeErrorValid

  • float rangeError

  • bool azimuthErrorValid

  • float azimuthError

  • bool elevationErrorValid

  • float elevationError

  • bool rangeRateErrorValid

  • float rangeRateError

  • bool pdValid

  • float pd

  • bool requiredPdValid

  • float requiredPd

  • bool reportedSideValid

  • string reportedSide

  • bool reportedTypeValid

  • string reportedType

  • EM_Interaction interaction

MsgDrawCommand

MsgMessageReceived

  • double simTime

  • uint8 simIndex

  • bool xmtrPlatformIndexValid

  • unsigned int xmtrPlatformIndex

  • bool xmtrCommNameValid

  • string xmtrCommName

  • bool rcvrPlatformIndexValid

  • unsigned int rcvrPlatformIndex

  • bool rcvrCommNameValid

  • string rcvrCommName

  • bool messageTypeValid

  • string messageType

  • bool messageSubTypeValid

  • string messageSubType

  • bool messageSizeValid

  • int messageSize

  • bool serialNumberValid

  • unsigned int serialNumber

MsgMessageTransmitted

  • double simTime

  • uint8 simIndex

  • bool xmtrPlatformIndexValid

  • unsigned int xmtrPlatformIndex

  • bool xmtrCommNameValid

  • string xmtrCommName

  • bool rcvrPlatformIndexValid

  • unsigned int rcvrPlatformIndex

  • bool messageTypeValid

  • string messageType

  • bool messageSubTypeValid

  • string messageSubType

  • bool messageSizeValid

  • int messageSize

  • bool serialNumberValid

  • unsigned int serialNumber

MsgSensorDetectionChange

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • string sensorName

  • unsigned int targetIndex

  • bool detected

MsgSensorTrackCreated

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • Track_Id trackId

  • bool targetIndexValid

  • unsigned int targetIndex

  • string sensorName

MsgSensorTrackUpdate

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • Track track

MsgSensorTrackDrop

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • Track_Id trackId

  • bool targetIndexValid

  • unsigned int targetIndex

MsgSensorModeDefinition

  • double simTime

  • uint8 simIndex

  • unsigned int ownerIndex

  • string sensorName

  • string modeName

  • list<BeamDefinition> beamList

MsgPartArticulationStatus

  • double simTime

  • uint8 simIndex

  • unsigned int ownerId

  • string partName

  • PartType partType

  • Vec3f locationECS

  • Vec3f orientationECS

MsgSetDate

  • double simTime

  • uint8 simIndex

  • int year

  • int month

  • int day

  • float time

MsgVisualPartDefinition

  • double simTime

  • uint8 simIndex

  • unsigned int platformIndex

  • string partName

  • PartType partType

  • string partIcon

MsgExecData

  • double simTime

  • uint8 simIndex

  • string execPath

  • string cmdLine

  • string version

  • string features

  • string extensions

  • string timeStamp

MsgScriptData

  • double simTime

  • uint8 simIndex

  • unsigned int platformIndex

  • string key

  • MsgScriptData_Value value

MsgResource

  • double simTime

  • uint8 simIndex

  • ResourceType resourceType

  • string resourceId

  • list<string> resourceLocation

MsgMessageHop

  • double simTime

  • uint8 simIndex

  • unsigned int xmtrPlatormIndex

  • string xmtrCommName

  • unsigned int rcvrPlatformIndex

  • string rcvrCommName

  • string messageType

  • string messageSubType

  • int messageSize

  • unsigned int serialNumber

MsgXioHeartbeat

MsgAuxData

  • double simTime

  • uint8 simIndex

  • unsigned int platformIndex

  • list<AuxDataValue> auxData

MsgBookmark

  • double simTime

  • uint8 simIndex

  • double time

  • string msgType

  • string msgText

MsgRouteChanged

  • double simTime

  • uint8 simIndex

  • unsigned int platformIndex

  • vec3 location

  • float heading

  • list<Waypoint> route

MsgCircularZone

MsgEllipticalZone

MsgPolygonalZone

MsgZoneSet

MsgCommInfo

  • string commName

  • string parentPlatform

  • string commAddress

  • string commType

  • string networkName

  • string networkAddress

  • string routerName

  • string gatewayAddress

  • string gatewayCommName

  • string gatewayPlatformName

  • list<link> links

  • StringList linkAddresses

MsgRouterInfo

  • string routerName

  • string commName

  • string parentPlatform

  • string commAddress

  • string routerType

  • string gatewayAddress

  • string gatewayCommName

  • int hopLimit

  • bool useDefaultProtocol

  • bool useMulticastProtocol

MsgNetworkInfo

  • string networkName

  • string networkType

  • string networkAddress

Structures

ApplicationUniqueId

  • unsigned int a

  • unsigned int b

  • unsigned int c

CommandChain

  • string name

  • string commander

DisEntityId

  • unsigned int site

  • unsigned int application

  • unsigned int entity

Track_Id

  • int localTrackNumber

  • string ownerId

Track

  • Track_Id trackId

  • bool startTimeValid

  • double startTime

  • bool updateTimeValid

  • double updateTime

  • bool originatorIndexValid

  • unsigned int originatorIndex

  • bool sensorNameValid

  • string sensorName

  • bool sensorModeValid

  • string sensorMode

  • bool updateCountValid

  • int updateCount

  • bool originatorWCSValid

  • Vec3d originatorWCS

  • bool locationWCSValid

  • Vec3d locationWCS

  • bool rangeValid

  • float range

  • bool rangeErrorValid

  • float rangeError

  • bool bearingValid

  • float bearing

  • bool bearingErrorValid

  • float bearingError

  • bool elevationValid

  • float elevation

  • bool elevationErrorValid

  • float elevationError

  • bool rangeRateValid

  • float rangeRate

  • bool rangeRateErrorValid

  • float rangeRateError

  • bool trackQualityValid

  • float trackQuality

  • bool signalToNoiseValid

  • float signalToNoise

  • bool pixelCountValid

  • float pixelCount

  • bool spatialDomainValid

  • SpatialDomain spatialDomain

  • bool stateCovarianceValid

  • Covariance stateCovariance

  • bool targetIndexValid

  • unsigned int targetIndex

Covariance

  • unsigned char rowCount

  • unsigned char colCount

  • list<float> values

EM_Interaction

  • EM_Interaction_Status status

  • bool xmtrWCSValid

  • Vec3d xmtrWCS

  • bool rcvrWCSValid

  • Vec3d rcvrWCS

  • bool targetWCSValid

  • Vec3d targetWCS

  • bool rcvrToTargetValid

  • EM_Interaction_RelativeData rcvrToTarget

  • bool targetToRcvrValid

  • EM_Interaction_RelativeData targetToRcvr

  • bool xmtrToTargetValid

  • EM_Interaction_RelativeData xmtrToTarget

  • bool targetToXmtrValid

  • EM_Interaction_RelativeData targetToXmtr

  • bool xmtrToRcvrValid

  • EM_Interaction_RelativeData xmtrToRcvr

  • bool rcvrToXmtrValid

  • EM_Interaction_RelativeData rcvrToXmtr

  • bool rcvrBeamValid

  • EM_Interaction_BeamData rcvrBeam

  • bool xmtrBeamValid

  • EM_Interaction_BeamData xmtrBeam

  • bool maskingFactorValid

  • float maskingFactor

  • bool infraredSignatureValid

  • float infraredSignature

  • bool infraredSignatureAzimuthValid

  • float infraredSignatureAzimuth

  • bool infraredSignatureElevationValid

  • float infraredSignatureElevation

  • bool radarSignatureValid

  • float radarSignature

  • bool radarSignatureAzimuthValid

  • float radarSignatureAzimuth

  • bool radarSignatureElevationValid

  • float radarSignatureElevation

  • bool opticalSignatureValid

  • float opticalSignature

  • bool opticalSignatureAzimuthValid

  • float opticalSignatureAzimuth

  • bool opticalSignatureElevationValid

  • float opticalSignatureElevation

  • bool transmittedPowerValid

  • float transmittedPower

  • bool powerDensityAtTargetValid

  • float powerDensityAtTarget

  • bool receivedPowerValid

  • float receivedPower

  • bool rcvrNoisePowerValid

  • float rcvrNoisePower

  • bool clutterPowerValid

  • float clutterPower

  • bool interferencePowerValid

  • float interferencePower

  • bool signalToNoiseValid

  • float signalToNoise

  • bool propagationFactorValid

  • float propagationFactor

  • bool absorbtionFactorValid

  • float absorbtionFactor

  • bool detectionThresholdValid

  • float detectionThreshold

  • bool pixelCountValid

  • float pixelCount

  • bool zoomAttenuationFactorValid

  • float zoomAttenuationFactor

EM_Interaction_Status

  • bool rcvrRangeLimitsValid

  • bool rcvrRangeLimits

  • bool rcvrAltitudeLimitsValid

  • bool rcvrAltitudeLimits

  • bool rcvrAngleLimitsValid

  • bool rcvrAngleLimits

  • bool rcvrHorizonMaskingValid

  • bool rcvrHorizonMasking

  • bool rcvrTerrainMaskingValid

  • bool rcvrTerrainMasking

  • bool xmtrRangeLimitsValid

  • bool xmtrRangeLimits

  • bool xmtrAltitudeLimitsValid

  • bool xmtrAltitudeLimits

  • bool xmtrAngleLimitsValid

  • bool xmtrAngleLimits

  • bool xmtrHorizonMaskingValid

  • bool xmtrHorizonMasking

  • bool xmtrTerrainMaskingValid

  • bool xmtrTerrainMasking

  • bool signalLevelValid

  • bool signalLevel

EM_Interaction_RelativeData

  • float range

  • float trueAzimuth

  • float trueElevation

  • float apparentAzimuth

  • float apparentElevation

EM_Interaction_BeamData

  • float azimuth

  • float elevation

  • float gain

MsgDrawCommand_Item

  • DrawType drawType

  • bool idValid

  • unsigned int id

  • bool colorValid

  • unsigned int color

  • bool durationValid

  • float duration

  • bool drawSizeValid

  • unsigned char drawSize

  • bool drawStyleValid

  • unsigned char drawStyle

  • bool drawStyle2Valid

  • unsigned char drawStyle2

  • bool orientationValid

  • Vec3f orientation

  • bool axisValid

  • Vec3f axis

  • bool textValid

  • string text

  • bool vertex1Valid

  • MsgDrawCommand_Vertex vertex1

  • bool vertex2Valid

  • MsgDrawCommand_Vertex vertex2

  • bool vertex3Valid

  • MsgDrawCommand_Vertex vertex3

  • bool vertex4Valid

  • MsgDrawCommand_Vertex vertex4

MsgDrawCommand_Vertex

BeamDefinition

  • int beamId

  • float r0_range

  • int r0_rangeType

  • float minRange

  • float maxRange

  • int stabilized

  • float tilt

  • FieldOfView fov

FieldOfView

  • int shape

  • list<Vec2f> points

DrawPair

  • float threshold

  • float draw

AuxDataValue

  • string name

  • AuxDataType type

  • bool boolean

  • int integer

  • double real

  • string text

Waypoint

  • WaypointLocationType locationType

  • string label

  • double locationX

  • double locationY

  • bool altitudeValid

  • double altitude

  • bool headingValid

  • double heading

  • bool gotoIdValid

  • string gotoId

Unions

MsgScriptData_Value

  • double floating

  • int integer

  • bool boolean

  • string text

Enumerations

SpatialDomain

  • unknown

  • land

  • air

  • surface

  • subsurface

  • space

PartType

  • sensor

  • mover

  • comm

  • processor

  • visual

DrawType

  • line

  • point

  • icon

  • ellipse

  • erase

  • ellipsoid

  • quadrilateral

  • text

  • timer

MsgDrawCommand_VertexType

  • unset_vertex

  • absolute_wcs

  • relative_zero

  • relative_ecs

  • relative_ned

  • relative_ss

GeometryResult

  • in_progress

  • dud

  • target_impact

  • far_away_in_air

  • far_away_above_ground

  • far_away_ground_impact

  • target_proximity_air_burst

  • target_proximity_above_ground

  • target_proximity_ground_impact

  • part_disabled_or_destroyed

ResourceType

  • other

  • dted

  • raw_dted

  • geotiff_dem

AuxDataType

  • Unknown

  • Boolean

  • Integer

  • Real

  • Text

WaypointLocationType

  • LatitudeAndLongitude

  • RelativeOffset

CommonZoneData

  • string zoneName

  • string parentPlatform

  • string referencePlatform

  • bool isGlobal

  • ColorF lineColor

  • ColorF fillColor

  • double maxAltitude

  • double minAltitude

  • double referenceLat

  • double referenceLon

  • double heading

  • bool locationDefined

CircularZoneInfo

  • CommonZoneData commonInfo

  • double radius

  • double minRadius

  • double startAngle

  • double stopAngle

EllipticalZoneInfo

  • CommonZoneData commonInfo

  • double latAxis

  • double lonAxis

  • double minRadius

  • double startAngle

  • double stopAngle

PolygonalZoneInfo

  • CommonZoneData commonInfo

  • list<Vec2d> points

  • bool useLatLon

Advanced Behavior Tree Structures

BehaviorTreeNode

  • string filePath

  • int64 fileModTime

  • uint nodeId

  • uint treeId

  • string nodeType

  • string nodeName

  • uint numChildren

  • list<int> childrenIds

  • bool isRootNode

BehaviorTreeNodeExec

  • uint nodeId

  • string nodeName

  • NodeExecState execState

  • string tooltipText

BoolDictEntry

  • string key

  • bool value

IntDictEntry

  • string key

  • int value

DoubleDictEntry

  • string key

  • double value

StringDictEntry

  • string key

  • string value

TrackDictEntry

BehaviorTreePlatformInfo

  • string name

  • StringList types

  • string side

PlatformDictEntry

BehaviorTreeBlackboardData

Advanced Behavior Tree Messages

MsgBehaviorTree

  • index platformIndex

  • uint id

  • string treeName

  • string treeDesc

  • list<BehaviorTreeNode> nodes

MsgBehaviorTreeState

Advanced Behavior Tree Enumerations

NodeExecState

  • running

  • success

  • failure

  • idle

  • halted

  • disabled

Weapon and Task Commands

Additional weapon related <group-name>:

disable <group-name>

enable <group-name>

Specifies the names of the event groups to be included or excluded in the file. These commands are typically specified multiple times to select the events of interest. The commands are processed in order of appearance with each successive command selecting or deselecting events as appropriate.

The groups are listed below with the events associated with them.

BASE_DATA

TASK (use_preset full)

Weapon Messages

MsgWeaponTerminated

  • double simTime

  • bool geometryResultValid

  • GeometryResult geometryResult

  • bool firingPlatformIndexValid

  • unsigned int firingPlatformIndex

  • bool targetPlatformIndexValid

  • unsigned int targetPlatformIndex

  • bool intendedTargetNameValid

  • string intendedTargetName

  • bool weaponPlatformIndexValid

  • unsigned int weaponPlatformIndex

  • bool extendedResultValid

  • string extendedResult

  • bool missDistanceValid

  • float missDistance

MsgWeaponFired

  • double simTime

  • bool firingPlatformIndexValid

  • unsigned int firingPlatformIndex

  • bool targetPlatformIndexValid

  • unsigned int targetPlatformIndex

  • bool intendedTargetNameValid

  • string intendedTargetName

  • bool weaponPlatformIndexValid

  • unsigned int weaponPlatformIndex

  • bool targetTrackIdValid

  • Track_Id targetTrackId

MsgWeaponModeChange

  • double simTime

  • unsigned int platformIndex

  • string weaponName

  • string modeName

  • bool active

MsgWeaponModeDefinition

  • double simTime

  • unsigned int platformIndex

  • string weaponName

  • string modeName

  • list<BeamDefinition> beamList

MsgTaskUpdate

  • double simTime

  • MsgTaskUpdate_State state

  • int taskId

  • Track_Id trackId

  • bool taskTypeValid

  • string taskType

  • bool assignerPlatformValid

  • unsigned int assignerPlatform

  • bool assignerProcessorValid

  • string assignerProcessor

  • bool assigneePlatformValid

  • unsigned int assigneePlatform

  • bool assigneeProcessorValid

  • string assigneeProcessor

  • double assignTime

  • bool statusValid

  • string status

  • bool subStatusValid

  • string subStatus

  • bool targetIndexValid

  • int targetIndex

MsgQuantumTaskerUpdate

  • double simTime

  • int column

  • int row

  • float value

  • string taskName

  • string assetName

  • string resourceName

  • bool winner

MsgJammingRequestInitiated

  • double simTime

  • unsigned int srcPlatform

  • string weaponName

  • float frequency

  • float bandwidth

  • string technique

  • unsigned int target

MsgJammingRequestCancelled

  • double simTime

  • unsigned int srcPlatform

  • string weaponName

  • float frequency

  • float bandwidth

  • string technique

  • unsigned int target

MsgJammingRequestUpdated

  • double simTime

  • unsigned int srcPlatform

  • string weaponName

  • float frequency

  • float bandwidth

  • string technique

  • unsigned int target

Weapon and Task Enumerations

Weapon PartType

  • weapon

MsgTaskUpdate_State

  • assigned

  • completed

  • cancelled

Warlock Commands

Additional Warlock related <group-name>:

disable <group-name>

enable <group-name>

Specifies the names of the event groups to be included or excluded in the file. These commands are typically specified multiple times to select the events of interest. The commands are processed in order of appearance with each successive command selecting or deselecting events as appropriate.

The groups are listed below with the events associated with them.

HUD_DATA

USER_ACTION

Warlock Messages

MsgChatMessage

  • double simTime

  • uint8 simIndex

  • string name

  • string channel

  • string text

MsgHUD_Data

  • double simTime

  • uint8 simIndex

  • bool platformIndexValid

  • unsigned int platformIndex

  • unsigned int hudMode

MsgUserAction

  • double simTime

  • uint8 simIndex

  • string text

  • bool platformIndexValid

  • unsigned int platformIndex

SixDof Commands

Additional SixDof related <file-name>:

use_preset [ default | low | high | full ]

Configures the messages that will be output. By default, the default preset is used. The messages output presets are as follows:

full:

  • SixDof

Inside mover .. end_mover, custom data rates may be set to change how frequently certain types of P6Dof data are output to the event_pipe:

event_core_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_kinematic_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_engine_fuel_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_autopilot_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_autopilot_limits_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_control_inputs_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_control_surfaces_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_force_moment_data [ <real> <frequency-unit> | <real> <time-unit> ]

The rates can be set as either a Frequency unit (hz) or a Time interval unit (s). Messages may be turned off by setting the rate less than or equal to 0.

By default, all messages are off. The suggested rates for P6Dof messages are as follows:

Command

Message Type

Suggested Interval

event_core_data

MsgSixDofCoreData

30 Hz / 0.0333 s

event_kinematic_data

MsgSixDofKinematic

30 Hz / 0.0333 s

event_engine_fuel_data

MsgSixDofEngineFuel

10 Hz / 0.1000 s

event_autopilot_data

MsgSixDofAutopilot

1 Hz / 1.0000 s

event_autopilot_limits_data

MsgSixDofAutopilotLimits

1 Hz / 1.0000 s

event_control_inputs_data

MsgSixDofControlInputs

10 Hz / 0.1000 s

event_control_surfaces_data

MsgSixDofControlSurfaces

10 Hz / 0.1000 s

event_force_moment_data

MsgSixDofForceMoment

10 Hz / 0.1000 s

SixDof Messages

MsgSixDofCoreData

  • double altitude;

  • double vertSpeed;

  • double KCAS;

  • double KTAS;

  • double mach;

  • double heading;

  • double pitch;

  • double roll;

  • double gLoad;

  • double alpha;

  • double gAvail;

  • double speedbrakeAngle;

MsgSixDofKinematic

  • double beta;

  • double alphaDot;

  • double betaDot;

  • double yawRate;

  • double pitchRate;

  • double rollRate;

  • double dynamicPressure;

  • double nx;

  • double ny;

  • double flightPathAngle;

  • double centerGravity_x;

  • double centerGravity_y;

  • double centerGravity_z;

MsgSixDofEngineFuel

  • double fuelFlow;

  • double fuelInternal;

  • double fuelExternal;

  • double fuelInternalRemaining;

  • double fuelExternalRemaining;

  • double totalWeight;

  • bool afterburnerOn;

  • bool producingThrust;

  • bool engineOperating;

  • bool engineSmoking;

  • bool contrailing;

  • double jokerFuelState;

  • double bingoFuelState;

  • bool weightOnWheels;

MsgSixDofAutopilot

  • unsigned int platformIndex;

  • std::string activePilot;

  • std::string lateralModeName;

  • float lateralModeValue;

  • std::string verticalModeName;

  • float verticalModeValue;

  • std::string speedModeName;

  • float speedModeValue;

  • std::string currentManeuver;

MsgSixDofAutopilotLimits

  • unsigned int platformIndex;

  • double pitchGLoadMin;

  • double pitchGLoadMax;

  • double alphaMin;

  • double alphaMax;

  • double pitchRateMin;

  • double pitchRateMax;

  • double verticalSpeedMin;

  • double verticalSpeedMax;

  • double yawGLoadMax;

  • double betaMax;

  • double yawRateMax;

  • double rollRateMax;

  • double bankAngleMax;

  • double forwardAccelMin;

  • double forwardAccelMax;

  • double taxiSpeedMax;

  • double taxiYawRateMax;

MsgSixDofControlInputs

  • double stickBack;

  • double stickRight;

  • double rudderRight;

  • double throttle;

  • double speedBrakeLever;

  • double flapsLever;

  • double landingGearLever;

  • double spoilersLever;

  • double thrustReverserLever;

MsgSixDofControlSurfaces

  • StringList surfaceNames;

  • DoubleList surfaceAngles;

MsgSixDofForceMoment

  • double liftForce;

  • double dragForce;

  • double thrustForce;

  • double sideForce;

  • double yawMoment;

  • double pitchMoment;

  • double rollMoment;

Air Combat Commands

Additional Air Combat related <file-name>:

use_preset [ default | low | high | full]

Configures the messages that will be output. By default, the default preset is used. The messages output presets are as follows:

full:

  • AIRCOMBAT

Inside the WSF_SA_PROCESSOR, custom data rates may be set for each message type to change how frequently Air Combat data is output to the event_pipe:

report_interval <time-value>

engagement_data_update_interval <time-value>

flight_data_update_interval <time-value>

fuel_data_update_interval <time-value>

nav_data_update_interval <time-value>

flight_controls_data_update_interval <time-value>

weapons_data_update_interval <time-value>

track_data_update_interval <time-value>

asset_update_interval <time-value>

threat_update_interval <time-value>

group_data_update_interval <time-value>

prioritized_data_update_interval <time-value>

See also: Update Interval Commands

Air Combat Structures

EngagedTargetData

  • index targetIndex

  • float rangeMax_nm

  • float rangeNe_nm

  • float rangeMin_nm

  • float rangeCurrent_nm

  • float rangeClosureRate_kts

  • float timeToIntercept_sec

  • float timeToActive_sec

  • float targetKTAS

  • float targetAspect_deg

  • float targetAz_deg

  • float targetEl_deg

PerceivedGroup

  • string groupName

  • double centroidLat_deg

  • double centroidLon_deg

  • float centroidAlt_ft

  • float centroidHeading_deg

  • float centroidSpeed_kts

  • float radiusCurrent_nm

  • float radiusMinimum_nm

  • float simtimeAtCoast_sec

  • float maxCoastingTime_sec

  • SA_EntityPerceptionList elementList

SA_EngagementData

  • index targetIndex

  • string targetName

  • string targetType

  • float angleOff_deg

  • float aspectAngle_deg

  • float currentRange_nm

  • float currentDeltaAlt_ft

  • float trackQuality

  • string targetCID

  • float threatLevel

  • float targetValue

  • float detectionRange_nm

  • float wezDesiredRange_nm

  • float wezMinimum_nm

  • float wezMaximum_nm

  • float wezNoEscape_nm

  • float risk

  • float defensiveness

  • float urgency

  • bool tgtTracked

  • bool acceptableWez

SA_EntityPerception

  • double lat_deg

  • double lon_deg

  • float altitude_ft

  • float bearing_deg

  • float speed_kts

  • float heading_deg

  • float threatLevel

  • float targetValue

  • float risk

  • float defensiveness

  • float urgency

  • string idString

  • index perceivedIndex

  • string perceivedName

  • string perceivedType

  • uint16 flightId

  • string idFlag

  • uint8 identification

  • bool friendlyAsset

  • bool angleOnly

  • bool idIffFriend

  • bool idIffFoe

  • bool idIffNeutral

  • bool idIffUnknown

  • bool idAuxFriend

  • bool idAuxFoe

  • bool idAuxNeutral

  • bool idAuxUnknown

  • bool idSideFriend

  • bool idSideFoe

  • bool idSideNeutral

  • bool idSideUnknown

  • bool idTypeFriend

  • bool idTypeFoe

  • bool idTypeNeutral

  • bool idTypeUnknown

  • bool isHostile

  • bool altitudeValid

  • bool speedValid

  • bool headingValid

TargetTrack

  • index targetPlatformIndex

  • double lat_deg

  • double lon_deg

  • float altitude_ft

  • float bearing_deg

  • float elevation_deg

  • float range_nm

  • float rangeRate_kts

  • float targetSpeed_kts

  • float targetHdg_deg

  • float targetAspect_deg

  • string idString

  • string tgtPlatformName

  • string tgtTypeName

  • uint8 identification

  • bool latLonValid

  • bool altitudeValid

  • bool bearingValid

  • bool elevationValid

  • bool rangeValid

  • bool rangeRateValid

  • bool targetSpeedValid

  • bool targetHdgValid

  • bool targetAspectValid

  • bool idIffValid

  • bool idAuxValid

  • bool idSideValid

  • bool idTypeValid

TrackProcessorTracks

  • string trackProcessorName

  • TargetTrackList tracks

  • bool isMasterProcessor

WaypointData

  • uint8 numWaypoints

  • WaypointList waypoints

  • uint8 currentWaypoint

  • float headingBug_deg

  • float distanceToWaypoint_nm

  • float timeToWaypoint_sec

WaypointLatLon

  • float lat_deg

  • float lon_deg

WeaponNameQty

  • string weaponName

  • uint16 quantity

Air Combat Messages

MsgSA_EngagementSummaryData

  • index platformIndex

  • bool radarEmitting

  • bool jammerEmitting

  • bool otherEmitting

  • bool afterburner

  • bool contrails

  • string missionTask

  • uint8 riskAcceptable

  • float riskCurrent

  • float defensiveness

  • float urgency

  • float selfRisk

  • float flightRisk

  • float packageRisk

  • float missionRisk

  • StringList prioritizedTargetList

  • StringList prioritizedThreatList

  • StringList trackedPlatformList

  • SA_EngagementDataList engagementDataList

MsgSA_FlightKinematicsData

  • index platformIndex

  • uint16 flightId

  • string idFlag

  • double lat_deg

  • double lon_deg

  • float kcas

  • float ktas

  • float mach

  • float altBaro_ft

  • float altRadar_ft

  • float vertSpd_fpm

  • float alpha_deg

  • float beta_deg

  • float gLoad

  • float gAvail

  • float heading_deg

  • float pitch_deg

  • float roll_deg

  • float gX

  • float gY

  • string pilotType

  • bool afterburnerOn

  • bool contrailing

  • bool stallWarning

  • bool alphaValid

  • bool betaValid

  • bool kcasValid

  • bool nxValid

  • bool nyValid

  • bool nzValid

  • bool gAvailValid

MsgSA_FuelData

  • index platformIndex

  • float fuelInternal_lbs

  • float fuelExternal_lbs

  • float fuelCapInt_lbs

  • float fuelCapExt_lbs

  • float grossWgt_lbs

  • float joker_lbs

  • float bingo_lbs

  • float fuelFlow_pph

  • float normalizedFuelQty

  • float numExtTanks

  • bool dropTanksPresent

  • bool fuelValid

MsgSA_NavData

  • index platformIndex

  • WaypointData waypointData

  • bool wayptDataValid

MsgSA_FlightControlsData

  • index platformIndex

  • float stickRgtInput

  • float stickBackInput

  • float rudderRgtInput

  • float speedBrakeInput

  • float throttleInput

  • float aileronRgtNormalized

  • float aileronLftNormalized

  • float flapRgtNormalized

  • float flapLftNormalized

  • float stabilizerRgtNormalized

  • float stabilizerLftNormalized

  • float rudderRgtNormalized

  • float rudderLeftNormalized

  • float rudderRgtNormalized

  • float speedBrakeNormalized

  • float thrustNormalized

  • float landingGear

  • float throttleValid

  • float aileronsValid

  • float flapsValid

  • float twinRuddersValid

  • float singleRudderValid

MsgSA_WeaponsData

  • index platformIndex

  • WeaponList weaponList

  • string selectedWeapon

  • uint16 numSelectedWeapon

  • uint16 initialNumWeapons

  • EngagedTargetList engagedTargetList

  • uint8 numChaff

  • uint8 numFlares

  • uint8 numDecoys

  • bool weaponBayDoorsOpen

  • bool supportingWeapon

  • bool masterWarning

  • bool masterCaution

  • bool shootCueActive

  • bool shootCueBlink

  • bool masterArmActive

  • bool jammingDetected

MsgSA_TrackData

  • index platformIndex

  • TrackProcessorList trackProcessors

MsgSA_PerceivedAssetsData

  • index platformIndex

  • SA_EntityPerceptionList assetsList

MsgSA_PerceivedBogiesAndBanditsData

  • index platformIndex

  • SA_EntityPerceptionList bogiesList

  • SA_EntityPerceptionList banditsList

MsgSA_GroupsData

  • index platformIndex

  • PerceivedGroupList groupList

MsgSA_PrioritizedThreatsAndTargetsData

  • index platformIndex

  • SA_EntityPerceptionList prioritizedThreatsList

  • SA_EntityPerceptionList prioritizedTargetsList

P6Dof Commands

Additional P6Dof related <file-name>:

use_preset [ default | low | high | full ]

Configures the messages that will be output. By default, the default preset is used. The messages output presets are as follows:

full:

  • P6DOF

Inside mover .. end_mover, custom data rates may be set to change how frequently certain types of P6Dof data are output to the event_pipe:

event_core_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_kinematic_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_engine_fuel_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_autopilot_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_autopilot_limits_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_control_inputs_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_control_surfaces_data [ <real> <frequency-unit> | <real> <time-unit> ]

event_force_moment_data [ <real> <frequency-unit> | <real> <time-unit> ]

The rates can be set as either a Frequency unit (hz) or a Time interval unit (s). Messages may be turned off by setting the rate less than or equal to 0.

By default, all messages are off. The suggested rates for P6Dof messages are as follows:

Command

Message Type

Suggested Interval

event_core_data

MsgP6dofCoreData

30 Hz / 0.0333 s

event_kinematic_data

MsgP6dofKinematic

30 Hz / 0.0333 s

event_engine_fuel_data

MsgP6dofEngineFuel

10 Hz / 0.1000 s

event_autopilot_data

MsgP6dofAutopilot

1 Hz / 1.0000 s

event_autopilot_limits_data

MsgP6dofAutopilotLimits

1 Hz / 1.0000 s

event_control_inputs_data

MsgP6dofControlInputs

10 Hz / 0.1000 s

event_control_surfaces_data

MsgP6dofControlSurfaces

10 Hz / 0.1000 s

event_force_moment_data

MsgP6dofForceMoment

10 Hz / 0.1000 s

P6Dof Messages

MsgP6dofCoreData

  • double altitude;

  • double vertSpeed;

  • double KCAS;

  • double KTAS;

  • double mach;

  • double heading;

  • double pitch;

  • double roll;

  • double gLoad;

  • double alpha;

  • double gAvail;

  • double speedbrakeAngle;

MsgP6dofKinematic

  • double beta;

  • double alphaDot;

  • double betaDot;

  • double yawRate;

  • double pitchRate;

  • double rollRate;

  • double dynamicPressure;

  • double nx;

  • double ny;

  • double flightPathAngle;

  • double centerGravity_x;

  • double centerGravity_y;

  • double centerGravity_z;

MsgP6dofEngineFuel

  • double fuelFlow;

  • double fuelInternal;

  • double fuelExternal;

  • double fuelInternalRemaining;

  • double fuelExternalRemaining;

  • double totalWeight;

  • bool afterburnerOn;

  • bool producingThrust;

  • bool engineOperating;

  • bool engineSmoking;

  • bool contrailing;

  • double jokerFuelState;

  • double bingoFuelState;

  • bool weightOnWheels;

MsgP6dofAutopilot

  • unsigned int platformIndex;

  • std::string activePilot;

  • std::string lateralModeName;

  • float lateralModeValue;

  • std::string verticalModeName;

  • float verticalModeValue;

  • std::string speedModeName;

  • float speedModeValue;

  • std::string currentManeuver;

MsgP6dofAutopilotLimits

  • unsigned int platformIndex;

  • double pitchGLoadMin;

  • double pitchGLoadMax;

  • double alphaMin;

  • double alphaMax;

  • double pitchRateMin;

  • double pitchRateMax;

  • double verticalSpeedMin;

  • double verticalSpeedMax;

  • double yawGLoadMax;

  • double betaMax;

  • double yawRateMax;

  • double rollRateMax;

  • double bankAngleMax;

  • double forwardAccelMin;

  • double forwardAccelMax;

  • double taxiSpeedMax;

  • double taxiYawRateMax;

MsgP6dofControlInputs

  • double stickBack;

  • double stickRight;

  • double rudderRight;

  • double throttle;

  • double speedBrakeLever;

  • double flapsLever;

  • double landingGearLever;

  • double spoilersLever;

  • double thrustReverserLever;

MsgP6dofControlSurfaces

  • StringList surfaceNames;

  • DoubleList surfaceAngles;

MsgP6dofForceMoment

  • double liftForce;

  • double dragForce;

  • double thrustForce;

  • double sideForce;

  • double yawMoment;

  • double pitchMoment;

  • double rollMoment;

Space Commands

Additional Space related <file-name>:

use_preset [ default | low | high | full ]

Configures the messages that will be output. By default, the default preset is used. The messages output presets are as follows:

full:

  • SPACE

Additional Space related <group-name>:

disable <group-name>

enable <group-name>

Specifies the names of the event groups to be included or excluded in the file. These commands are typically specified multiple times to select the events of interest. The commands are processed in order of appearance with each successive command selecting or deselecting events as appropriate.

The groups are listed below with the events associated with them.

SPACE

Space Messages

MsgOrbitalElements

  • double simTime

  • unsigned int platformIndex

  • double semiMajorAxis

  • double eccentricity

  • double trueAnomaly

  • double raan (right-ascension of ascending node)

  • double inclination

  • double argumentOfPeriapsis

Cyber Commands

Additional Cyber related <file-name>:

use_preset [ default | low | high | full ]

Configures the messages that will be output. By default, the default preset is used. The messages output presets are as follows:

full:

  • CYBER

Additional Cyber related <group-name>:

disable <group-name>

enable <group-name>

Specifies the names of the event groups to be included or excluded in the file. These commands are typically specified multiple times to select the events of interest. The commands are processed in order of appearance with each successive command selecting or deselecting events as appropriate.

The groups are listed below with the events associated with them.

CYBER

Cyber Messages

MsgCyberAttackInitiated

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

MsgCyberAttackSucceeded

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

  • DrawPair successOdds

  • string reportStatus

  • DrawPair reportOdds

  • DrawPair detectOdds

MsgCyberAttackFailed

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

  • DrawPair successOdds

  • string reportStatus

  • DrawPair reportOdds

  • AttackFailReason reason

MsgCyberAttackDetected

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

MsgCyberAttackAttributed

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

MsgCyberAttackRecovery

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

  • int immunityStatus

  • DrawPair immunityOdds

MsgCyberScanInitiated

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

MsgCyberScanSucceeded

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

  • DrawPair detectOdds

MsgCyberScanFailed

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

  • DrawPair detectOdds

  • ScanFailReason reason

MsgCyberScanDetected

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

MsgCyberScanAttributed

  • double simTime

  • unsigned int ownerIndex

  • unsigned int victimIndex

  • string attackType

Cyber Enumerations

AttackFailReason

  • Random_draw

  • Immunity

  • Blocked_by_scan

  • Not_vulnerable

  • none

ScanFailReason

  • Immunity

  • Detected

  • Not_vulnerable

  • none