Template:— product_operational_state_change (prod_op_st_chng)
Context:— UK_Defence

Date: 2009/11/05 23:27:06
Revision: 1.5

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

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 a relationship between two product operational states where one state of the product is subsequent to the prior state of the product. The activity or anomaly that caused the change of state is optionally referenced.

Business perspective

The product operational state change business object is used by those UK_Defence Data Exchange Specifications that require information about the change of product operational states and the possible cause.

Business object definition

Figure 1 — Graphical Representation for Business Object Product Operational State Change

Product Operational State Change:

This information object represents a relationship between two product operational states where one state of the product is subsequent to the prior state of the product. The activity that caused the change of state is optionally referenced.

Attribute name	Attribute description	Attribute type	Optionality
ID	This is the identifier of the relationship	Identifier	Mandatory
Cause	This is a reference to the activity or anomaly which was responsible for the change of operational state in the related product.	Relationship to Activity	Optional
Prior product operational state	This is a reference to the operational state of the related product prior to the change taking place.	Relationship to Product_Operational_State	Mandatory
Subsequent product operational state	This is a reference to the operational state of the related product subsequent to the change taking place.	Relationship to Product_Operational_State	Mandatory

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

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

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

Input parameters

The following input parameters are defined for this template:

ID (Type='STRING')

This is the identifier of the relationship.

source_organization (Type='STRING')

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

cause (Type= 'SELECT (activity_item)' , Optional)

This is a reference to the activity or anomaly which was responsible for the change of operational state in the related product.

prior_product_operational_state (Type= 'ENTITY (State_observed)' )

This is a reference to the previous Product operational state.

subsequent_product_operational_state (Type= 'ENTITY (State_observed)' )

This is a reference to the subsequent Product operational state.

Reference parameters

The following reference parameters are defined for this template:

product_operational_state_change(Type='ENTITY (Sequence_of_state)')

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

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

%^target = $product_operational_state_change.product_operational_state_change%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Product_operational_state_change

Each instance of the entity (Sequence_of_state) within the data set shall be uniquely identified by a combination of the following parameters on this template (product_operational_state_change) namely: ID, prior_product_operational_state, subsequent_product_operational_state.
The instance is referenced by the following template parameter: product_operational_state_change.

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.

Sequence_of_state
Sequence_of_state.name = '/IGNORE'
Sequence_of_state.description = '/IGNORE'
%^product_operational_state_change = Sequence_of_state%
^product_operational_state_change.relating -> @prior_product_operational_state
^product_operational_state_change.related -> @subsequent_product_operational_state

-- ID (mandatory)
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type='Product_operational_state_change_identifier',
    items=^product_operational_state_change)/

-- The State change event (modelled with Activity)
%^state_change_event = Activity%
^state_change_event.id = '/IGNORE',
^state_change_event.name = '/IGNORE',
^state_change_event.description = '/IGNORE'

-- the state change event
/assigning_activity(
    role_class_name='Product_operational_state_change_event',
    role_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_activity=^state_change_event,
    items=^product_operational_state_change)/

-- the Optional cause (assigning_activity)
/assigning_activity(
    role_class_name='Product_operational_state_change_cause',
    role_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_activity=^state_change_event,
    items=@cause)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Sequence_of_state.name	'/IGNORE'	State_relationship.name
Sequence_of_state.description	'/IGNORE'	State_relationship.description
Activity.id	'/IGNORE',	—
Activity.name	'/IGNORE',	—
Activity.description	'/IGNORE'	—

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_change(ID='POSC123', source_organization='UK_Defence', cause='@86', prior_product_operational_state='@1', subsequent_product_operational_state='@33')/

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

Figure 4 — Entities instantiated by product_operational_state_change 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_change(ID='POSC123', source_organization='UK_Defence', cause='@86', prior_product_operational_state='@1', subsequent_product_operational_state='@33')/

Figure 5 — Instantiation of product_operational_state_change template

Characterizations

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