Template:— required_pse_constituent_interoperability (rpse_ctin)
Context:— UK_Defence
Date: 2009/04/17 11:32:31
Revision: 1.6

This section specifies the template required_pse_constituent_interoperability.

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 relationship between a PSE constituent and other items with which it is required to interoperate

Business perspective

This information object represents the relationship between an identified platform system equipment, and other items with which it is required to interoperate.

Business object definition

This information object represents the relationship between a PSE constituent and other items with which it is required to interoperate



Figure 1 —  Graphical Representation for Business Object Platform System Equipment Constituent

Figure 1 —  Graphical Representation for Business Object Platform System Equipment Constituent

Attribute name

Attribute description

Attribute type

Optionality

ID This is the identifier of the required platform system equipment constituent interoperability. Identifier Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the required platform system equipment constituent interoperability. intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the required platform system equipment constituent interoperability. required_pse_constituent_interoperability_id_code Mandatory
Identifier.source_organization This attribute is the value representing the source organization that provides the id of the Identifier given to the required platform system equipment constituent interoperability. This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Identifier.category This is the value of the category attribute applied to the required platform system equipment constituent interoperability. intrinsic Mandatory
Identifier.description This is the value of the description attribute applied to the required platform system equipment constituent interoperability. intrinsic Mandatory
Related item This is the reference to the item which is required to interoperate with the related PSE constituent. Relationship to SELECT items Product Design, Product Specification or Product. Mandatory
Related PSE constituent This is the reference to the PSE constitutent for which the related items are required to interoperate. Relationship to Platform System Equipment. Mandatory
Required PSE usage profile This is the reference to the PSE usage profile for which the interoperability is defined. This is the inverse relationship (and thus replaces) the Related PSE constituent interoperability defined by the Platform System Equipment Usage Profile. Relationship to Platform System Equipment Usage Profile. Mandatory

Table 1 — Platform System Equipment Constituent attribute details

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


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

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

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure  3 below.
The figure below shows the additional relationship to the 'Required PSE Usage Profile', for which the interoperability is defined. This fulfills the need to relate a 'profile' to an 'interoperability' object.


Figure 3 —  The graphical representation of the required_pse_constituent_interoperability template

Figure 3 —  The graphical representation of the required_pse_constituent_interoperability template

Input parameters
The following input parameters are defined for this template:
id (Type='STRING')
This is the identifier of the required item interoperability
category (Default=Interoperability,Type='CLASS')
This is the category of the required item interoperability. EXAMPLE (From DEF STAN 00-60, DED 266, interoperability code) includes:
The following classes and their sub-classes can be used:
classifications: [Interoperability]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
[Transportability]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
description (Type='STRING')
The identifier of the platform system equipment constituent.
source_organization (Type='STRING')
The organization or information system that created the associated identifier. Alternatively this could be set to /NULL when Person or Information System is the source; see Identifier template characterizations.
related_pse_constituent (Type= 'ENTITY (Product_group_membership)' )
The platform system equipment.
related_item (Type= 'SELECT (product_select)' )
The constituent of the related platform system equipment.
required_pse_usage_profile (Type= 'ENTITY (Task_method)' )
The constituent usage profile.
Reference parameters
The following reference parameters are defined for this template:
req_pse_const_interop(Type='ENTITY (Product_group_membership)')
Allow the Product_group_membership entity instantiated in this path to be referenced when this template is used.
Note: The Product_group_membership entity can be referenced in a template path by:
%^target = $required_pse_constituent_interoperability.req_pse_const_interop%
where target is the parameter to which the Product_group_membership is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Product group membership id
Each instance of the entity (Product_group_membership) within the data set shall be uniquely identified by a combination of the following parameters on this template (required_pse_constituent_interoperability) namely: id, source_organization.
The instance is referenced by the following template parameter: req_pse_const_interop.
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.
Product_group_membership

-- Mark the Product_group_membership entity as
-- referable when this template is used by binding it to the reference
-- parameter prod_grp_membership
Product_group
Product_group.id = '/IGNORE'
Product_group.purpose = '/IGNORE'
%^req_pse_const_interop = Product_group_membership%
Product_group_membership.of_group -> Product_group
Product_group_membership.member -> @related_item
%^pgm_effectivity = Effectivity%
Effectivity.id = '/IGNORE'
Effectivity.name = '/IGNORE'
Effectivity.description = '/IGNORE'

-- New Effectivity assignment
Effectivity_assignment.role = '/IGNORE'
Effectivity_assignment.items -> ^req_pse_const_interop
Effectivity_assignment.role = '/IGNORE'

-- Instantiate Effectivity_assignment entity (no.1)
%^pgm_effect_asngt = Effectivity_assignment%
^pgm_effect_asngt.assigned_effectivity -> ^pgm_effectivity

-- create the assignment to link the reqd_pse_cont_usg_profile
Task_method_assignment
Task_method_assignment.role = '/IGNORE'
Task_method_assignment.assigned_activity_method -> @required_pse_usage_profile
Task_method_assignment.items -> ^req_pse_const_interop

-- id identifier
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='required_pse_constituent_interoperability_id_code',
    items=^req_pse_const_interop)/

-- Classify the membership as Constituent_interoperability
/assigning_reference_data(
    items=^req_pse_const_interop,
    class_name=@category,
    ecl_id='urn:plcs:rdl:uk_defence')/

-- Description
/assigning_descriptor(
    descr=@description,
    class_name='description'',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^req_pse_const_interop)/
Effectivity_assignment.role = '/IGNORE'
Effectivity_assignment.items -> @related_pse_constituent
Effectivity_assignment.role = '/IGNORE'

-- Make Ref Params of Effectivity_assignment entity (no.2)
%^pse_const_effect_asngt = Effectivity_assignment%
^pse_const_effect_asngt.assigned_effectivity -> ^pgm_effectivity
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Product_group.id '/IGNORE'
Product_group.purpose '/IGNORE'
Effectivity.id '/IGNORE'
Effectivity.name '/IGNORE'
Effectivity.description '/IGNORE'
Effectivity_assignment.role '/IGNORE'
Effectivity_assignment.role '/IGNORE'
Task_method_assignment.role '/IGNORE' Applied_activity_method_assignment.role
Effectivity_assignment.role '/IGNORE'
Effectivity_assignment.role '/IGNORE'
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/required_pse_constituent_interoperability(id='', category='transportability', description='', source_organization='', related_pse_constituent='@40', related_item='@67', required_pse_usage_profile='@16')/
(an illustration of the consolidated required_pse_constituent_interoperability template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by required_pse_constituent_interoperability template

Figure 4 —  Entities instantiated by required_pse_constituent_interoperability 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:
/required_pse_constituent_interoperability(id='', category='transportability', description='', source_organization='', related_pse_constituent='@40', related_item='@67', required_pse_usage_profile='@16')/


Figure 5 —  Instantiation of required_pse_constituent_interoperability template

Figure 5 —  Instantiation of required_pse_constituent_interoperability template

Characterizations
No common characterizations of the template required_pse_constituent_interoperability 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