Template: Breakdown

This section specifies the template Breakdown.

The specification comprises a SysML Block that represents the template and an associated Parametric Diagram that defines the templates and PLCS PSMTemplate objects instantiated by the Breakdown 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 SysML Part, Reference and Value properties of the templates SysML Block;
Section Template Output Ports specifies the SysML Output Ports of the templates SysML Block. These bind to the templates and PLCS PSM objects instantiated by the Breakdown template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the Breakdown template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the Breakdown template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the Breakdown 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 Breakdown template describes how to represent a breakdown. It covers the minimum requirements to represent a Breakdown BreakdownVersion and BreakdownOf to a target.

The SysML Block Definition diagram in Figure 1 shows how a 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 Breakdown template.

NOTE The Breakdown 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 PSMTemplate 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.

The SysML Parametric diagrams for the template Block are shown in template parametric diagram section.

Figure 2 - Template block definition diagram for Breakdown

Template Properties

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

References:

breakdownOf [1] (Block: Ap239Ap233Psm:BreakdownOfSelect)

The product that has been broken down.

Parts:

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

The identifiers of the breakdown There shall be at least one identifier that is the breakdown_id. Hence there shall be at least one identifier classified to be a "Breakdown_identification_code" or a sub-class of "Breakdown_identification_code".

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

RDL constraint 1:

There must be one identifier that is the breakdown identifier.

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_identification_code

versionId [1] (Template: OASIS:Identification)

The identifier of the breakdown version.

NOTE If no versionId is specified a unique, unidentified BreakdownVersion is created.

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

RDL constraint 1:

The identifier must be a version identifier.

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#Version_identification_code

classifications [0..*] (Template: OASIS:Classifier)

The classification of the Breakdown

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

RDL constraint 1:

The reference data for:

OASIS:Classifier.class -> ExternalOwlClass.class

is restricted to classes that are subclasses of the following class:

http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/plcs/plcs-psm/refdata/plcs-psm#Breakdown

descriptions [0..*] (Template: OASIS:Descriptor)

The descriptions of the Breakdown.

names [0..*] (Template: OASIS:Name)

The names of the Breakdown.

Template Output Ports

The following output ports are defined for this template:

bkdn (Block: Ap239Ap233Psm:Breakdown)

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

The output port for the Breakdown block

bkdn_vn (Block: Ap239Ap233Psm:BreakdownVersion)

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

The output port for the BreakdownVersion block

bkdn_of (Block: Ap239Ap233Psm:BreakdownOf)

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

The output port for the BreakdownOf block

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 PSMTemplate objects that are required to represent the template Breakdown.

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 a Parametric Diagram.

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

Figure 3 - Parametric diagram for Breakdown

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:breakdown [1] (Block: Ap239Ap233Psm:Breakdown)

Private Part Property:breakdownVersion [1] (Block: Ap239Ap233Psm:BreakdownVersion)

Private Part Property:brkdownOf [1] (Block: Ap239Ap233Psm:BreakdownOf)

Private Part Property:combNameAndDesc [1] (Constraint Block: OASIS:Name:CombineNamesAndDescriptors)

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 Template.