event_output

event_output … end_event_output
event_output
   file [ <file-name> | STDOUT | NULL]
   lat_lon_format d[:m[:s]][.#]
   time_format [[h:]m:]s[.#]
   print_eci_locations <boolean>
   print_failed_message_delivery_attempts <boolean>
   print_failed_sensor_detection_attempts <boolean>
   print_single_line_per_event <boolean>
   print_track_in_message <boolean>
   print_track_covariance <boolean>
   print_track_residual_covariance <boolean>
   flush_output <boolean>
   disable [ <event> | all ]
   enable [ <event> | all ]
end_event_output

Overview

The event_output block allows the user to create a time-stamped file of simulation events. The general output of a given event varies based on the number of parties involved. This is detailed in General Format.

General Format

One-party event:

 
<time> <event> <party-1> <extra-data>

Two-party event:

 
<time> <event> <party-1> <party-2> <extra-data>

Three-party event:

 
<time> <event> <party-1> <party-2> <party-3> <extra-data>

Examples:

General Breakdown

An event within the file is composed of a logical line which may be one or more physical lines. If a physical line ends in a backslash (\), then the logical line continues on the next line. A logical line ends when a physical line is read that does not end in a backslash (\).

Field

Description

<time>

The current simulation time

<event>

The event name

<party-1>

The subject platform name (where the event originates)

<party-2>

The object platform name

<party-3>

The non-subject, non-object platform name relating to the event

<extra-data>

Any other pertinent data

Note

This Field’s format varies by event. Contact development if additional event data is needed.

Event Index

Commands

file [ <file-name> | STDOUT | NULL]

Specifies the name of the file to which the event_output is written. If the file already exists, then it will be overwritten. The special name STDOUT indicates the event_output is to be written to standard output. The special name NULL indicates that no event_output is to be written. NULL can be used to cancel a file name specified in an earlier event_output block.

Warning

The simulation will fail and event_output will not output anything if the directory path provided here does not exist.

Note

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

For example:

file events.evt
file events%d.evt   //with the run number
flush_output <boolean>

Specifies if the output buffer should be flushed after each event is written.

Note

Setting this value to ‘true’ can result in performance problems because the output is written to the output file after every event. This should only be used when attempting to diagnose problems where the program terminates abnormally and the buffer would not otherwise be flushed. This ensures that the last event that occurred is successfully recorded.

Default false

disable [ <event> | all ]
enable [ <event> | all ]

Specifies the names of the events to be included or excluded in the event log. 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.

Note

By default, all events start out as being disabled.

Warning

Be careful about using enable all. It can generate a lot of output and the addition of new events in the future could result in enormous amounts of output.

lat_lon_format d[:m[:s]][.#]

Specifies the format and number of decimal places for displaying <latitude> and <longitude>.

Default d:m:s.2

time_format [[h:]m:]s[.#]

Specifies the format and number of decimal places for displaying <time>.

Default s.5

print_eci_locations <boolean>

Specifies whether position, velocity, and acceleration data are output referenced to the ECI coordinate frame. This will override the standard output of positions in LLA, and velocities and accelerations in NED coordinates.

Note

This option is primarily used for space-based simulation output analysis.

Default false

print_failed_message_delivery_attempts <boolean>

Specifies if MESSAGE_DELIVERY_ATTEMPT events should be printed if the attempt was unsuccessful.

Default true

print_failed_sensor_detection_attempts <boolean>

Specifies if SENSOR_DETECTION_ATTEMPT events should be printed if the attempt was unsuccessful. Setting this to false will dramatically reduce the event file size because only successful detection events will be printed.

Default true

print_single_line_per_event <boolean>

Specifies if each event should be printed on a single line.

Default false

print_track_in_message <boolean>

If a track is part of a message (such as in a WsfTrackMessage) then also print out the contents of the track itself.

Default false

print_track_covariance <boolean>

If covariance data is contained in a track that is being logged, the contents of the track’s covariance matrix are also logged.

Default false

print_track_residual_covariance <boolean>

If residual covariance data is contained in a track that is being logged, the contents of the track’s residual covariance matrix are also logged.

Default false

Note

The track covariance matrix is converted from WCS to originator-referenced NED, and the principal axes are computed in this coordinate system.

Sample event_output

The following event_output block:

event_output
   file events.evt
   disable all    # This is not necessary, unless the user explicitly wants to reset the event list.
   enable PLATFORM_ADDED
   enable PLATFORM_DELETED
   enable SIMULATION_STARTING
   enable SIMULATION_COMPLETE
end_event_output

Produces the following event_output in simple_scenario demo:

00:00:00.0 PLATFORM_ADDED SimpleStriker Type: BLUE_STRIKER Side: blue \
 LLA: 00:00:00.00n 00:00:00.00e 0 m Heading: 90.000 deg Pitch: 0.000 deg Roll: 0.000 deg \
 Speed: 0.000 m/s * [ 0.000 0.000 0.000 ] Acceleration: 0.000 m/s2 * [ 0.000 0.000 0.000 ]
00:00:00.0 SIMULATION_STARTING Year: 2003 Month: 6 Day: 1 Hour: 12 Minute: 0 Second: 0
00:10:01.0 SIMULATION_COMPLETE Year: 2003 Month: 6 Day: 1 Hour: 12 Minute: 10 Second: 1
00:10:01.0 PLATFORM_DELETED SimpleStriker Type: BLUE_STRIKER Side: blue Ps: 1 \
 LLA: 01:03:02.17n 02:39:42.30e 9144 m Heading: 89.993 deg Pitch: 0.000 deg Roll: 0.000 deg \
 Speed: 298.378 m/s * [ 0.000 1.000 -0.000 ] Acceleration: 0.014 m/s2 * [ 0.000 0.000 1.000 ]