Template:— functional_breakdown (fun_brkd)
Context:— UK_Defence

Date: 2009/04/17 11:54:44
Revision: 1.2

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

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 of a functional breakdown in terms of PLCS model elements (templates, entities, and reference data).

Business perspective

This information object represents the hierarchical structure of functions of the product.

Business object definition

The definition of the functional breakdown object is: This information object represents the hierarchical structure of functions of the product.

Figure 1 — Graphical Representation for Business Object Functional Breakdown

Attribute name	Attribute description	Attribute type	Optionality
description	This attribute provides the description of the breakdown.	Intrinsic	Mandatory
id	This attribute provides the identification information of the breakdown.	Identifier	Mandatory
Identifier.id	This is the value of the id attribute of the Identifier applied to the Functional Breakdown.	intrinsic	Mandatory
Identifier.type	This attribute is the type associated with the id of the Identifier given to the Functional Breakdown. This must be one of the classes provided.	Functional_breakdown_identification_code	Mandatory
Identifier.source_organization	This attribute is the value representing the source organization that provides the id of the Identifier given to the Functional Breakdown. This value is assumed to be a type of Organization_identification_code.	Organization_identification_code	Mandatory
name	This attribute provides the name information of the breakdown.	Intrinsic	Mandatory
Related Product Design	This attribute identifies the design information associated with the breakdown.	Product Design	Mandatory
type	This attribute provides the type information of the breakdown.	Intrinsic	Mandatory
version	This attribute identifies the version of the breakdown.	Intrinsic	Mandatory

Table 1 — Functional Breakdown attribute details

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

id (Type='STRING')

The identifier of the functional breakdown.

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.

name (Type='STRING')

The name of the functional breakdown.

description (Type='STRING')

The description of the functional breakdown.

type (Default=Functional_breakdown_type,Type='CLASS', Optional)

The type of the functional breakdown.

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

classifications: [Functional_breakdown_type]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml

version (Type='STRING')

The identifier of the functional breakdown version.

related_product_design (Type= 'ENTITY (Product_view_definition)' )

The product design that relates to this breakdown.

Reference parameters

The following reference parameters are defined for this template:

fun_bkdn(Type='ENTITY (Functional_breakdown)')

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

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

%^target = $functional_breakdown.fun_bkdn%

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

fun_bkdn_vn(Type='ENTITY (Functional_breakdown_version)')

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

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

%^target = $functional_breakdown.fun_bkdn_vn%

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

bkdwn_of(Type='ENTITY (Breakdown_of)')

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

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

%^target = $functional_breakdown.bkdwn_of%

where target is the parameter to which the Breakdown_of 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_functional_breakdown(
    id=@id,
    id_class_name='Functional_breakdown_identification_code',
    id_ecl_id='urn:plcs:rdl:uk_defence',
    id_owner=@source_organization,
    id_owner_class_name='Organization_identification_code',
    id_owner_ecl_id='urn:plcs:rdl:uk_defence',
    bkdn_type=@type,
    bkdn_type_ecl_id='urn:plcs:rdl:uk_defence',
    vn_id=@version,
    vn_id_class_name='Version_identification_code',
    vn_id_ecl_id='urn:plcs:rdl:uk_defence',
    vn_id_owner=@source_organization,
    vn_id_owner_class_name='Organization_identification_code',
    vn_id_owner_ecl_id='urn:plcs:rdl:uk_defence')/

-- assign ref parameters
%^fun_bkdn = $representing_functional_breakdown.fnct_bkdn%
%^fun_bkdn_vn = $representing_functional_breakdown.fnct_bkdn_vn%
%^bkdwn_of = $representing_functional_breakdown.bkdn_of%
^bkdwn_of.of_view -> @related_product_design

-- name
/identifier(
    ID=@name,
    source_organization=@source_organization,
    type='Functional_breakdown_name',
    items=^fun_bkdn)/

-- description
/assigning_descriptor(
    descr=@description,
    class_name='Functional_breakdown',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^fun_bkdn)/

Instance diagrams

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

/functional_breakdown(id='FB-Torn-GR4', source_organization='6421', name='Functional breakdown Tornado GR4', description='Breakdown of a Tornado GR4 in terms of functionality', type='Functional_breakdown', version='A', related_product_design='@80')/

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

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

Figure 5 — Instantiation of functional_breakdown template

Characterizations

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