representing_breakdown

NOTE An explanation of a template and the associated instantiation path is provided in the Template overview section.

This template describes how to represent the structure of elements in a breakdown. It does not define the representation of the elements themselves.

This template should be used to create structures between general Breakdown_element_definitions and in particular if elements from different types of breakdowns are involved (i.e. to form a hybrid breakdown). Do not use the entity Hybrid_element_usage.

The template is not intended for representing the structures of pure (i.e. contianing only one of the following) System_element_definitions, Functional_element_definitions, Physical_element_definitions, or Zone_element_definitions. For these, there are other specific breakdown structure templates.

The following input parameters are defined for this template:

The following reference parameters are defined for this template:

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.

-- Create Breakdown_element_usage instance
Breakdown_element_usage

-- Set attributes of Breakdwon_element_usage,
-- and assign a reference parameter to it
Breakdown_element_usage.id = '/IGNORE'
Breakdown_element_usage.name = '/IGNORE'
Breakdown_element_usage.relation_type = '/IGNORE'
Breakdown_element_usage.description = '/IGNORE'
%^usage = Breakdown_element_usage%

-- instantiate relations to Breakdown_element_usage
Breakdown_element_usage.relating_view -> @parent
Breakdown_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
Breakdown_element_usage.id	'/IGNORE'	View_definition_relationship.id
Breakdown_element_usage.name	'/IGNORE'	—
Breakdown_element_usage.relation_type	'/IGNORE'	View_definition_relationship.relation_type
Breakdown_element_usage.description	'/IGNORE'	View_definition_relationship.description

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

Characterization Assigning identification

NOTE this characterization is optional.

The Breakdown_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 Breakdown_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 C094: assigning_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 breakdown structure was created can be represented by assigning a date and time to the Breakdown_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 breakdown 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) .