representing_breakdown

Template:— representing_breakdown_element (rep_bkdn_elem)

Date: 2008/02/28 23:59:11
Revision: 1.16

Cover Contents Description Model diags.Input params.Ref. params.Instantiation path Instance diags.Characterizations Issues

This section specifies the template representing_breakdown_element.

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 a Breakdown_element (and its version and definition) in a breakdown. It is generic and may be used for any type of breakdown, except for breakdown elements that are defined subtypes in AP239: i.e. Functional_element, Physical_element, System_element, or Zone_element.

Model diagrams

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

Templates within grey rectangles and templates with dashed lines are not included in the template, but may be used to further characterize the template.

Figure 1 — An EXPRESS-G representation of the Information model for representing_breakdown_element

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure 2 below.

Figure 2 — The graphical representation of the representing_breakdown_element template

Input parameters

The following input parameters are defined for this template:

id (Type='STRING')

The identifier of the Breakdown_element .

id_class_name (Default=Breakdown_element_identification_code,Type='CLASS')

The name of the class being used to classify the (Identification_assignment) of the breakdown_element. This provides the role or reason for the identification.

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

classifications: "Breakdown_element_identification_code" (urn:plcs:rdl:std:Breakdown_element_identification_code), "Breakdown_element_name" (urn:plcs:rdl:std:Breakdown_element_name)

id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the class referenced by the parameter @id_class_name class.

id_owner (Type='STRING')

The name or identifier of the organization owning the id or name.

id_owner_class_name (Default=Organization_name,Type='CLASS')

The name of the class being used to classify the identification of the organization. For example CAGE code, or organization name.

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

classifications: "Organization_identification_code" (urn:plcs:rdl:std:Organization_identification_code), "Organization_name" (urn:plcs:rdl:std:Organization_name)

id_owner_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The id of the External_class_library storing the @id_owner_class_name class

vn_id (Default=Unknown,Type='STRING')

The identifier of the Breakdown_element_version.

vn_id_class_name (Default=Version_identification_code,Type='CLASS')

The name of the class being used to classify the identification (Identification_assignment) of the breakdown_element_version. This provides the role or reason for the identification.

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

classifications: "Version_identification_code" (urn:plcs:rdl:std:Version_identification_code)

vn_id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the class referenced by the parameter @vn_id_class_name class.

vn_id_owner (Default=Unknown,Type='STRING')

The name or identifier of the organization owning the version_id.

vn_id_owner_class_name (Default=Organization_name,Type='CLASS')

The name of the class being used to classify the identification of the organization. For example CAGE code, or organization name.

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

classifications: "Organization_identification_code" (urn:plcs:rdl:std:Organization_identification_code), "Organization_name" (urn:plcs:rdl:std:Organization_name)

vn_id_owner_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The id of the External_class_library storing the @vn_id_owner_class_name class

life_cycle_stage (Default=Support_stage,Type='CLASS')

The identifier of the External_class_library used to describe the type of life cycle stage of the View_definition_context instance.

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

classifications: "Life_cycle_stage" (urn:plcs:rdl:std:Life_cycle_stage)

life_cycle_stage_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the class referenced by the parameter @life_cycle_stage class.

domain (Default=Product_life_cycle_support,Type='CLASS')

The identifier of the External_class_library used to describe the type of application domain of the View_definition_context instance.

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

classifications: "Application_domain" (urn:plcs:rdl:std:Application_domain)

domain_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the class referenced by the parameter @domain class.

bkdn_vn (Type= 'ENTITY (Breakdown_version)' )

The Breakdown_version of which this Breakdown_element is a constituent.

Reference parameters

The following reference parameters are defined for this template:

bkdn_elem(Type='ENTITY (Breakdown_element)')

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

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

%^target = $representing_breakdown_element.bkdn_elem%

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

bkdn_elem_vn(Type='ENTITY (Breakdown_element_version)')

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

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

%^target = $representing_breakdown_element.bkdn_elem_vn%

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

bkdn_elem_def(Type='ENTITY (Breakdown_element_definition)')

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

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

%^target = $representing_breakdown_element.bkdn_elem_def%

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

def_cntxt(Type='ENTITY (View_definition_context)')

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

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

%^target = $representing_breakdown_element.def_cntxt%

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

bkdn_cntxt(Type='ENTITY (Breakdown_context)')

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

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

%^target = $representing_breakdown_element.bkdn_cntxt%

where target is the parameter to which the Breakdown_context 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 Reading Capability Templates help section.

-- instantiate Breakdown_element
Breakdown_element
%^bkdn_elem = Breakdown_element%
^bkdn_elem.id = '/IGNORE'
^bkdn_elem.name = '/IGNORE'
^bkdn_elem.description = '/IGNORE'

-- assign ID to breakdown_element
/assigning_identification(
    id=@id,
    id_class_name=@id_class_name,
    id_ecl_id=@id_ecl_id,
    org_id=@id_owner,
    org_id_class_name=@id_owner_class_name,
    org_id_ecl_id=@id_owner_ecl_id,
    items=^bkdn_elem)/

-- instantiate Breakdown_element_version
Breakdown_element_version
%^bkdn_elem_vn = Breakdown_element_version%
^bkdn_elem_vn.id = '/IGNORE'
^bkdn_elem_vn.description = '/IGNORE'
^bkdn_elem_vn.of_product -> ^bkdn_elem

-- assign ID to Breakdown_element_version
/assigning_identification(
    id=@vn_id,
    id_class_name=@vn_id_class_name,
    id_ecl_id=@vn_id_ecl_id,
    org_id=@vn_id_owner,
    org_id_class_name=@vn_id_owner_class_name,
    org_id_ecl_id=@vn_id_owner_ecl_id,
    items=^bkdn_elem_vn)/

-- instantiate Breakdown_element_definition
Breakdown_element_definition
%^bkdn_elem_def = Breakdown_element_definition%
^bkdn_elem_def.id = '/IGNORE'
^bkdn_elem_def.name = '/IGNORE'
^bkdn_elem_def.additional_characterization = '/IGNORE'
^bkdn_elem_def.defined_version -> ^bkdn_elem_vn

-- instantiate View_definition_context and bind it to the Breakdown_element_definition
^bkdn_elem_def.initial_context -> View_definition_context
%^def_cntxt = View_definition_context%
^def_cntxt.life_cycle_stage = '/IGNORE'
^def_cntxt.application_domain = '/IGNORE'
^def_cntxt.description = '/IGNORE'

-- assign life_cycle_stage to the view_definition_context
/assigning_reference_data(
    items=^def_cntxt,
    class_name=@life_cycle_stage,
    ecl_id=@life_cycle_stage_ecl_id)/

-- assign application_domain to the context
/assigning_reference_data(
    items=^def_cntxt,
    class_name=@domain,
    ecl_id=@domain_ecl_id)/

-- instantiate Breakdown_context to connect breakdown_element_definition
-- to a breakdown_version
Breakdown_context
%^bkdn_cntxt = Breakdown_context%
^bkdn_cntxt.id = '/IGNORE'
^bkdn_cntxt.name = '/IGNORE'
^bkdn_cntxt.description = '/IGNORE'
^bkdn_cntxt.breakdown_element -> ^bkdn_elem_def
^bkdn_cntxt.breakdown -> @bkdn_vn

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Breakdown_element.id	'/IGNORE'	Product.id
Breakdown_element.name	'/IGNORE'	Product.name
Breakdown_element.description	'/IGNORE'	Product.description
Breakdown_element_version.id	'/IGNORE'	Product_version.id
Breakdown_element_version.description	'/IGNORE'	Product_version.description
Breakdown_element_definition.id	'/IGNORE'	Product_view_definition.id
Breakdown_element_definition.name	'/IGNORE'	Product_view_definition.name
Breakdown_element_definition.additional_characterization	'/IGNORE'	Product_view_definition.additional_characterization
View_definition_context.life_cycle_stage	'/IGNORE'	—
View_definition_context.application_domain	'/IGNORE'	—
View_definition_context.description	'/IGNORE'	—
Breakdown_context.id	'/IGNORE'	—
Breakdown_context.name	'/IGNORE'	—
Breakdown_context.description	'/IGNORE'	—

Instance diagrams

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

/representing_breakdown_element(id='Tank access spaces', id_class_name='Breakdown_element_name', id_ecl_id='urn:plcs:rdl:std', id_owner='Motorbike Manufacturers Ltd', id_owner_class_name='Organization_name', id_owner_ecl_id='urn:plcs:rdl:std', vn_id='B', vn_id_class_name='Version_identification_code', vn_id_ecl_id='urn:plcs:rdl:std', vn_id_owner='Motorbike Manufacturers Ltd', vn_id_owner_class_name='Organization_name', vn_id_owner_ecl_id='urn:plcs:rdl:std', life_cycle_stage='Support_stage', life_cycle_stage_ecl_id='urn:plcs:rdl:std', domain='Maintenance', domain_ecl_id='urn:plcs:rdl:std', bkdn_vn='#53')/

(an illustration of the consolidated representing_breakdown_element template is shown in Figure 4 below.)

Note that the assigning_reference_data and assigning_identification templates are used in the diagram. Namely:

/assigning_reference_data(items='#43', class_name='Maintenance', ecl_id='urn:plcs:rdl:std')/

/assigning_reference_data(items='#43', class_name='Support_stage', ecl_id='urn:plcs:rdl:std')/

/assigning_identification(items='#2', id='Tank access spaces', id_class_name='Breakdown_element_name', id_ecl_id='urn:plcs:rdl:std', org_id='Motorbike Manufacturers Ltd', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std')/

/assigning_identification(items='#22', id='B', id_class_name='Version_identification_code', id_ecl_id='urn:plcs:rdl:std', org_id='Motorbike Manufacturers Ltd', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std')/

Figure 3 — Entities instantiated by representing_breakdown_element template

The instance diagram in Figure 4 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:

Figure 4 — Instantiation of representing_breakdown_element template

Characterizations

The following section details how the representing_breakdown_element 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 5 shows the possible characterizations of the template "representing_breakdown_element".

Figure 5 — The graphical representation of the representing_breakdown_element characterizations

The following characterizations may apply:

Characterization Assigning classification or code

NOTE this characterization is optional.

Classifications and codes may be assigned to a Breakdown_element through external reference data.

A class of a Breakdown_element is represented using the template assigning_reference_data assigned to Breakdown_element.

A code of a Breakdown_element (e.g. "LCN number") is represented by using the template assigning_code assigned to Breakdown_element.

Characterization Assigning location

NOTE this characterization is optional.

A location can be associated to a Breakdown_element or a Breakdown_element_version by using the template assigning_location.

The location may be expressed as a global location, an address-based location, an organization-based location, or as a location in a regional grid. See further Capability C049: assigning_location (NB Capabilities are not documented in this release of the PLCS standard) .

The assignment of the location (assigning_location) may be classified.

Characterization Assigning properties and documents

NOTE this characterization is optional.

Properties and documents may be associated with a Breakdown_element_definition.

A property is associated using template assigning_product_property assigned to Breakdown_element_definition using reference parameter "^bkdn_elem_def". The assignment of properties is further explained in capability C076: assigning_product_properties (NB Capabilities are not documented in this release of the PLCS standard) .

A document is associated using template assigning_document assigned to Breakdown_element_definition using reference parameter "^bkdn_elem_def". The assignment of documents is further explained in capability C005: representing_documents (NB Capabilities are not documented in this release of the PLCS standard) .

Characterization Assigning identification

NOTE this characterization is optional.

Additional identifiers can be assigned to Breakdown_element_definition using reference parameter "^bkdn_elem_def"; Breakdown_element using reference parameter "^bkdn_elem" and Breakdown_element_version using reference parameter "^bkdn_elem_vn"; by using the template assigning_identification. Identifications are further explained in Capability C001: assigning_identifiers (NB Capabilities are not documented in this release of the PLCS standard) .