representing_functional

Template:— representing_functional_element (repr_funct_elmnt)
Capability:representing_breakdown_structure

Date: 2007/09/28 12:44:08
Revision: 1.9

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

This section specifies the template representing_functional_element.

NOTE The template has been defined in the context of the capability representing_breakdown_structure which provides an overall description of the relevant parts of the ISO 10303-239 information model and a description 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 a Functional_element (and its version and definition) in a breakdown.

Model diagrams

The EXPRESS-G diagram in Figure 1 shows the templates and EXPRESS entities that are required to represent the template "representing_functional_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_functional_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_functional_element template

Input parameters

The following input parameters are defined for this template:

id (Type='STRING')

The identifier of the Functional_element.

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

The name of the class assigned to the Identification_assignment that applies to the functional element.

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 id of the External_class_library that stores the @id_class_name class.

id_owner (Type='STRING')

The name or identifier of the organization responsible for the id or name of the functional element.

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

The name of the class assigned to the Identification_assignment that applies to the the organization responsilbe for identifying the the functional element. (e.g. "CAGE code").

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 that stores the @id_owner_class_name class.

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

The identifier of the Functional_element_version.

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

The name of the class assigned to the Identification_assignment that applies to the functional element version.

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 that stores 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 responsible for the identification of the functional element version.

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

The name of the class assigned to the Identification_assignment that applies to the the organization responsilbe for identifying the the functional element version. (e.g. "CAGE code").

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 that stores the @vn_id_owner_class_name class.

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

A classification of the view definition context.

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 that stores the definition of the class referenced by the parameter @life_cycle_stage class.

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

A classification of the view definition context.

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 that stores the definition of the class referenced by the parameter @domain class.

fnct_bkdn_vn (Type= 'ENTITY (Functional_breakdown_version)' )

The Functional_element_version of which this Functional_element is a constituent.

Reference parameters

The following reference parameters are defined for this template:

fnct_elem(Type='ENTITY (Functional_element)')

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

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

%^target = $representing_functional_element.fnct_elem%

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

fnct_elem_vn(Type='ENTITY (Functional_element_version)')

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

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

%^target = $representing_functional_element.fnct_elem_vn%

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

fnct_elem_def(Type='ENTITY (Functional_element_definition)')

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

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

%^target = $representing_functional_element.fnct_elem_def%

where target is the parameter to which the Functional_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_functional_element.def_cntxt%

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

fnct_cntxt(Type='ENTITY (Functional_breakdown_context)')

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

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

%^target = $representing_functional_element.fnct_cntxt%

where target is the parameter to which the Functional_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 Templates Help/Information section.

-- instantiate Functional_element
Functional_element
%^fnct_elem = Functional_element%
^fnct_elem.id = '/IGNORE'
^fnct_elem.name = '/IGNORE'
^fnct_elem.description = '/IGNORE'

-- assign ID to Functional_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=^fnct_elem)/

-- instantiate Functional_element_version
Functional_element_version
%^fnct_elem_vn = Functional_element_version%
^fnct_elem_vn.id = '/IGNORE'
^fnct_elem_vn.description = '/IGNORE'
^fnct_elem_vn.of_product -> ^fnct_elem

-- assign ID to Functional_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=^fnct_elem_vn)/

-- instantiate Functional_element_definition
Functional_element_definition
%^fnct_elem_def = Functional_element_definition%
^fnct_elem_def.id = '/IGNORE'
^fnct_elem_def.name = '/IGNORE'
^fnct_elem_def.additional_characterization = '/IGNORE'
^fnct_elem_def.defined_version -> ^fnct_elem_vn

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

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

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

-- instantiate Functional_breakdown_context to connect Functional_element_definition
-- to a Functional_version
Functional_breakdown_context
%^fnct_cntxt = Functional_breakdown_context%
^fnct_cntxt.id = '/IGNORE'
^fnct_cntxt.name = '/IGNORE'
^fnct_cntxt.description = '/IGNORE'
^fnct_cntxt.breakdown_element -> ^fnct_elem_def
^fnct_cntxt.breakdown -> @fnct_bkdn_vn

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Functional_element.id	'/IGNORE'	Product.id
Functional_element.name	'/IGNORE'	Product.name
Functional_element.description	'/IGNORE'	Product.description
Functional_element_version.id	'/IGNORE'	Product_version.id
Functional_element_version.description	'/IGNORE'	Product_version.description
Functional_element_definition.id	'/IGNORE'	Product_view_definition.id
Functional_element_definition.name	'/IGNORE'	Product_view_definition.name
Functional_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'	—
Functional_breakdown_context.id	'/IGNORE'	Breakdown_context.id
Functional_breakdown_context.name	'/IGNORE'	Breakdown_context.name
Functional_breakdown_context.description	'/IGNORE'	Breakdown_context.description

Instance diagrams

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

/representing_functional_element(items='#1', class_name='Safety_critical', ecl_id='urn:plcs:rdl:std')/

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

Figure 3 — Entities instantiated by representing_functional_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:

/representing_functional_element(items='#1', class_name='Safety_critical', ecl_id='urn:plcs:rdl:std')/

Figure 4 — Instantiation of representing_functional_element template

Characterizations

The following section details how the representing_functional_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 following characterizations may apply:

Characterization Assigning classification or code

NOTE this characterization is optional.

Classifications and codes may be assigned to a Functional_element through external reference data. See Figure 1 for an Express-G overview.

The classification of a Functional_element is represented using the template assigning_reference_data assigned to Functional_element.

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

Characterization Assigning location

NOTE this characterization is optional.

A location can be associated to a Functional_element or a Functional_element_version by using the template assigning_location. See Figure 1 for an Express-G overview.

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.

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 Functional_element_definition. See Figure 1 for an Express-G overview.

A property is associated using template assigning_product_property assigned to Functional_element_definition using reference parameter "fnct_elem_def". The assignment of properties is further explained in capability C076: assigning_product_properties.

A document is associated using template assigning_document assigned to Functional_element_definition using reference parameter "fnct_elem_def". The assignment of documents is further explained in capability C005: representing_documents.