Template:— usage_limitation (usg_lim)
Context:— MoDAvDEX
Date: 2008/03/12 22:23:29
Revision: 1.6

This section specifies the template usage_limitation.

NOTE  The template has been defined in the context of MoDAvDEX. Refer to the business context for details of related templates.

NOTE  An explanation of a template and the associated instantiation path is provided in the Template overview section.

Description

This template describes how to represent a limitation of usage of a reportable item. This is normally based on the deferral of a the activity to address a fault of maintenance activity.

Model diagrams
The EXPRESS-G diagram in Figure 1 shows the templates and EXPRESS entities that are required to represent the template "usage_limitation". The text highlighted in blue shows the template parameters.

Figure 1 shows the templates required to represent an installation position. The templates shown in yellow in Figure 1 are standard OASIS template. Those shown in light green are business templates developed specifically for the MoDAvDEX context.

Further details of how to represent a limitation of usage using ISO 10303 239 PLCS is provided in Aviation Maintenance DEX: Representing deferred activities - PLCS representation - Limitation of usage.

The following templates are shown in Figure 1 and used to represent different aspects of the usage limitation. Figure 1 also shows a number of optional templates which are described in the Characterizations section.

Template: #1 MoDAvDEX.work_order
the template: #1 MoDAvDEX.work_order (Figure 1) is used to represent the work order that raised the maintenance activity on the reportable item that has been deferred and hence the cause of the limitation..

NOTE    Template: #1 MoDAvDEX.work_order is not instantiated by this template. See MoDAvDEX.work_order.

Template: #2 MoDAvDEX.reportable_item
the template: #2 MoDAvDEX.reportable_item (Figure 1) is used to represent the reportable item whose usage has been limited.

NOTE    Template: #2 MoDAvDEX.reportable_item is not instantiated by this template. See MoDAvDEX.reportable_item_structure.

Template: #3 assigning_approval
the template: #3 assigning_approval (Figure 1) is used to represent the approved limitation.
Template: #4 assigning_asserted_state
the template: #4 assigning_asserted_state (Figure 1) is used to represent the state assigned to the Directed_activity of the Work_order to indicate that it is deferred.

NOTE    Template: #4 assigning_asserted_state is not instantiated by this template. See MoDAvDEX.MoDAvDEXmessage_asset_lifing_extension.

Template: #5,#9 assigning_reference_data
the template: #5,#9 assigning_reference_data (Figure 1) is used to classify the Approval and Approval_assignment respectively as a "Concession" (urn:plcs:rdl:std:Concession) to indicate that the limitation of usage.
Template: #6 assigning_justification_support_item
the template: #6 assigning_justification_support_item (Figure 1) is used to link the cause of the limitation - the deferred state - to the limitation.
Template: #7 assigning_justification
the template: #7 assigning_justification (Figure 1) is used to link the cause of the limitation - the deferred state - to the limitation.
Template: #10 assigning_descriptor
the template: #10 assigning_descriptor (Figure 1) is used to link the cause of the limitation - the deferred state - to the limitation.


Figure 1 —  An EXPRESS-G representation of the Information model for usage_limitation

Figure 1 —  An EXPRESS-G representation of the Information model for usage_limitation

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure  2 below.


Figure 2 —  The graphical representation of the usage_limitation template

Figure 2 —  The graphical representation of the usage_limitation template

Input parameters
The following input parameters are defined for this template:
organization (Type='STRING')
The organization that approves the limitation.
deferred_state (Type= 'ENTITY (State_observed)' )
The deferred state assigned to the Directed_activity of the Work_order to indicate that it is deferred.
approval_status (Type='CLASS')
The status of the approval for the limitation.
The following classes and their sub-classes can be used:
classifications: [Status_of_approval]
[warning:]Error RDL1: The class Status_of_approval does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
description (Type='STRING')
The description of the limitation.
par (Type= 'ENTITY (Product_as_realized)' )
The reportable item that has the limitation of use.
Reference parameters
The following reference parameters are defined for this template:
approval(Type='ENTITY (Approval)')
Allow the Approval entity instantiated in this path to be referenced when this template is used.
Note: The Approval entity can be referenced in a template path by:
%^target = $usage_limitation.approval%
where target is the parameter to which the Approval is bound.
approval_assgn(Type='ENTITY (Approval_assignment)')
Allow the Approval_assignment entity instantiated in this path to be referenced when this template is used.
Note: The Approval_assignment entity can be referenced in a template path by:
%^target = $usage_limitation.approval_assgn%
where target is the parameter to which the Approval_assignment is bound.
justification(Type='ENTITY (Justification)')
Allow the Justification entity instantiated in this path to be referenced when this template is used.
Note: The Justification entity can be referenced in a template path by:
%^target = $usage_limitation.justification%
where target is the parameter to which the Justification is bound.
Instantiation path
The instantiation path shown below specifies the entities that are to be instantiated by the template.
A description of templates and the syntax for the instantiation path is provided in the Templates Help/Information section.
/representing_organization(
    org_id=@organization,
    org_id_class_name='Organization_name',
    org_id_ecl_id='urn:plcs:rdl:std')/
%^approving_organization = $representing_organization.org%

-- Assign the concession approval to the reportable item
/assigning_approval(
    status=@approval_status,
    status_ecl_id='urn:plcs:rdl:std',
    items=@par,
    person_org=^approving_organization)/
%^approval = $assigning_approval.approval%
%^approval_assgn = $assigning_approval.approval_assgn%

-- classify the approval as a Concession
/assigning_reference_data(
    items=^approval,
    class_name='Concession',
    ecl_id='urn:plcs:rdl:std')/

-- classify the approval_assignment as a Concession
/assigning_reference_data(
    items=^approval_assgn,
    class_name='Concession',
    ecl_id='urn:plcs:rdl:std')/
/assigning_approving_organization(
    org_id=@organization,
    org_id_class_name='Organization_name',
    org_id_ecl_id='urn:plcs:rdl:std',
    authorized_approval=^approval)/

-- Justify the approval
/assigning_justification(
    just_item=^approval,
    just_asgn_role='Justification_assignment_role',
    role_ecl_id='urn:plcs:rdl:std',
    just_txt='')/
%^justification = $assigning_justification.justification%

-- Link the justification to the deferred state
/assigning_justification_support_item(
    support_item_role='Justification_support_assignment_role',
    role_ecl_id='urn:plcs:rdl:std',
    justification=^justification,
    just_supp_item=@deferred_state)/
/assigning_descriptor(
    descr=@description,
    class_name='Limitation_description',
    ecl_id='urn:plcs:rdl:LITS',
    is_assigned_to=^approval)/
Characterizations
The following section details how the usage_limitation template can be optionally characterized by assigning other constructs to it. These are characterizations commonly applied to the template. The ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.
The following characterizations may apply:
Characterization Assigning approval date

NOTE   this characterization is optional.

The date when the approved limitation was given can be represented by assigning a date / time (using the relationship Date_or_date_time_assignment) to the Approval using template #11 assigning_time template with the following parameters: Date_time being classified as a type of "Date actual" (urn:plcs:rdl:std:Date actual).

Template #11 (Figure 1): assigning_time
Description The date / time that the limitation was approved.
Parameter name: Parameter value: Parameter description:
date_class_name "Date actual" (urn:plcs:rdl:std:Date actual) The name of the class being used to classify the role date assignment, e.g. the start date.
date_ecl_id "urn:plcs:rdl:std" The id of the External_class_library in which the date class is defined.
year ?year? The year component of the date the property value was measured.
month ?month? The month component of the date the property value was measured.
day ?day? The day component of the date the property value was measured.
hour ?hour? The hour component of the date the property value was measured.
minute ?minute? The minute component of the date the property value was measured. This parameter is optional. If not given, it will remain unset.
second ?second? The second component of the date the property value was measured. This parameter is optional. If not given, it will remain unset.
sense .EXACT. The direction of the offset. Enumeration values: 'ahead', 'exact' or 'behind'.
hour_offset 0 The number of hours by which a time is offset from Coordinated Universal Time.
minute_offset 0 The number of minutes by which a time is offset from Coordinated Universal Time. The value of this attribute need not be specified. This parameter is optional. If not given, it will remain unset.
items Approval The approval for the limitation
Characterization Assigning condition

NOTE   this characterization is optional.

The limitation may be expressed as a condition. E.g. Maximum altitude must not exceed 1000 meters. The use of condition is described in Aviation Maintenance DEX: Representing deferred activities - PLCS representation - Limitation of usage.

The following templates are required:

Template #12 (Figure 1): assigning_condition
Description An "If then else" clause representing the conditions under which the reportable item may be used.
Parameter name: Parameter value: Parameter description:
cond_item Approval The approval for limited usage (Approval).
cond_asg_class "Concession condition" (urn:plcs:rdl:std:Concession condition) The name of the class used to classify the Condition_assignment and to provide the role or reason for the condition.
cond_asg_ecl_id "urn:plcs:rdl:std" The identifier of the External_class_library storing the definition of the class referenced by the parameter @cond_asg_class.
cond_class [Equals]
[warning:]Error RDL1: The class Equals does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
Type of Condition that can be evaluated.
cond_ecl_id "urn:plcs:rdl:std" "urn:plcs:rdl:std"
cond_para_item Independent_property The item constituting the Condition_parameter.
Template #13 (Figure 1): assigning_reference_data
Description Periodicity property.
Parameter name: Parameter value: Parameter description:
class_name "Periodicity" (urn:plcs:rdl:std:Periodicity) The name of the External_class being used.
ecl_id "urn:plcs:rdl:std" The id of the External_class_library that stores the definition for the class being used.
items Independent_property The items to which the External_class is assigned.
Template #14 (Figure 1): representing_numeric_property
Description The limitation value.
Parameter name: Parameter value: Parameter description:
value ?value? The value of the property that is being tested
unit ?unit? The unit that the value of the property is measured in
unit_ecl_id "urn:plcs:rdl:std" Most units will be in the standard PLCS reference data, those that are not will have to be added to the Aviation Maintenance Dex specific reference data
si_unit 'true' if an SI unit, 'false' if not Value should be set to true if the unit is a SI base unit defined by ISO, i.e. kilogram (kg) for Mass, second (s) for Time, metre (m) for Displacement, ampere (A) for Electrical current, kelvin (K) for Temperature, mole (mol) for Amount of substance, and candela (cd) for Luminous intensity. If this is not the case it should be set to false.
Note that the representation of true and false depends on exchange format. In Part 11 (a STEP file) true is represented by the string ".T.", and false by ".F.", while in Part 28 (XML) they are represented by text strings "true" and "false".
context 'Numerical_representation_context' The name of the class being used to classify the representation context (Numerical_representation_context) of the property.
context_ecl_id "urn:plcs:rdl:std" The identifier of the External_class_library storing the definition of the class referenced by the parameter @context.
Template #15 (Figure 1): assigning_product_property
Description The name of the property used to express the limitation. E.g. flying hours, or altitude.
Parameter name: Parameter value: Parameter description:
property_class_name [ModAvDEX_Product_property]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
The name of the property
property_ecl_id "urn:plcs:rdl:std" The identifier of the External_class_library storing the definition of the class referenced by the parameter @property_class_name.
described_element Product_as_realized The Product_as_realized whose property is being limited.

© UK MOD 2010 — All rights reserved