Template:— product_usage_parameter (prod_usg_param)
Context:— UK_Defence

Date: 2009/10/07 14:44:00
Revision: 1.4

Cover Contents Description Bus. perspective Bus. obj.Model diags.Input params.Ref. params.Instantiation path Instance diags.Characterizations Issues in situ

This section specifies the template product_usage_parameter.

NOTE The template has been defined in the context of UK_Defence. 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 record of a usage parameter that is measured during the related product usage

Business perspective

The product usage parameter business object is used by those UK_Defence Data Exchange Specifications that require information about the a usage parameter that is measured during the related product usage

Business object definition

Figure 1 — Graphical Representation for Business Object Product Usage Parameter

Product Usage Parameter:

The definition of a Product Usage Parameter object is: Data about the a usage parameter that is measured during the related product usage.

Attribute name	Attribute description	Attribute type	Optionality
Usage phase	This is a reference to the PSE Constituent usage phase.	Relationship to Required PSE Constituent Usage Phase	Optional

Table 1 — Product Product Usage Parameter attribute details

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

ID (Type='CLASS')

The identifier of the Property.

The following classes and their sub-classes can be used:

classifications: [Property]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml

property_ecl_id (Default=urn:plcs:rdl:uk_defence,Type='URN')

The identifier of the External_class_library storing the definition of the class referenced by the parameter @property_identifier.

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)".

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: "Unit" (urn:plcs:rdl:std:Unit)

unit_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the class referenced by the parameter @property_unit.

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".

category (Type='CLASS', Optional)

This indicates the type of the property.

The following classes and their sub-classes can be used:

classifications: [Property_category]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml

disposition (Type='CLASS')

The disposition of the Property.

The following classes and their sub-classes can be used:

classifications: [Disposition]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml

a_property_of (Type= 'SELECT (property_assignment_select)' )

The view of the object to which the property is assigned

valid_from (Type= 'SELECT (date_or_date_time_select)' , Optional)

This is the date and time from which the property was valid.

valid_to (Type= 'SELECT (date_or_date_time_select)' , Optional)

This is the date and time from which the property was valid.

usage_phase (Type= 'ENTITY (Task_step)' , Optional)

This is a reference to the PSE Constituent usage phase.

Reference parameters

The following reference parameters are defined for this template:

prod_usage_para(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 = $product_usage_parameter.prod_usage_para%

where target is the parameter to which the Assigned_property is bound.

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: prod_usg_param

Each instance of the entity (Assigned_property) within the data set shall be uniquely identified by a combination of the following parameters on this template (product_usage_parameter) namely: a_property_of, ID.
The instance is referenced by the following template parameter: prod_usage_para.

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.

-- Property
/property(
    ID=@ID,
    property_ecl_id=@property_ecl_id,
    value=@value,
    unit=@unit,
    unit_ecl_id=@unit_ecl_id,
    si_unit=@si_unit,
    category=@category,
    disposition=@disposition,
    a_property_of=@a_property_of,
    valid_from=@valid_from,
    valid_to=@valid_to)/
%^prod_usage_para = $property.property%

-- [ optional Task_method]
Task_method
Task_method.name = '/IGNORE'
Task_method.description = '/IGNORE'
Task_method.consequence = '/IGNORE'
Task_method.purpose = '/IGNORE'
%^task_method = Task_method%

-- [ optional Task_method_assignment]
Task_method_assignment
Task_method_assignment.role = '/IGNORE'
Task_method_assignment.assigned_activity_method -> ^task_method
Task_method_assignment.items -> ^prod_usage_para

-- [ optional Task_element_assignment]
Task_element_assignment
Task_element_assignment.role = '/IGNORE'
Task_element_assignment.assigned_activity_method -> @usage_phase
Task_element_assignment.items -> ^task_method

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Task_method.name	'/IGNORE'	Activity_method.name
Task_method.description	'/IGNORE'	Activity_method.description
Task_method.consequence	'/IGNORE'	Activity_method.consequence
Task_method.purpose	'/IGNORE'	Activity_method.purpose
Task_method_assignment.role	'/IGNORE'	Applied_activity_method_assignment.role
Task_element_assignment.role	'/IGNORE'	Applied_activity_method_assignment.role

Instance diagrams

The instance diagram in Figure 4 shows an example of the EXPRESS entities and templates that are instantiated by the template:

/product_usage_parameter(ID='PUP123', property_ecl_id='urn:plcs:rdl:uk_defence', value='ANY_NUMBER_VALUE(10.)', unit='Man_hour', unit_ecl_id='urn:plcs:rdl:std', si_unit='.F.', category='Actual', disposition='Designed', a_property_of='#48', valid_from='#154', valid_to='#149', usage_phase='@212')/

(an illustration of the consolidated product_usage_parameter template is shown in Figure 5 below.)

Figure 4 — Entities instantiated by product_usage_parameter template

The instance diagram in Figure 5 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:

Figure 5 — Instantiation of product_usage_parameter template

Characterizations

No common characterizations of the template product_usage_parameter have been identified. However, the ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.