Template: BreakdownStructure

This section specifies the template BreakdownStructure.

The specification comprises a SysML Block that represents the template and an associated Parametric Diagram that defines the templates and PLCS PSM objects instantiated by the BreakdownStructure template.

The specification comprises the following sections:

Section Description provides a description of the template;
Section Template Block specifies the SysML Block that represents the template;
Section Template Properties specifies the properties, i.e. the Part, Reference and Value properties of the templates SysML Block;
Section Template Output Ports specifies the Output Ports of the templates SysML Block. These bind to the templates and PLCS PSM objects instantiated by the BreakdownStructure template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSM objects instantiated by the BreakdownStructure template;
Section Template Parametric Diagram specifies the templates and PLCS PSM objects instantiated by the BreakdownStructure template;
Section Instantiated blocks specifies the templates and PLCS PSM objects instantiated by the BreakdownStructure template and bound to private parts of the template;
Section Default instances species the instances that have been instantiated in the template. These are used to set the default value of blocks.
Section Constraint blocks identifies the constraint blocks that have been specified in this template;
Section Example data provides example XML data sets that have been instantiated in accordance with this template.

NOTE An explanation of a template and its specification is provided in the Template overview

Description

The BreakdownStructure template describes how to represent to represent a relationship between a BreakdownElementDefinition and another BreakdownElementDefinition that is a constituent.

The SysML Block Definition diagram in Figure 1 shows how a System Breakdown is represented in the PLCS PSM.

../../../../../data/PLCS/psm_model/images/SysML_Block_Definition_Diagram__Diagrams__Breakdown.png

Figure 1 - Breakdown model

Related Templates

No templates have been explicitly defined as being related to the BreakdownStructure template.

NOTE The BreakdownStructure template may make reference to other templates as part of the Parametric Diagram. These are not listed here.

Template Block

Figure 2 shows the SysML Block that represents the template. The Block is an abstraction representing a pattern of templates and PLCS PSM objects.

The properties, i.e. the SysML Block Part, Reference and Value properties, of the template's SysML Block are described in the Template Properties section.

The output ports shown on the template's SysML Block are described in the template output ports section.

Figure 2 - Template block definition diagram for BreakdownStructure

Template Properties

The following Part, Reference, and Value properties are defined for this template:

References:

parent [1] (Block: Ap239Ap233Psm:BreakdownElementDefinition)

the parent BreakdownElementDefinition.

child [1] (Block: Ap239Ap233Psm:BreakdownElementDefinition)

the constituent BreakdownElementDefinition.

structureRole [0..1] (Template: OASIS:Classifier)

a classification of the BreakdownElementUsage.

effectivityRole [0..1] (Template: OASIS:Classifier)

a classification of the EffectivityAssignment.

Parts:

ids [0..*] (Template: OASIS:Identification)

The collection of identifiers of the BreakdownElementUsage.

The reference data used in Template: OASIS:Identification is restricted as follows:

RDL constraint 1:

The id must be classified as a Breakdown_element_usage_identification_code or a subclass thereof.

The reference data for:

OASIS:Identification.role -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Breakdown_element_usage_identification_code

Values:

startEffectivityDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)

the date that defines the lower bound of the interval of applicability.

endEffectivityDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)

the date that defines the upper bound of the interval of applicability. The value of the attribute need not be specified. If the value for this attribute is not specified, the interval of applicability has no upper limit.

Template Output Ports

The following output ports are defined for this template:

breakdownElementUsage (Block: Ap239Ap233Psm:BreakdownElementUsage)

Enables the Block: Ap239Ap233Psm:BreakdownElementUsage instantiated by this template to be referenced when the template is used.

effectivityAssignment (Block: Ap239Ap233Psm:EffectivityAssignment)

Enables the Block: Ap239Ap233Psm:EffectivityAssignment instantiated by this template to be referenced when the template is used.

Template constraints

There are no constraints defined for this template.

Template Parametric diagram

This section describes the template's Parametric Diagram. The diagram details the pattern of templates and PLCS PSM objects that are required to represent the template BreakdownStructure.

The public properties, i.e. those visible in the template's SysML block (See Figure 2) are shown on the left of a Parametric Diagram.

NOTE Restrictions on the reference data to be set on the public properties is defined in the Template Properties section.

The output ports are shown on the right of the Parametric Diagram.

PLCS PSM objects are shaded khaki and template shaded light green in a Parametric Diagram.

Figure 3 - Parametric diagram for BreakdownStructure

Instantiated Blocks

The following blocks are instantiated by this template and bound to private parts of the template as shown in the Parametric Diagram section:

Private Part Property:breakdownElementUsage [1] (Block: Ap239Ap233Psm:BreakdownElementUsage)

Private Part Property:datedEffectivity [1] (Template: OASIS:DatedEffectivity)

Default instances

There are no instances that have been instantiated in this template.

Constraint Blocks

There are no constraint blocks defined in this template.

Example data

No example data sets have been provided for this DEX.