WSF Reference Guide¶
Core Applications¶
- Post Processing & Report Generation
- Sensor Coverage & Antenna Gain Plot Creation
- Weapon Engagement Analysis Support
- Weapon Model Development Support
- Mission Analysis / Baseline Simulation Application
Simulation Runtime¶
clock_rate - Specify the ratio of simulation time to wall clock time for real-time simulations.
conditional_section - Conditionally include or exclude inputs.
end_time - Specify the end time of a simulation run.
generate_random_seeds - Generate random seeds for a Monte Carlo iteration set.
initial_run_number - Specify the initial run number of a Monte Carlo iteration set.
final_run_number - Specify the final run number of a Monte Carlo iteration set.
frame_rate - Define the time step of a frame-stepped simulation.
frame_time - Define the time step of a frame-stepped simulation.
line_of_sight_manager - Line-of-sight manager configuration.
multi_threading or multi_thread - Define if multi-threading is active.
non-realtime - Indicate the simulation is to run in non-real-time mode.
number_of_threads - Define the number of threads.
platform_availability - Define a platform’s probability of existing in the simulation at runtime.
random_seed - Specify the seed for the random number generator.
realtime - Indicate the simulation is to run in real-time mode.
run_number_increment - Specify the increment between runs of a Monte Carlo iteration set.
simulation_name - Specify a name to identify the simulation within Warlock and Mystic.
start_date, start_epoch, start_time - Define the base or reference time for the simulation.
File, Input and Output¶
File and Input¶
classification_levels - Defines the classification levels, and their respective colors, that can be used within a scenario.
classification - Specifies the classification level, caveats, and trigraphs of the input files.
define_path_variable - Define a variable that can be substituted into file names.
file_path - Specify a path for include files.
include and include_once - Insert a file into the input stream.
log - Write an entry to the log file.
log_file - Open a log file.
reset_file_path - Remove all entries from the ‘file path’.
undefine_path_variable - Undefine a ‘path’ variable.
Output¶
console_output - Configure the console output contents and format.
csv_event_output - Configure the ‘Comma Separate Values (CSV)’ event output logger.
draw - Draw routes and route networks.
enumerate - Enumerate (list) object types to a file.
event_output - Configure the event output logger.
observer - Capture results of a specific interaction between platforms at the simulation level.
event_pipe - Configure the binary AFSIM event recording file.
Terrain and Environment¶
atmosphere - Modify the atmospheric characteristics (e.g., temperature, density) in the simulation.
global_environment - Define the attributes of the global environment.
terrain - Control the terrain management interface.
Defining Systems, Subsystems, Models and Data¶
Defining Systems (Platforms)¶
platform and platform_type - Define platform types and instances.
osm_traffic - Generate background vehicular traffic with an Open Street Maps (OSM) converted route.
road_traffic - Generate background vehicular traffic.
sea_traffic - Generate background ship platforms.
air_traffic - Generate background air traffic.
Defining Subsystems (comm, sensors, processors, etc.)¶
comm - Define comm objects types and instances. (Predefined Comm Types)
processor - Define processor types and instances. (Predefined Processor Types)
mover - Define mover object types and instances. (Predefined Mover Types)
router - Define communication router types and instances. (Predefined Router Types)
sensor - Define sensor object types and instances. (Predefined Sensor Types)
track_manager - Configure track maintenance and fusion for a platform’s master track list or alternate track list.
visual_part - Defines articulated parts not associated with a defined subsystem.
Defining Models & Data¶
aero - Define the aerodynamic drag and lift properties of a platform that moves through air.
antenna_pattern - Define an antenna gain pattern for a transmitter or receiver.
attenuation_model - Define or reference an atmospheric attenuation model.
clutter_model - Define or reference a clutter model.
error_model - Define or reference a sensor error model.
filter - Define a filter object for a sensor or track_manager. (Predefined Filter Types)
group - Define a group that can contain platforms and/or platform parts.
fuel - Define fuel object types and instances. (Predefined Fuel Types)
iff_mapping - Define global IFF mappings.
medium - Define a communication medium, used by various communication objects. (Predefined Medium Types)
message_table - Define a message table.
network - Define a communication network. (Predefined Network Types)
noise_cloud - Define a cloud layer for the attenuation of sensors and communications.
propagation_model - Define or reference a propagation model.
protocol - Define a comm protocol, for subsequent usage by a comm object. (Predefined Protocol Types)
radar_signature - Define the radar signature for a platform.
route - Define the movement path for a route mover.
route_network - Define a network of routes.
router_protocol - Define a routing protocol, for subsequent usage by a router object. (Predefined Router Protocol Types)
track - Define a ‘pre-brief’ track.
zone and zone_set - Define regions or a collection of regions.
Scripting¶
Scripting Language - Script Overview, Script Commands, Common Script Interface, Script Object Types
Interface¶
dis_interface - Distributed Interactive Simulation (DIS) configuration.
xio_interface - Control the ‘external I/O’ interface.
Multiresolution¶
Each multiresolution model defines a container for holding one or more models on a platform. The choice of which model to use is deferred to simulation time, and depends on the chosen fidelity value.
multiresolution_comm - Multiresolution container for comm models.
multiresolution_fuel - Multiresolution container for fuel models.
multiresolution_mover - Multiresolution container for movers.
multiresolution_processor - Multiresolution container for processors.
multiresolution_sensor - Multiresolution container for sensors.
multiresolution_acoustic_signature - Multiresolution container for acoustic signatures.
multiresolution_infrared_signature - Multiresolution container for infrared signatures.
multiresolution_optical_signature - Multiresolution container for optical signatures.
multiresolution_radar_signature - Multiresolution container for radar signatures.
multiresolution_multirun_table - Defines a multirun table of fidelity values. These fidelity values may be specified for any platform/model combination in the scenario. The multirun functionality works in conjunction with the final_run_number command.
Space¶
propagator - Specify a propagator type for use in tracking satellites (Orbit Determination Fusion; Orbit Determination Filter).
Coverage¶
Coverage Overview - An overview of AFSIM’s coverage capability.
grid - Define grids over which coverage can be computed (Predefined Coverage Grid Types).
coverage - Define coverage computations (Predefined Coverage Types).
SIMDIS¶
simdis_interface - Define SIMDIS ASI file output configuration
OMS_UCI¶
The Open Mission Systems Universal Command and Control Interface, or OMS/UCI is a messaging system that allows platforms and their components to communicate to each other.
uci_component - The base component that enables a component to send UCI messages.
Annotations¶
visual_elements - Define annotations that will be displayed in visual applications.
Military¶
acoustic_signature - Define the acoustic signature of a platform
infrared_signature - Define the infrared signature of a platform.
inherent_contrast - Define the inherent contrast of a platform.
optical_reflectivity - Define the optical reflectivity for a platform.
optical_signature - Define the optical signature (projected area) for a platform.
Electronic Warfare¶
Electronic Warfare Effect Aggregation for understanding how EW is aggregated and used in sensors and communication receivers.
electronic_warfare - Define the Electronic Warfare object types. (Predefined Electronic Warfare Types)
electronic_warfare_effect - Define the Electronic Warfare effect object types. (Predefined Electronic Warfare Effect Types)
electronic_warfare_technique - Define the Electronic Warfare technique object types. (Predefined Electronic Warfare Technique Types)
false_target - Define a false target technique for electronic attack.
false_target_screener - Define the response of a receiver to false targets.
Weapon¶
weapon - Define weapon object types and instances. (Predefined Weapon Types)
weapon_effects - Define weapon effect object types. (Predefined Weapon Effect Types)
launch_computer - Define a weapon launch computer. (Predefined Launch Computer Types)
wsf_weapon_server - Define weapon server interface.
P6DOF¶
p6dof_object_types - P6DOF (Pseudo 6DOF) type definition/configuration.
Cyber¶
Cyber Overview - An overview of the cyber warfare model.
cyber_attack - Define cyber warfare attack types.
cyber_effect - Define cyber warfare effect types. (Predefined Cyber Effect Types)
cyber_protect - Define cyber warfare protect types and instances.
cyber_trigger - Define a single or reoccurring scripted conditional check, with a scripted executor, primarily for embedded attacks. (Predefined Cyber Trigger Types)
- command
cyber_constraint - Define a resource limitation notion for cyber attacks.
enable_cyber_wsfdraw - Enable WsfDraw output for cyber warfare.
disable_cyber_wsfdraw - Disable WsfDraw output for cyber warfare (default).
RIPR¶
RIPR - Reactive Integrated Planning aRchitecture
SIXDOF¶
six_dof_object_types - Point-Mass and Rigid-Body 6DOF type definition/configuration.