Template:— reportable_item_property (rep_prop)
Context:— MoDAvDEX
Date: 2008/03/12 22:23:29
Revision: 1.16

This section specifies the template reportable_item_property.

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 the properties of a reportable item, using

The properties are frequently changed as a consequence of using the reportable item.

For further information about the representation of properties of a reportable item, see Aviation Maintenance DEX: Representing properties on a reportable item.



Figure 1 —  

Figure 1 —  

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


Figure 2 —  An EXPRESS-G representation of the Information model for reportable_item_property

Figure 2 —  An EXPRESS-G representation of the Information model for reportable_item_property

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


Figure 3 —  The graphical representation of the reportable_item_property template

Figure 3 —  The graphical representation of the reportable_item_property template

Input parameters
The following input parameters are defined for this template:
property_name (Type='CLASS')
The class name corresponding to the property name.
The following classes and their sub-classes can be used:
classifications: [ModAvDEX_Product_property]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
property_value (Type= 'TYPE (any_number_value)' )
The value of the property. The data type must also be indicated in this parameter, e.g. "ANY_NUMBER_VALUE(5)".
property_unit (Type='CLASS')
The class name of the unit in which the value is expressed.
The following classes and their sub-classes can be used:
classifications: [ModAvDEX_Unit]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
unit_ecl_id (Default=urn:plcs:rdl:LITS,Type='URN', Optional)
The identifier of the External_class_library storing the definition of the class referenced by the parameter @unit_class_name.
si_unit (Type='BOOLEAN')
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".
year (Type= 'TYPE (year_number)' )
The year component of the date the property value was measured.
month (Type= 'TYPE (month_in_year_number)' )
The month component of the date the property value was measured.
day (Type= 'TYPE (day_in_month_number)' )
The day component of the date the property value was measured.
hour (Type= 'TYPE (hour_in_day)' )
The hour component of the date the property value was measured.
minute (Type= 'TYPE (minute_in_hour)' , Optional)
The minute component of the date the property value was measured. This parameter is optional. If not given, it will remain unset.
second (Type= 'TYPE (second_in_minute)' , Optional)
The second component of the date the property value was measured. This parameter is optional. If not given, it will remain unset.
org_id (Type='STRING')
The name or identifier of the organization declaring the property.
value_type (Type='CLASS')
meter_reading - the value measured on the meter; cumulative - the cumulative value taking into account the changing of meters; sortie - the value of sortie related data not use for calculating life. E.g fuel consumed.
The following classes and their sub-classes can be used:
classifications: [meter_reading_value]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
[cumulative_value]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
[sortie_value]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
described_element (Type= 'ENTITY (Product_as_individual_view)' )
The view of the reportable item instance to which the property is assigned
Reference parameters
The following reference parameters are defined for this template:
property(Type='ENTITY (Assigned_property)')
Allow the Assigned_property entity instantiated in this path to be referenced when this template is used.
Note: The Assigned_property entity can be referenced in a template path by:
%^target = $reportable_item_property.property%
where target is the parameter to which the Assigned_property is bound.
prop_val_rep(Type='ENTITY (Property_value_representation)')
Allow the Property_value_representation entity instantiated in this path to be referenced when this template is used.
Note: The Property_value_representation entity can be referenced in a template path by:
%^target = $reportable_item_property.prop_val_rep%
where target is the parameter to which the Property_value_representation 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.
/assigning_product_property(
    property_class_name=@property_name,
    property_ecl_id='urn:plcs:rdl:LITS',
    described_element=@described_element)/
%^property = $assigning_product_property.property%
/product_property_numeric(
    value=@property_value,
    unit=@property_unit,
    unit_ecl_id=@unit_ecl_id,
    si_unit=@si_unit,
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:std',
    property=^property)/
%^prop_val_rep = $product_property_numeric.representation%
/assigning_time(
    date_class_name='Date_actual_observation',
    date_ecl_id='urn:plcs:rdl:std',
    year=@year,
    month=@month,
    day=@day,
    hour=@hour,
    minute=@minute,
    second=@second,
    sense='.EXACT.',
    hour_offset='0',
    minute_offset='0',
    items=^prop_val_rep)/
/assigning_organization(
    org_id=@org_id,
    org_id_class_name='Organization_name',
    org_id_ecl_id='urn:plcs:rdl:std',
    org_assgn_class_name='Measurer_of',
    org_assgn_ecl_id='urn:plcs:rdl:std',
    items=^prop_val_rep)/
/assigning_reference_data(
    class_name=@value_type,
    ecl_id='urn:plcs:rdl:LITS',
    items=^prop_val_rep)/
Characterizations
The following section details how the reportable_item_property 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 EXPRESS-G diagram in Figure 4 shows the possible characterizations of the template "reportable_item_property".


Figure 4 —  Characterizations for representing_LITS_reportable_item_property template

Figure 4 —  Characterizations for representing_LITS_reportable_item_property template

The following characterizations may apply:
Characterization Assigning property increment

NOTE   this characterization is optional.

The incremental change of a property can be assigned to the reportable item property using product_property_numeric and property_value_relationship.

When assigning the increment the template product_property_numeric should be used as follows:

/product_property_numeric(value='?increment_value?', unit='?increment_unit?', unit_ecl_id='urn:plcs:rdl:std', si_unit='?increment_si_unit?', context='Numerical_representation_context'', context_ecl_id='urn:plcs:rdl:std', property='#1')/

and template property_value_relationship should be used as follows:

/property_value_relationship(rel_type='Increment_relationship', rel_type_ecl_id='urn:plcs:rdl:LITS', relating='#1', related='#2')/

The above are examples of the types of values that can be used.

An alternative view is:

Template #2 (Figure 4): product_property_numeric
Description Representing the property's increment.'
Parameter name: Parameter value: Parameter description:
value ?increment_value? The increment value
unit ?increment_unit? The unit that the increment value is measured in
unit_ecl_id ?urn:plcs:rdl:LITS? - the URN for the reference data library storing the class. The identifier of the External_class_library storing the definition of the unit name referenced by the parameter @unit.
si_unit "True" or "False" 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" (urn:plcs:rdl:std:Numerical representation context) The name of the class being used to classify the 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.
property The Assigned_property entity. The target of the template, i.e. the Assigned_property (or template assigning_product_property) to which the Property_representation is related.
Template #3 (Figure 4): property_value_relationship
Description Relationship between two property values.
Parameter name: Parameter value: Parameter description:
rel_type [Increment_relationship]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
Type of relation between property value representations.
rel_type_ecl_id "urn:plcs:rdl:std" The identifier of the External_class_library storing the definition of the class referenced by the parameter @rel_type.
relating Property_value_representation TheProperty_value_representation within the representing_reportable_item_property identified at template #1
related Property_value_representation TheProperty_value_representation represented by template product_property_numeric identified at template #2

© UK MOD 2010 — All rights reserved