Template:— platform_system_equipment_constituent (platform_sys_equip_constnt)
Context:— UK_Defence
Date: 2009/04/17 10:48:48
Revision: 1.3

This section specifies the template platform_system_equipment_constituent.

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 UK_Defence concept the constituents of a platform system and its equipment in terms of PLCS model elements (templates, entities, and reference data).

Business perspective

This information object represents the relationship between an identified platform system equipment, and an item that forms a part of it.

Business object definition

This information object represents the relationship between an identified platform system equipment, and an item that forms a part of it.



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 platform system equipment constituent. Identifier Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the platform system equipment constituent. intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the platform system equipment constituent. Platform_system_equipment_constituent_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 platform system equipment constituent. This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Related constituent This is the reference to the item that is a constituent of the related PSE. Relationship to SELECT items Product Design, Product Specification or Product. Mandatory
Related PSE This is the reference to the PSE for which the related constituent form a part. Relationship to Platform System Equipment. 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 "platform_system_equipment_constituent". The text highlighted in blue shows the template parameters.


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

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

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

Figure 3 —  The graphical representation of the platform_system_equipment_constituent template

Input parameters
The following input parameters are defined for this template:
id (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.
class_name (Default=constituent_product,Type='CLASS')
The class of constituent of the platform system equipment.
The following classes and their sub-classes can be used:
classifications: [constituent_product]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
[constituent_product_design]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
[constituent_product_specification]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
related_pse (Type= 'ENTITY (Product_group)' )
The platform system equipment.
related_constituent (Type= 'SELECT (product_select)' )
The constituent of the related platform system equipment.
Reference parameters
The following reference parameters are defined for this template:
prod_grp_membership(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 = $platform_system_equipment_constituent.prod_grp_membership%
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 (platform_system_equipment_constituent) namely: id, source_organization.
The instance is referenced by the following template parameter: prod_grp_membership.
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
%^prod_grp_membership = Product_group_membership%
Product_group_membership.of_group -> @related_pse
Product_group_membership.member -> @related_constituent

-- id
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='Platform_system_equipment_id_code',
    items=^prod_grp_membership)/

-- class_name
/assigning_reference_data(
    items=^prod_grp_membership,
    class_name=@class_name,
    ecl_id='urn:plcs:rdl:uk_defence')/
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/platform_system_equipment_constituent(ID='PC3', source_organization='6421', class_name='Constituent_product', related_pse='@2', related_constituent='@25')/
(an illustration of the consolidated platform_system_equipment_constituent template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by platform_system_equipment_constituent template

Figure 4 —  Entities instantiated by platform_system_equipment_constituent 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:
/platform_system_equipment_constituent(ID='PC3', source_organization='6421', class_name='Constituent_product', related_pse='@2', related_constituent='@25')/


Figure 5 —  Instantiation of platform_system_equipment_constituent template

Figure 5 —  Instantiation of platform_system_equipment_constituent template

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