Template:— representing_zone_structure (rep_zone_structr) Date: 2009/04/22 22:01:48
Revision: 1.19

This section specifies the template representing_zone_structure.

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 relationships between elements in a zonal breakdown.

Model diagrams
The EXPRESS-G diagram in Figure 1 shows the templates and EXPRESS entities that are required to represent the template "representing_zone_structure". The text highlighted in blue shows the template parameters.
Templates in 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_zone_structure

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

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

Figure 2 —  The graphical representation of the representing_zone_structure template

Input parameters
The following input parameters are defined for this template:
rel_type_name (Default=Zone_element_usage,Type='CLASS')
The name of the class assigned to the Zone_element_usage.
The following classes and their sub-classes can be used:
classifications: "Zone_element_usage" (urn:plcs:rdl:std:Zone_element_usage)
rel_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 @rel_type_name class.
parent (Type= 'ENTITY (Zone_element_definition)' )
The immediate parent Zone_element_definition in the breakdown structure.
child (Type= 'ENTITY (Zone_element_definition)' )
The immediate child Zone_element_definition in the breakdown structure.
Reference parameters
The following reference parameters are defined for this template:
usage(Type='ENTITY (Zone_element_usage)')
Allow the Zone_element_usage entity instantiated in this path to be referenced when this template is used.
Note: The Zone_element_usage entity can be referenced in a template path by:
%^target = $representing_zone_structure.usage%
where target is the parameter to which the Zone_element_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.
-- Create Zone_element_usage instance
Zone_element_usage

-- Mark the Identification_assignment entity as
-- referable when this template is used by binding it to the reference
-- parameter ^usage
Zone_element_usage.id = '/IGNORE'
Zone_element_usage.name = '/IGNORE'
Zone_element_usage.relation_type = '/IGNORE'
Zone_element_usage.description = '/IGNORE'
%^usage = Zone_element_usage%

-- instantiate relations to Zone_element_usage
Zone_element_usage.relating_view -> @parent
Zone_element_usage.related_view -> @child

-- Classify the relationship
/assigning_reference_data(
    class_name=@rel_type_name,
    ecl_id=@rel_ecl_id,
    items=^usage)/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Zone_element_usage.id '/IGNORE' View_definition_relationship.id
Zone_element_usage.name '/IGNORE' Breakdown_element_usage.name
Zone_element_usage.relation_type '/IGNORE' View_definition_relationship.relation_type
Zone_element_usage.description '/IGNORE' View_definition_relationship.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_zone_structure(parent='#6', child='#58', rel_type_name='Breakdown_element_usage', rel_ecl_id='urn:plcs:rdl:std')/
(an illustration of the consolidated representing_zone_structure template is shown in Figure 4 below.)


Figure 3 —  Entities instantiated by representing_zone_structure template

Figure 3 —  Entities instantiated by representing_zone_structure 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_zone_structure(parent='#6', child='#58', rel_type_name='Breakdown_element_usage', rel_ecl_id='urn:plcs:rdl:std')/


Figure 4 —  Instantiation of representing_zone_structure template

Figure 4 —  Instantiation of representing_zone_structure template

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


Figure 5 —  Characterizations for representing_zone_breakdown template

Figure 5 —  Characterizations for representing_zone_breakdown template

The following characterizations may apply:
Characterization Assigning identification

NOTE   this characterization is optional.

The Zone_element_usage may be identified by assigning it an identifier through the use of template assigning_identification.

NOTE    Identification is described in C001: assigning_identifiers (NB Capabilities are not documented in this release of the PLCS standard) .

Characterization Assigning organization

NOTE   this characterization is optional.

An organization can be assigned in a given role, such as "creator" or "owner", to a relation between breakdown elements. This is represented by assigning the template assigning_organization to the Zone_element_usage. The role of the assignment is represented by classifying the assignment by the use of reference data.

NOTE    The assignment of an organization is described in the capability C016: representing_person_organization (NB Capabilities are not documented in this release of the PLCS standard) .

Characterization Assigning creation time

NOTE   this characterization is optional.

The time and date when the zone breakdown structure was created can be represented by assigning a date and time to the Zone_element_usage using the template assigning_time with the Date_time being classified as a type of "Date actual creation" (urn:plcs:rdl:std:Date actual creation).

NOTE    The assignment of dates is described the capability C036: assigning_date_time (NB Capabilities are not documented in this release of the PLCS standard) .

Characterization Assigning dated effectivity

NOTE   this characterization is optional.

The time period over which a zone element usage is effective can be set by using the template assigning_dated_effectivity.

NOTE    The use of effectivity is described in the capability: C006: assigning_effectivity (NB Capabilities are not documented in this release of the PLCS standard) .

© OASIS 2010 — All rights reserved