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.

This template describes how to represent a required pattern of usage, in terms of usage phases, for the related PSE constituent.

Figure 1 — Graphical Representation for Business Object required_pse_constituent_usage_pattern

required_pse_constituent_usage_pattern

The definition of a required_pse_constituent_usage_pattern object is: This information object represents information about an actual required_pse_constituent_usage_pattern of an individual product.

Attribute name	Attribute description	Attribute type	Optionality
ID	This is the identifier of the required PSE constituent usage pattern.	Identifier	Mandatory
Identifier.id	This is the value of the id attribute of the Identifier applied to the required PSE constituent usage pattern.	intrinsic	Mandatory
Identifier.type	This attribute is the type associated with the id of the Identifier given to the required PSE constituent usage pattern.	required_pse_usage_profile_id	Mandatory
Identifier.source_organization	This attribute is the value representing the source organization that provides the id of the Identifier given to the required PSE constituent usage pattern. This value is assumed to be a type of Organization_identification_code.	Organization_identification_code	Mandatory
Name	This is the name of the required PSE constituent usage pattern. EXAMPLE: "Transatlantic flight", "Low level bombing sortie". NOTE: In each case, the overall usage from the point of pre flight checks, starting engines, leaving the parked position, take off, flight, and right through to the point of landing, shutting down the equipment, and post flight checks, is regarded as the usage profile.	intrinsic	Mandatory
Payload capability	This is the required payload capability for this usage pattern.	Relationship to Measure With Unit	Optional
Related operational theatre	This is the reference to the operational theatre within which the usage pattern is required.	Relationship to Operational theatre	Optional
Usage Role	This is a reference to the related Usage role	Relationship to Required PSE Constituent Usage Role	Mandatory

Table 1 — required_pse_constituent_usage_pattern attribute details

The following input parameters are defined for this template:

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

The following reference parameters are defined for this template:

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.

-- create the task method to represent the required_pse_usage_profile
Task_step
Task_step.name = '/IGNORE'
Task_step.description = '/IGNORE'
Task_step.purpose = '/IGNORE'
Task_step.consequence = '/IGNORE'

-- assign to required_pse_usage_profile
%^required_pse_constituent_usage_pattern = Task_step%

-- create the assignment to link the pse
Task_element_assignment
Task_element_assignment.role = '/IGNORE'
Task_element_assignment.assigned_activity_method -> ^required_pse_constituent_usage_pattern
Task_element_assignment.items -> @usage_role

-- identifier
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='required_pse_usage_pattern_id',
    items=^required_pse_constituent_usage_pattern)/

-- identifier
/identifier(
    ID=@name,
    source_organization=@source_organization,
    type='name',
    items=^required_pse_constituent_usage_pattern)/

-- Payload capability
/assigning_process_property(
    property_class_name='Payload_capability',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^required_pse_constituent_usage_pattern)/

-- Assign reference parameter
-- not sure if needed - can we not substitute this string inside the call to process property?
%^payload_capability = $assigning_process_property.property%

-- Value and Unit
/process_property_numeric(
    value=@payload_capability_value,
    unit=@payload_capability_unit,
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit=@payload_capability_si_unit,
    context='Required',
    context_ecl_id='urn:plcs:rdl:std',
    property=^payload_capability)/

-- create the assignment to link the pse
Task_element_state_relationship
Task_element_state_relationship.task_element -> ^required_pse_constituent_usage_pattern
Task_element_state_relationship.state -> @related_operational_theatre

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