<SimMission.Calculator>

This is a container element that is used to hold any calculations required for the mission. This element is used as part of the XML file used to generate a mission. Full information on this file can be found here:

 

This element has the following attributes:

 

Attribute Description Type Required
id The ID string that names the calculator String Yes
InstanceId The unique ID for the calculator, as a GUID enclosed in {}. You can find more information on GUID's here: GUIDs String Yes
VRDependency When set to TRUE, this sets the calculator as being VR dependent. Default is FALSE. Bool No
OnActivatedValue The initial value on activating the calculator. Float/Int No
OnDeactivatedValue The final value on deactivating the calculator. Float/Int No

 

It can contain the following sub-elements:

  1. <Activated>
  2. <StartValue>
  3. <CalculatorFormula>
  4. <CalculatorParameterList>
  5. <OnActivationCalculatorActions>
  6. <OnDeactivationCalculatorActions>
  7. <CalculatorActions>

 

 

<StartValue>

This sets the start value for the calculations being done in the calculator element. This element is a sub-element of <SimMission.Calculator> and has no attributes. The default value for this element is 0.

 

 

<CalculatorParameterList>

This is a container element has no attributes, and is used to define the parameters for use within the following elements:

  1. <CalculatorFormula>
  2. <SimMission.Calculator>
  3. <SimMission.AirportCalculator>

 

The parameters it contains are defined using these sub-elements:

  1. <FormulaParameter>
  2. <ReferenceParameter>
  3. <InputParameter>
  4. <RunwayParameter>
  5. <CabinServiceBehaviourParameter>
  6. <CabinServiceStateParameter>
  7. <CabinServiceGraphParameter>
  8. <ApronContextParameter>
  9. <InteractivePointParameter>
  10. <ParkingParameter>
  11. <HelipadParameter>

 

 

<FormulaParameter>

This is a sub-element of the <CalculatorParameterList> element and is used to create parameters that will be used within the calculator. The element is a container for a <CalculatorFormula> which what will perform the calculation and the result of it will be stored in the parameter, and it may also contain a <StartValue> element. The formula parameter name can be used in other RPN formulas using the X: variable identifier.

 

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes
OnActivatedValue The value when the calculator using the parameter is activated. Float/Int No
StartValue The initial value for the parameter. The default value is 0. Float/Int No

 

 

<ReferenceParameter>

This is a sub-element of the <CalculatorParameterList> element and is uses to create parameters that will be used within the calculator. The element has the following attributes:

 

Attribute Description Type Required
id String
UniqueRefId String
TemplateInstanceId String
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes
ReferenceParameterName String

 

 

<InputParameter>

This is a sub-element of the <CalculatorParameterList> element and is uses to create a parameter based on the value of a specific input event ID. The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes
InputKey The input Event IDs to use as a parameter. String False

 

 

<RunwayParameter>

This is a sub-element of the <CalculatorParameterList> element and is only used for calculations within the main <SimMission.AirportCalculator> element. This is used to retrieve a value from an airport runway, which is done by including the following sub elements:

  1. <RunwayNumber>
  2. <RunwayDesignator>
  3. <RunwayPercent>
  4. <WantedParameter>
  5. <WantedAxis>

 

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes

 

 

<RunwayNumber>

This element is used to tell the simulation what runway number to get the required parameter value from. This is a sub-element of the <RunwayParameter> element and has no attributes.

 

 

<RunwayDesignator>

This element is used to tell the simulation the designator for the runway that is being used to retrieve the parameter from. This is a sub-element of the <RunwayParameter> element and has no attributes.

 

 

<RunwayPercent>

This element is used to tell the simulation what runway number to get the required parameter value from. This is a sub-element of the <RunwayParameter> element and has no attributes.

 

 

<WantedParameter>

This element is used to define the kind of parameter that will be retrieved from the airport runway for use in calculation. Can be one of the following:

  1. RelativeDistanceToRunwayPercent
  2. RelativePlaneOrientation
  3. RunwayOrientation
  4. RunwaySize
  5. OverRunwayArea

 

This is a sub-element of the <RunwayParameter> element and has no attributes.

 

 

<CabinServiceBehaviourParameter>

This is a sub-element of the <CalculatorParameterList> element. With this calculator you can get the number of object behaviours on the given tagged node, based on the behaviour states and/or behaviour tasks, and the position in the world (inside or outside of the cabin). The element can have the following sub-elements:

  1. <ObjectReference />: The object that has the navigation service
  2. <ParamBehaviourName>: The name of the behaviour to look for
  3. <ParamBehaviourState>: The state of the behaviour to look for (this will default to any state, if omitted)
  4. <ParamBehaviourTask>: The task that the behaviour is currently doing (this will default to any task, if omitted)
  5. <ParamIsInCabin>: Specify on which behaviour objects to check (in cabin, out cabin, both)
  6. <NodeTag>: If this is included, then only those behaviour objects on the given node will be considered

 

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes

 

 

<CabinServiceStateParameter>

This is a sub-element of the <CalculatorParameterList> element and is only used for calculations where need to know if a particular navigation service is in the given state. You supply the name of the navigation service, and the state to check, and the parameter will be returned as 1 if the service is in the given state, or 0 otherwise. The element can have the following sub-elements:

  1. <ObjectReference />: The object that has the navigation service
  2. <CabinName>: The name of the service to look for
  3. <CabinState>: The state that you are checking to see if the service is in

 

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes

 

 

<CabinName>

This is a sub-element of <CabinServiceStateParameter> and <ParentCabinServiceStateParameter> and is used to supply a navigation service name to the calculator.

 

 

<CabinState>

This is a sub-element of <CabinServiceStateParameter> and <ParentCabinServiceStateParameter> and is used to supply a navigation service state to the calculator.

 

 

<CabinServiceGraphParameter>

This is a sub-element of the <CalculatorParameterList> element and is only used for calculations where you the number of tagged nodes from a specific navigation graph. The element can have the following sub-elements:

  1. <ObjectReference />: The object that has the navigation graph
  2. <NodeTag>: The node to find the number of

 

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes

 

 

<ParentCabinServiceBehaviourParameter>

This is a sub-element of the <CalculatorParameterList> element. With this calculator you can get the number of navigation services that own the given behaviour object based on the behaviour states and/or behaviour tasks, and the position in the world (inside or outside of the cabin) of the object. The element can have the following sub-elements:

  1. <ObjectReference />: The behaviour object that references the navigation service
  2. <ParamBehaviourName>: The name of the behaviour to look for
  3. <ParamBehaviourState>: The state of the behaviour to look for (this will default to any state, if omitted)
  4. <ParamBehaviourTask>: The task that the behaviour is currently doing (this will default to any task, if omitted)
  5. <ParamIsInCabin>: Specify on which behaviour objects to check (in cabin, out cabin, both)
  6. <NodeTag>: If this is included, then only those behaviour objects on the given node will be considered

 

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes

 

 

<ParentCabinServiceStateParameter>

This is a sub-element of the <CalculatorParameterList> element and is only used for calculations where need to know if a particular navigation service is in the given state by the given navigation object. You supply the name of the navigation service, and the state to check, and the parameter will be returned as 1 if the behaviour object is uses the navigation service and is in the given state, or 0 otherwise. The element can have the following sub-elements:

  1. <ObjectReference />: The behaviour object that uses the navigation service
  2. <CabinName>: The name of the service to look for
  3. <CabinState>: The state that you are checking to see if the service is in

 

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes

 

 

<ApronContextParameter>

This is a sub-element of the <CalculatorParameterList> element and is used in calculations where you require one of a few specific data points form an Apron Control context. The element can have the following sub-elements:

  1. <ObjectReference />: The reference to the Apron Control service that you want information from.
  2. <DesiredValue>: The kind of value that you wish to be returned, which can only be HEADING, XYZOFFSET, or JETWAYATTACHED. If set to JETWAYATTACHED, the <ObjectReference /> should be of the type "ApronContextReference:Context ". If set to XYZOFFSET, the <ApronControlMissionContext> element is required with an <ObjectReference /> to an <ApronControl.ApronContextReference />.
  3. <ApronControlMissionContext>: An additional context that is required when you need to retrieve the XYZOFFSET between the Apron Control context SImObject and an aircraft.
  4. <Units>: The units to use (not required).

 

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes

 

 

<ApronControlMissionContext>

This sub-element of is used to get an apron control context reference, as defined using the <ApronControl.ApronContextReference /> element in a service XML file. This element has no attributes, and requires an <ObjectReference /> with the id set to "ApronContextReference:Context".

 

 

<InteractivePointParameter>

This is a sub-element of the <CalculatorParameterList> element and is used to get data from an interactive point to be used in a calculation. This container element requires the following sub-elements:

  1. <ObjectReference />: The SimObject that contains the interactive point to search for.
  2. <InteractivePointUser>: The SimObject that is considered the "User" of the interactive point.
  3. <InteractivePoint>: This is used to find the actual interactive point that is to be used.
  4. <DesiredValue>: The kind of value that you wish to be returned.

 

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes

 

 

<InteractivePointUser>

This element is a sub-element of <InteractivePointParameter> and is used to retrieve the SimObject which is interacting with the interactive point. This element has no attributes and requires the following sub-element:

<ObjectReference />

 

 

<InteractivePoint>

This element is a sub-element of <InteractivePointParameter> and is used to find the interactive point to get the data from. This element has no attributes and requires the following sub-elements, which will be used to find the most appropriate matching interactive point:

  1. <InteractivePointType>
  2. <InteractivePointSearchPreferences>

 

 

<InteractivePointType>

This sub-element of <InteractivePoint> has no attributes and sets the type of interactive point to get from the SimObject. The available values for this element are as follows:

  1. INTERACTIVE_POINT_MAIN_EXIT
  2. INTERACTIVE_POINT_CARGO_EXIT
  3. INTERACTIVE_POINT_EMERGENCY_EXIT
  4. INTERACTIVE_POINT_GAS_TRAP
  5. INTERACTIVE_POINT_GROUND_POWER_UNIT
  6. INTERACTIVE_POINT_AIR_START_UNIT
  7. INTERACTIVE_POINT_TAILHOOK
  8. INTERACTIVE_POINT_DROP_EXIT
  9. INTERACTIVE_POINT_WINDOW
  10. INTERACTIVE_POINTS_COUNT
  11. INTERACTIVE_POINT_UNKNOWN

 

 

<InteractivePointSearchPreferences>

This sub-element of <InteractivePoint> has no attributes and sets the serach parameters to be used to find the interactive point from the SimObject. The available values for this element are as follows:

  1. DISTANCE_ONLY
  2. X_SIDE_THEN_DISTANCE
  3. Y_SIDE_THEN_DISTANCE
  4. Z_SIDE_THEN_DISTANCE

 

 

<ParkingParameter>

This is a sub-element of the <CalculatorParameterList> element and is used to retrieve a parameter value from an aircraft parking spot or a taxiway parking stand. This element can use the following sub-elements:

  1. <ParkingProperty>
  2. <ParkingName>
  3. <ParkingNumber>
  4. <ParkingSuffix>
  5. <StandType>
  6. <StandRole>

 

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes
StartValue The initial value for the parameter. The default value is 0. Float/Int No
OnActivatedValue The value when the calculator using the parameter is activated. Float/Int No
OnDeactivatedValue The final value on deactivating the calculator. Float/Int No

 

 

<ParkingProperty>

This sub-element of <ParkingParameter> has no attributes and takes one of the following strings to define what kind of value the parameter returns:

  1. Distance
  2. RelativePosition
  3. RelativeHeading
  4. Heading
  5. Radius
  6. PassengerAccessType
  7. LLA

 

 

<ParkingName>

This sub-element of <ParkingParameter> has no attributes and takes The name of the parking spot to get the information from.

 

 

<ParkingNumber>

This sub-element of <ParkingParameter> has no attributes and takes the number of the parking spot to get the information from.

 

 

<ParkingSuffix>

This sub-element of <ParkingParameter> has no attributes and takes the suffix of the parking spot to get the information from.

 

 

<StandType>

This sub-element of <ParkingParameter> has no attributes and takes one of the following strings to define what kind of value the parameter returns:

  1. RAMP
  2. BUS
  3. CATERING_TRUCK
  4. BAGGAGE_LOADER
  5. BAGGAGE_CART
  6. GPU
  7. FUEL_TRUCK
  8. PUSHBACK

 

 

<StandRole>

This sub-element of <ParkingParameter> has no attributes and takes takes one of the following strings to define what kind of value the parameter returns:

  1. PARKING
  2. GATE
  3. PLANE

 

 

<HelipadParameter>

This is a sub-element of the <CalculatorParameterList> element and is used to retrieve a parameter value from a helicopter parking spot. This element can use the following sub-elements:

  1. <HelipadProperty>
  2. <WantedAxis>

The element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes
StartValue The initial value for the parameter. The default value is 0. Float/Int No
OnActivatedValue The value when the calculator using the parameter is activated. Float/Int No
OnDeactivatedValue The final value on deactivating the calculator. Float/Int No

 

 

<HelipadProperty>

This is a sub-element of the <HelipadParameter> element and has no attributes. It takes one of the following strings to define what kind of value the parameter returns:

  1. RelativePosition
  2. RelativeOrientation
  3. Orientation
  4. Size
  5. OverHelipadArea

 

 

<CalculatorFormula>

This container element is used to create an RPN formula that will generally resolve to TRUE or FALSE, depending on the main element that is calling it. This element has no attributes and can be used within the following elements:

  1. <SimMission.Calculator>
  2. <SimMission.AirportCalculator>
  3. <CalculatorAction>
  4. <FormulaParameter>

 

 

<CalculatorActions>

This element has no attributes and is used to contain one or more <CalculatorAction> elements. It is a sub-element of the following:

  1. <CalculatorFormula>
  2. <SimMission.Calculator>
  3. <SimMission.AirportCalculator>

 

 

<OnActivationCalculatorActions>

This element has no attributes and is used to contain one or more <CalculatorAction> elements. It is a sub-element of the main <SimMission.Calculator>, and is used to define the actions to be performed when the calculator is activated.

 

 

<OnDeactivationCalculatorActions>

This element has no attributes and is used to contain one or more <CalculatorAction> elements. It is a sub-element of the main <SimMission.Calculator>, and is used to define the actions to be performed when the calculator is deactivated.

 

 

<CalculatorAction>

This is a container element that is used to define a single calculator action, usually as part of a larger list of <CalculatorActions>. It must contain at least a <CalculatorFormula> sub-element and an <Actions> sub-element (with at least one <ObjectReference />). The formula within the calculator action will be performed and if it resolves as TRUE then the action(s) will be performed. This element has the following attributes:

 

Attribute Description Type Required
NameInFormula The ID string that names the parameter to be used in the RPN calculator formula. String Yes
StartValue The initial value for the parameter. The default value is 0. Float/Int No
OnActivatedValue The value when the calculator using the parameter is activated. Float/Int No
OnDeactivatedValue The final value on deactivating the calculator. Float/Int No

 

The element can have any of the following additional sub-elements:

  1. <Actions>
  2. <CalculatorFormula>
  3. <DeactivateAfterExecution>
  4. <OnActionCompleteFormula>

 

 

<Actions>

This container element is used to define one or more <ObjectReference /> elements as the action(s) to be performed when a <CalculatorFormula> resolves as TRUE. It has no attributes, and is included as a sub-element of <CalculatorAction>.

 

 

<DeactivateAfterExecution>

This sub-element of <CalculatorAction> is used to set whether the action container should be deactivated (set to TRUE) after the calculation has been performed or not (set to FALSE). This element has no attributes, and the default value is FALSE.

 

 

<OnActionCompleteFormula>

This sub-element of <CalculatorAction> is used to define the RPN formula that should be executed at the end of the queued up actions. The element has no attributes and no default value.

 

 

<DesiredValue>

This element has no attributes and is used to set what kind of value is desired from the calculator parameter action being performed. It is used by the following parameters:

  1. <InteractivePointParameter>
  2. <ApronContextParameter>

 

The element can take any of the following strings to define the value returned:

  1. LLA: A vector representing the latitude, longitude and altitude of the SimObject
  2. HEADING: The heading of the SimObject.
  3. PBH: The pitch, bank and heading values for the SimObject
  4. XYZOFFSET: A vector representing the distance between the SimObject that requested the context and the other SimObject being targetted (eg: an aircraft and a ramp).
  5. JETWAYATTACHED: Whether the jetway of the parking stand of the current context is attached to the aircraft or not.

 

 

<Units>

This element has no attributes and is used to define the units of the value that is being retrieved. This element can be used by the following parent elements:

  1. <ApronContextParameter>
  2. <InteractivePointParameter>

 

The element can take any of the following strings to define the value returned:

  1. number
  2. feet
  3. g_force
  4. knots
  5. pounds
  6. percent
  7. boolean
  8. degrees
  9. radians
  10. RPM
  11. PSF
  12. InHG
  13. gallons
  14. radianspersecond
  15. feetpersecond

 

 

<WantedAxis>

This element has no attributes and is a sub-element of the following:

  1. <RunwayParameter>
  2. <HelipadParameter>

 

The element defines the axis of the parameter to be retrieved and can be any one of the following:

  1. AxisX
  2. AxisY
  3. AxisZ
  4. AxisPitch
  5. AxisBank
  6. AxisHeading

 

Related Topics

  1. Flight And Mission XML Files
  2. Mission XML Properties
  3. Reverse Polish Notation
  4. The_Flight_Editor