Template:— representing_system_element (repr_sys_elmnt)
Capability:representing_breakdown_structure |
Date: 2007/09/28 12:44:09
Revision: 1.8
|
This section specifies the template representing_system_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.
This template describes how to represent a
System_element
(and its version and definition) in a breakdown.
The EXPRESS-G diagram in
Figure
1
shows the templates and EXPRESS entities that are required
to represent the template
"representing_system_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_system_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_system_element template
The following input parameters are defined for this template:
id_class_name (Default=Breakdown_element_identification_code,Type='CLASS')
The following classes and their sub-classes can be used:
id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The name or identifier of the organization responsible for the id or name of the system element.
The name of the class assigned to the
Identification_assignment that applies to the
the organization responsilbe for identifying the the system element. (e.g. "CAGE code").
The following classes and their sub-classes can be used:
vn_id (Default=Unknown,Type='STRING')
The following classes and their sub-classes can be used:
The identifier of the
External_class_library that
stores the definition of the class referenced by the parameter @vn_id_class_name class.
The name or identifier of the organization responsible for the identification of the system element version.
The name of the class assigned to the
Identification_assignment that applies to the
the organization responsilbe for identifying the the system element version. (e.g. "CAGE code").
The following classes and their sub-classes can be used:
A classification of the view definition context.
The following classes and their sub-classes can be used:
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:
The identifier of the
External_class_library
that stores the definition of the class referenced by the parameter @domain class.
The following reference parameters are defined for this template:
Allow the
System_element
entity instantiated in this path to be referenced when this template is used.
Note: The
System_element
entity can be referenced in a template path by:
%^target = $representing_system_element.sys_elem%
Allow the
System_element_version
entity instantiated in this path to be referenced when this template is used.
%^target = $representing_system_element.sys_elem_vn%
%^target = $representing_system_element.sys_elem_def%
%^target = $representing_system_element.def_cntxt%
%^target = $representing_system_element.sys_cntxt%
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 System_element System_element%^sys_elem =
System_element%
^sys_elem.id = '/IGNORE'
^sys_elem.name = '/IGNORE'
^sys_elem.description = '/IGNORE'
-- assign ID to System_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=^sys_elem)/
-- instantiate System_element_version System_element_version%^sys_elem_vn =
System_element_version%
^sys_elem_vn.id = '/IGNORE'
^sys_elem_vn.description = '/IGNORE'
^sys_elem_vn.of_product ->
^sys_elem
-- assign ID to System_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=^sys_elem_vn)/
-- instantiate System_element_definition System_element_definition%^sys_elem_def =
System_element_definition%
^sys_elem_def.id = '/IGNORE'
^sys_elem_def.name = '/IGNORE'
^sys_elem_def.additional_characterization = '/IGNORE'
^sys_elem_def.defined_version ->
^sys_elem_vn
-- instantiate View_definition_context and bind it to the System_element_definition
^sys_elem_def.initial_context ->
View_definition_contextView_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 System_breakdown_context to connect System_element_definition -- to a System_version System_breakdown_context%^sys_cntxt =
System_breakdown_context%
^sys_cntxt.id = '/IGNORE'
^sys_cntxt.name = '/IGNORE'
^sys_cntxt.description = '/IGNORE'
^sys_cntxt.breakdown_element ->
^sys_elem_def
^sys_cntxt.breakdown ->
@sys_bkdn_vn
The following entities are instantiated with attributes as specified:
The instance diagram in Figure
3
shows an example of the EXPRESS entities and templates that are instantiated by the template:
/representing_system_element(items='#1', class_name='Safety_critical', ecl_id='urn:plcs:rdl:std')/
(an illustration of the consolidated representing_system_element template is shown in
Figure
4 below.)
Figure 3 — Entities instantiated by representing_system_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_system_element(items='#1', class_name='Safety_critical', ecl_id='urn:plcs:rdl:std')/
Figure 4 — Instantiation of representing_system_element template
The following section details how the
representing_system_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 System_element
through external reference data. See
Figure 1
for an Express-G overview.
The classification of a System_element is represented using the template
assigning_reference_data
assigned to
System_element.
A code for a Breakdown_element (e.g. "LCN number") is represented by using the template
assigning_code
assigned to
System_element.
Characterization Assigning location
NOTE this characterization is optional.
Characterization Assigning properties and documents
NOTE this characterization is optional.
