Template:— physical_breakdown_item_system (phy_bkdn_sys)
Context:— UK_Defence
Date: 2009/04/17 10:48:48
Revision: 1.2

This section specifies the template physical_breakdown_item_system.

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 reference the system realized by a physical item\system.

Business perspective

This information object represents the realization of a system element by a physical item.

Business object definition

This information object defines the realization of a system element by a physical item.



Figure 1 —  Graphical Representation for Business Object physical_breakdown_item_system

Figure 1 —  Graphical Representation for Business Object physical_breakdown_item_system

Attribute name

Attribute description

Attribute type

Optionality

id This attribute provides the identification of the breakdown item. Identifier Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the Physical Breakdown Item System intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the Physical Breakdown Item System This attribute indicates the type of functional items covered by the breakdown. This must be one of the classes provided. Intrinsic Mandatory
Identifier.source_organization This attribute is the value representing the source organization that provides the id of the Identifier given to the Physical Breakdown Item System This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Realization_of This atttibute provides the reference to the system element that the related physical breakdown item system has been designed to fulfil. System Element Mandatory
Physical_breakdown_item This attribute provides the reference to the physical breakdown item that has been designed to meet the requirments of the related functions and/or system elements. Physical Breakdown Item Mandatory

Table 1 — physical_breakdown_item_system attribute details

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


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

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

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

Figure 3 —  The graphical representation of the physical_breakdown_item_system template

Input parameters
The following input parameters are defined for this template:
realization_id (Type='STRING')
This is the identifier of the physical breakdown item functionality relationship
realization_id_type (Default=Physical_realization_identification_code,Type='CLASS')
This attribute is provides the type associated with the id of the Identifier given to the relationship. This must be one of the classes provided.
The following classes and their sub-classes can be used:
classifications: [Physical_realization_identification_code]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
id_source_organization (Type='STRING')
The identifier of the organization that owns the id. It is assumed that this will be of type Organization_identification_code and not an Organization name.
physical_breakdown_item (Type= 'ENTITY (Physical_element_definition)' )
This is the physical breadkdown element definition that is realizing the system.
is_realization_of (Type= 'ENTITY (System_element_definition)' )
The system element definition being realized.
Reference parameters
The following reference parameters are defined for this template:
realization_relationship(Type='ENTITY (View_definition_usage)')
Allow the View_definition_usage entity instantiated in this path to be referenced when this template is used.
Note: The View_definition_usage entity can be referenced in a template path by:
%^target = $physical_breakdown_item_system.realization_relationship%
where target is the parameter to which the View_definition_usage is bound.
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.
/representing_breakdown_element_realization(
    breakdown=@physical_breakdown_item,
    product=@is_realization_of,
    class_name='Physical_realization',
    class_ecl_id='urn:plcs:rdl:uk_defence')/
%^realization_relationship = $representing_breakdown_element_realization.bkdn_elem_real%

-- assign name to breakdown_element
/identifier(
    ID=@realization_id,
    source_organization=@id_source_organization,
    type=@realization_id_type,
    items=^realization_relationship)/
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/physical_breakdown_item_system(realization_id='pr-001-001', realization_id_type='Physical_realization_identification_code', id_source_organization='6421', physical_breakdown_item='@190', is_realization_of='@412')/
(an illustration of the consolidated physical_breakdown_item_system template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by physical_breakdown_item_system template

Figure 4 —  Entities instantiated by physical_breakdown_item_system 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:
/physical_breakdown_item_system(realization_id='pr-001-001', realization_id_type='Physical_realization_identification_code', id_source_organization='6421', physical_breakdown_item='@190', is_realization_of='@412')/


Figure 5 —  Instantiation of physical_breakdown_item_system template

Figure 5 —  Instantiation of physical_breakdown_item_system template

Characterizations
The following section details how the physical_breakdown_item_system 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 "physical_breakdown_item_system".


Figure 6 —  Characterizations for Physical breakdown item system

Figure 6 —  Characterizations for Physical breakdown item system

The following characterizations may apply:
Characterization Status Assignment

NOTE   this characterization is optional.

An UK_Defence.physical_breakdown_item_system may have one or more status assigned to it, through the use of the following templates (or those based upon these): UK_Defence.status_assignment. The following template calls show how these characterizations might be instantiated.

/status_assignment(assigned_status='', assigned_status_ecl_id='', ID='', ID_type='', ID_organization='', subject='', type='', type_ecl_id='')/
Characterization Document Association

NOTE   this characterization is optional.

An UK_Defence.physical_breakdown_item_system may have specific documents assigned to it, through the use of the following templates (or those based upon these): UK_Defence.document_association , and the associated UK_Defence.document . The following template calls show how these characterizations might be instantiated.

/document_association(id='', type='', source_organization='', purpose='', related_document='', related_item='')/
Characterization Applicability / effectivity

NOTE   this characterization is optional.

An effectivity may be assigned to the UK_Defence.physical_breakdown_item_system. This shall be done using entity Effectivity_assignment.

For example, a dated effectivity shall be assigned using template assigning_dated_effectivity.

/assigning_dated_effectivity(start_year='2005', start_month='11', start_day='22', start_hour='15', start_minute='15', start_second='00', start_sense='ahead', start_hour_offset='2', role_class_name='Planned_effectivity', role_ecl_id='urn:plcs:rdl:std', items='@@@@')/

NOTE    The type of effectivity is described through the application of reference data. In this case the reference data specifies that it is a 'Planned Effectivity', but other types can be created.

© UK MOD 2010 — All rights reserved