SimMission Apron Control XML Properties
The element listed here are used in mission files to trigger, control, and respond to, apron services.
<SimMission.ApronControlRequestContextAction>
This element is used to create a new context and link it’s navigation service with the mission. For example:
<SimMission.ApronControlRequestContextAction InstanceId="{FF823EC0-50B9-4441-A822-79D7CC1CBD4F}">
<Descr>Requests a context to the apron control to handle the Firefighting service</Descr>
<Immediate>False</Immediate>
<ApronControlServices>
<ApronControlService Name="FirefightingService"/>
</ApronControlServices>
<TargetSection>departure</TargetSection>
<ObjectReference id="player" InstanceId="{1CCF6D89-BA36-445f-B5C8-475
</SimMission.ApronControlRequestContextAction>This element requires the following sub-elements:
<Immediate><ApronControlServices><TargetSection><TargetICAO><ObjectReference />
The element also has the following attribute:
| Attribute | Description | Type | Required |
|---|---|---|---|
InstanceId | The unique ID for reference to the element, as a GUID enclosed in {}, to be used elsewhere. You can find more information on GUID’s here: GUIDs | String | Yes |
<SimMission.ApronControlRegisterToContextAction>
This element is used to add a SimObject to the target apron control context, so it can be referenced through an <ApronControl.ApronContextReference /> element in the Apron Services XML. For example:
<SimMission.ApronControlRegisterToContextAction InstanceId="{FF823EC0-50B9-4441-A822-79D7CC1CBD4F}">
<ApronControlServices>
<ApronControlService Name="LoadWorkerService"/>
</ApronControlServices>
<TargetSection>Departure</TargetSection>
<AddToContext>
<AddToContextTarget id="ApronContextReference:PowerGenerator" InstanceId="{C53FE0CC-BD97-4235-9C37-136BEF7BAA90}"/>
<AddToContextSource id="LibraryObject:PowerGenerator">
<ObjectReference id="PowerGenerator" InstanceId="{F304D561-DFC0-40B2-A996-3F27EC8ACC1C}"/>
</AddToContextSource>
</AddToContext>
<ObjectReference id="player" InstanceId="{1CCF6D89-BA36-445f-B5C8-47571ABC0773}"/>
</SimMission.ApronControlRegisterToContextAction>This element requires the following sub-elements:
<ApronControlServices><TargetSection><AddToContext><ObjectReference />
The element also has the following attribute:
| Attribute | Description | Type | Required |
|---|---|---|---|
InstanceId | The unique ID for reference to the element, as a GUID enclosed in {}, to be used elsewhere. You can find more information on GUID’s here: GUIDs | String | Yes |
<AddToContext>
This is a sub-element of and acts as a container element for one or more <AddToContextTarget /> and/or <AddToContextSource> elements. It has no attributes.
<AddToContextTarget />
This self-closing element is a sub-element of <AddToContext> and is used to give the instance ID to be used in the Apron Service XML <ApronControl.ApronContextReference /> element (type Mission). This element has the following attributes:
| Attribute | Description | Type | Required |
|---|---|---|---|
id | This is an optional attribute that is not actually used in the simulation, but can serve as a description for the element. | String | No |
InstanceId | The unique ID for reference to the element, as a GUID enclosed in {}, to be used elsewhere. You can find more information on GUID’s here: GUIDs | String | Yes |
<AddToContextSource>
This element is a sub-element of <AddToContext> and is used to give an <ObjectReference /> to the SimObject to register. This element requires the following sub-element:
It has the following attribute:
| Attribute | Description | Type | Required |
|---|---|---|---|
id | This is an optional attribute that is not actually used in the simulation, but can serve as a description for the element. | String | No |
<SimMission.ApronControlMessageTrigger>
This element is used to trigger a message on an apron service context from a mission. For example:
<SimMission.ApronControlMessageTrigger InstanceId="{69E7F6DC-BBB6-4321-A1DA-B423588E0852}">
<Descr>Remove Water Pipe</Descr>
<Activated>True</Activated>
<OneShot>False</OneShot>
<ApronControlServices>
<ApronControlService Name="FirefightingService"/>
</ApronControlServices>
<ObjectReference id="ApronContextReference:Context" InstanceId="{8AE98AB9-8596-48CC-8400-F98758149E5F}"/>
<ApronControlMessages>
<ApronControlMessage id="REMOVE_WATER_PIPE">
<Actions>
<ObjectReference id="Deactivate Water Pipe" InstanceId="{AEA998E2-8E76-4538-8219-9B9801B6934C}"/>
</Actions>
</ApronControlMessage>
</ApronControlMessages>
</SimMission.ApronControlMessageTrigger>This element requires the following sub-elements:
<Activated><OneShot><ApronControlServices><ApronControlMessages><ObjectReference />
The element also has the following attribute:
| Attribute | Description | Type | Required |
|---|---|---|---|
InstanceId | The unique ID for reference to the element, as a GUID enclosed in {}, to be used elsewhere. You can find more information on GUID’s here: GUIDs | String | Yes |
<SimMission.ApronControlMessageAction>
This element is used to send a message to or from an Apron Control context. For example:
<SimMission.ApronControlMessageAction InstanceId="{A0B7B998-ADDF-415E-ACA8-A37168D0B0F9}">
<Descr>Power generator registered</Descr>
<ApronControlServices>
<ApronControlService Name="LoadWorkerService"/>
</ApronControlServices>
<TargetSection>icao</TargetSection>
<TargetICAO>PSUP</TargetICAO>
<ObjectReference id="player" InstanceId="{1CCF6D89-BA36-445f-B5C8-47571ABC0773}"/>
<ApronControlMessages>
<ApronControlMessage id="POWERGENERATOR_REGISTERED"/>
</ApronControlMessages>
</SimMission.ApronControlMessageAction>This element requires the following sub-elements:
<ApronControlServices><TargetSection><TargetICAO><ObjectReference /><ApronControlMessages>
The element also has the following attribute:
| Attribute | Description | Type | Required |
|---|---|---|---|
InstanceId | The unique ID for reference to the element, as a GUID enclosed in {}, to be used elsewhere. You can find more information on GUID’s here: GUIDs | String | Yes |
<SimMission2.ApronControlToggleJetway>
This element is used to attach (activate) or detach (deactivate) the jetway of the given aircraft object. Note that the id attribute for the <ObjectReference /> must be “ApronContextReference:Aircraft” and the instance GUID should be that of an assigned “Aircraft” <ApronControl.ApronContextReference />. For example:
<SimMission2.ApronControlToggleJetway InstanceId="{3633E47E-A523-4DC1-BC5A-E612A9D0BE70}">
<Descr>Toggle the jetway state for the parking in the current apron control context</Descr>
<ObjectReference id="ApronContextReference:Aircraft" InstanceId="{4AEBA072-63C6-461E-A6F9-2C7C65B3FEED}"/>
<Activated>False</Activated>
</SimMission2.ApronControlToggleJetway>This element requires the following sub-elements:
<ObjectReference /><Activated>
The element also has the following attribute:
| Attribute | Description | Type | Required |
|---|---|---|---|
InstanceId | The unique ID for reference to the element, as a GUID enclosed in {}, to be used elsewhere. You can find more information on GUID’s here: GUIDs | String | Yes |
<SimMission2.ToggleInteractivePointAction>
This element is used to open or close an interactive point such as a door or a fuel cap. Note that the id attribute for the <ObjectReference /> must be “ApronContextReference:Aircraft” and the instance GUID should be that of an assigned “Aircraft” <ApronControl.ApronContextReference />. For example:
<SimMission2.ToggleInteractivePointAction InstanceId="{95DB89D7-EDFE-4F97-81F4-44677B00BC04}">
<Descr>Open the door where the ramp attaches</Descr>
<DesiredState>Closed</DesiredState>
<ObjectReference id="ApronContextReference:Aircraft" InstanceId="{4AEBA072-63C6-461E-A6F9-2C7C65B3FEED}"/>
<InteractivePointUser>
<ObjectReference id="ApronContextReference:Ramp" InstanceId="{994DECA2-6732-4B2D-9550-3BF999A9B1B0}"/>
</InteractivePointUser>
<InteractivePoint>
<InteractivePointType>INTERACTIVE_POINT_MAIN_EXIT</InteractivePointType>
<InteractivePointSearchPreferences>X_SIDE_THEN_DISTANCE</InteractivePointSearchPreferences>
</InteractivePoint>
</SimMission2.ToggleInteractivePointAction>This element requires the following sub-elements:
<DesiredState><ObjectReference /><InteractivePointUser><InteractivePoint>
The element also has the following attribute:
| Attribute | Description | Type | Required |
|---|---|---|---|
InstanceId | The unique ID for reference to the element, as a GUID enclosed in {}, to be used elsewhere. You can find more information on GUID’s here: GUIDs | String | Yes |
<DesiredState>
This is a sub-element of and has no attributes. It is used to set the state for the interactive point, which can only be one of the following strings:
OpenClosed
<ApronControlServices>
This a container element for one or more <ApronControlService /> elements. It can be used by the following parent elements:
<SimMission.ApronControlRegisterToContextAction><SimMission.ApronControlMessageTrigger><SimMission.ApronControlMessageAction>
<ApronControlService />
This is a self closing element that is a child of <ApronControlServices> and is used to reference one of the Apron Control Services that has been registered in the Apron Control XML file. The element has one attribute:
| Attribute | Description | Type | Required |
|---|---|---|---|
Name | The name of the Apron Service that is being referenced (should coincide with the Name attribute of a registered <ApronService />). | String | Yes |
<ApronControlMessages>
This element has no attributes and is a sub-element of the following (see these elements for examples of use):
<SimMission.ApronControlMessageTrigger><SimMission.ApronControlMessageAction>
This is a container element for one or more <ApronControlMessage> elements.
<ApronControlMessage>
This element is a sub-element of <ApronControlMessages> and is used to define the message (and actions) that are to be triggered or sent by the mission to an Apron Control context. For example:
<ApronControlMessage id="CANCEL_HOOK">
<Actions>
<ObjectReference id="Force CS_IDLE" InstanceId="{171E13EB-3BFE-49A6-892C-17109B2E3F4D}"/>
</Actions>
</ApronControlMessage>This element may use the following sub-element if used in a <SimMission.ApronControlMessageTrigger>:
<Actions>
The element has one attribute:
| Attribute | Description | Type | Required |
|---|---|---|---|
id | This is the name of the message and must match thaqt given for the the action or the trigger. In the case of a trigger, you can may add an <Actions> section inside the message to put the actions you want to perform when the message is received. | String | Yes |
<TargetSection>
This element has no attributes and is a sub-element of the following:
<SimMission.ApronControlRequestContextAction><SimMission.ApronControlRegisterToContextAction><SimMission.ApronControlMessageAction>
It is used to set the target section of the aircraft context FLT file to find the airport and the parking space in which the apron service request will be handled, so you can find the context of the Apron Control handling the service. If this element is not provided, the airport and the parking space will be computed automatically, based on where the calling object is and what parking space it reserved. The contents of this element can only be one of the following:
- departure
- arrival
- icao - Used with
<TargetICAO> - simobject - Used with
<TargetAirportOnSimobject>
Note that if you set this to “icao” then you must also include the <TargetICAO> element. For an example of use, see <SimMission.ApronControlMessageAction>. if you set this to “simobject” then you must also include the <TargetAirportOnSimobject> element.
<TargetICAO>
This element has no attributes and is a sub-element of the following:
<SimMission.ApronControlRequestContextAction><SimMission.ApronControlRegisterToContextAction><SimMission.ApronControlMessageAction>
This element should only be used when the accompanying <TargetSection> element is set to “icao”. It is used to give a string to identify the current airport by its ICAO code. Note that this will result in finding no parking space, so it can only be used for very specific use cases, eg: when you want to find an airport on a SimObject that is neither the departure nor the arrival object. For an example of use, see <SimMission.ApronControlMessageAction>.
<TargetAirportOnSimobject>
This element has no attributes and is a sub-element of the following:
<SimMission.ApronControlRequestContextAction><SimMission.ApronControlRegisterToContextAction><SimMission.ApronControlMessageAction>
This element should only be used when the accompanying <TargetSection> element is set to “simobject”. It is used to give an object reference for the container SimObject that owns the airport (for example, when it’s a heliport on a boat).