Template:— reportable_item_usage (rep_usg)
Context:— MoDAvDEX
Date: 2008/01/30 13:43:13
Revision: 1.6

This section specifies the template reportable_item_usage.

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 usage of a reportable item. For example, a sortie flown by an aircraft.

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

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.

The following templates are shown in the diagram:

Template: #1 representing_typical_activity
the template: #1 representing_typical_activity (Figure 1) is used to represent the type of activity undertaken by the reportable item. E.g. a sortie profile code.
Template: #2 representing_product_usage
the template: #2 representing_product_usage (Figure 1) is used to represent the activity undertaken by the reportable item. E.g. a sortie that was flown.
Template: #3 MoDAvDEX.reportable_item
the template: #3 MoDAvDEX.reportable_item (Figure 1) is used to represent the reportable item that has undertaken the activity.


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

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

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 reportable_item_usage template

Figure 2 —  The graphical representation of the reportable_item_usage template

Input parameters
The following input parameters are defined for this template:
usage_identification (Default=/NULL,Type='STRING')
The identifier of the activity.
usage_identification_code (Default=Activity_identification_code,Type='CLASS')
The type of identifier of the activity.
The following classes and their sub-classes can be used:
classifications: "Activity_identification_code" (urn:plcs:rdl:std:Activity_identification_code)
start_time_year (Type= 'TYPE (year_number)' )
Calendar_date year_component of the date the activity was started.
start_time_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component of the date the activity was started.
start_time_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component of the date the activity was started.
start_time_hour (Type= 'TYPE (hour_in_day)' )
Local_time year_component of the date and time the date the activity was started.
start_time_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time minute_component of the date and time the activity started. This parameter is optional. If not given, it will remain unset.
start_time_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time day_component of the date and time the activity was started. This parameter is optional. If not given, it will remain unset.
usage_code (Type='CLASS', Optional)
A code identifying the type of activity undertaken by a reportable item. E.g. a sortie profile code.
The following classes and their sub-classes can be used:
classifications: "Product_usage_activity_method" (urn:plcs:rdl:std:Product_usage_activity_method)
rep_item (Type= 'ENTITY (Product_as_realized)' )
The reportable item undertaking the activity.
Reference parameters
The following reference parameters are defined for this template:
act_method(Type='ENTITY (Activity_method)')
Allow the Activity_method entity instantiated in this path to be referenced when this template is used.
Note: The Activity_method entity can be referenced in a template path by:
%^target = $reportable_item_usage.act_method%
where target is the parameter to which the Activity_method is bound.
act_act(Type='ENTITY (Activity_actual)')
Allow the Activity_actual entity instantiated in this path to be referenced when this template is used.
Note: The Activity_actual entity can be referenced in a template path by:
%^target = $reportable_item_usage.act_act%
where target is the parameter to which the Activity_actual 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_typical_activity(
    id='Product usage type',
    id_class_name='Activity_method_identification_code',
    id_ecl_id='urn:plcs:rdl:std',
    id_owner='LITS',
    id_owner_class_name='Organization_name',
    id_owner_ecl_id='urn:plcs:rdl:std',
    type=@usage_code,
    type_ecl_id='urn:plcs:rdl:LITS')/
%^act_method = $representing_typical_activity.act_method%
/representing_product_usage(
    id=@usage_identification,
    id_class_name=@usage_identification_code,
    id_ecl_id='urn:plcs:rdl:LITS',
    id_owner='LITS',
    id_owner_class_name='Organization_name',
    id_owner_ecl_id='urn:plcs:rdl:std',
    method=^act_method,
    role='Product_usage',
    role_ecl_id='urn:plcs:rdl:std',
    date_class_name='Date_actual_start',
    date_ecl_id='urn:plcs:rdl:std',
    year=@start_time_year,
    month=@start_time_month,
    day=@start_time_day,
    hour=@start_time_hour,
    minute=@start_time_minute,
    second=@start_time_second,
    sense='.EXACT.',
    hour_offset='0',
    minute_offset='0',
    items=@rep_item)/
%^act_act = $representing_product_usage.act_act%
Characterizations
No common characterizations of the template reportable_item_usage have been identified. However, the ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.

© UK MOD 2010 — All rights reserved