Template:— product_operational_state (prod_op_state)
Context:— UK_Defence

Date: 2009/05/06 08:13:06
Revision: 1.3

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

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 a UK_Defence product operational state, using State_assertion.

This information object represents the operational state of a product between specific dates.

For further information about the representation of a product operational state, see below.

Business perspective

This information object represents the operational state of a product between specific dates.

Business object definition

Figure 1 — Graphical Representation for Business Object Product Operational State

Record:

This information object represents the operational state of a product between specific dates.

Attribute name	Attribute description	Attribute type	Optionality
Actual end date	This is the date on which the product operational state ended	Intrinsic	Optional
Actual start date	This is the date on which the product operational state started	Intrinsic	Optional
Assigned state	This is the equipment state that is assigned to the related product. EXAMPLE: "serviceable and standby", "serviceable and running", "serviceable and shutdown", "unserviceable", "damaged", "demilitarized", "decommissioned / mothballed", "scrapped / destroyed	Intrinsic	Mandatory
Description	This is the description of the product operational state	intrinsic	Optional
ID	This is the identifier of the product operational state	Identifier	Mandatory
Predicted end date	This is the date on which the product operational state is predicted to end	Intrinsic	Optional
Predicted start date	This is the date on which the product operational state is predicted to start	Intrinsic	Optional
Related Product	This is the reference to the product to which the operational state is assigned	Product	Mandatory

Table 1 — Product 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_operational_state". The text highlighted in blue shows the template parameters.

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

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

Input parameters

The following input parameters are defined for this template:

assigned_state (Type='CLASS')

The class name of the External_class corresponding to the State_definition name.

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

classifications: "State_definition" (urn:plcs:rdl:std:State_definition)

ID (Type='STRING')

This is the identifier of the product operational state

source_organization (Type='STRING')

The organization that created the associated identifier. Additionally a Person or Information System could be defined when either of these are the source; see Identifier template characterizations

type (Type='CLASS')

This is the name of the type of the class used to classify the identifier and so provide the role or reason for the identification.

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

classifications: "Identifier_type" (urn:plcs:rdl:std:Identifier_type)

related_product (Type= 'ENTITY (Product_as_individual_view)' )

This is the reference to the product to which the operational state is assigned.

Reference parameters

The following reference parameters are defined for this template:

state_obs(Type='ENTITY (State_observed)')

Allow the State_observed entity instantiated in this path to be referenced when this template is used.

Note: The State_observed entity can be referenced in a template path by:

%^target = $product_operational_state.state_obs%

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

state_assert(Type='ENTITY (State_assertion)')

Allow the State_assertion entity instantiated in this path to be referenced when this template is used.

Note: The State_assertion entity can be referenced in a template path by:

%^target = $product_operational_state.state_assert%

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

state_def(Type='ENTITY (State_definition)')

Allow the State_definition entity instantiated in this path to be referenced when this template is used.

Note: The State_definition entity can be referenced in a template path by:

%^target = $product_operational_state.state_def%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Unique state

Each instance of the entity (State_assertion) within the data set shall be uniquely identified by a combination of the following parameters on this template (product_operational_state) namely: assigned_state, related_product, ID.
The instance is referenced by the following template parameter: state_assert.

The state, product and identifier should only appear once in a data set

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.

-- instantiate the state and the relationship to product
/assigning_asserted_state(
    state_class_name=@assigned_state,
    state_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_to=@related_product)/
%^operational_state = $assigning_asserted_state.state_assert%

-- instantiate the product operational states identifier
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type=@type,
    items=^operational_state)/

Instance diagrams

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

/product_operational_state(assigned_state='unserviceable', ID='us444', source_organization='BAE Systems', type='State_identification_code', items='@76')/

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

Figure 4 — Entities instantiated by product_operational_state 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:

/product_operational_state(assigned_state='unserviceable', ID='us444', source_organization='BAE Systems', type='State_identification_code', items='@76')/

Figure 5 — Instantiation of product_operational_state template

Characterizations

The following section details how the product_operational_state 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 6 shows the possible characterizations of the template "product_operational_state".

Figure 6 — Characterizations for product_operational_state

The following characterizations may apply:

Characterization Assigning times

NOTE this characterization is optional.

Dates and times can be associated with the assignment of an asserted state in a given role by using the template assigning_time.

The Actual Start and End Dates as well as the Predicted Start and End Dates can be assigned to the template assigning_asserted_state.

The date assignment is classified as: "Date actual start" (urn:plcs:rdl:std:Date actual start) to indicate that it is the date when the state was asserted; "Date actual end" (urn:plcs:rdl:std:Date actual end) to indicate that it is the date when the state ended; [Date_predicted_start]
Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
to indicate that it is the date when the state was predicted to start; [Date_predicted_end]
Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
to indicate that it is the date when the state was predicted to end.

/assigning_time(date_class_name='Date_actual_start', date_ecl_id='urn:plcs:rdl:std', year='2008', month='01', day_in_month_number='30', hour='17', minute='0', second='0', sense='.EXACT.', hour_offset='0', minute_offset='0', items='@1')/

Characterization Description

NOTE this characterization is optional.

The description of the product operational state can be provided using instances of the template assigning_descriptor.

/assigning_descriptor(descr='This describes the operational state of the product', class_name='Description', ecl_id='urn:plcs:rdl:std', is_assigned_to='@1')/