Template: OASIS:BreakdownElement

This section specifies the template BreakdownElement.

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 BreakdownElement template.

The specification comprises the following sections:

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

The BreakdownElement template describes how to represent a BreakdownElement (and its version and definition) in a breakdown. it is generic and may be used for any type of breakdown, except for breakdown element that are defined subtypes in AP239: i.e. FunctionalElement, PhysicalElement, SystemElement, or ZoneElement.

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

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

Figure 1 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.

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

Figure 1 -  Template block definition diagram for BreakdownElement

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

References:
breakdown [0..1] (Template: OASIS:Breakdown)
The BreakdownVersion of which the BreakdownElement is a constituent.
classifications [0..*] (Template: OASIS:Classifier)
The classification of the BreakdownElement
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:
Parts:
ids [1..*] (Template: OASIS:Identification)
The collection of identifiers of the BreakdownElement.
The reference data used in Template: OASIS:Identification is restricted as follows:
RDL constraint 1:
There must be one identifier that identifies the BreakdownElement.
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
versionId [0..1] (Template: OASIS:Identification)
The identifier of the BreakdownElementVersion version.
NOTE    If no versionId is specified a unique, unidentified BreakdownElementVersion 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:
descriptions [0..*] (Template: OASIS:Descriptor)
The descriptions of the BreakdownElement.
names [0..*] (Template: OASIS:Name)
The names of the BreakdownElement.

The following output ports are defined for this template:

bkdn_elem (Block: Ap239Ap233Psm:BreakdownElement)
Enables the Block: Ap239Ap233Psm:BreakdownElement instantiated by this template to be referenced when the template is used.
bkdn_elem_vn (Block: Ap239Ap233Psm:BreakdownElementVersion)
Enables the Block: Ap239Ap233Psm:BreakdownElementVersion instantiated by this template to be referenced when the template is used.
bkdn_elem_def (Block: Ap239Ap233Psm:BreakdownElementDefinition)
Enables the Block: Ap239Ap233Psm:BreakdownElementDefinition instantiated by this template to be referenced when the template is used.
bkdn_cntxt (Block: Ap239Ap233Psm:BreakdownContext)
Enables the Block: Ap239Ap233Psm:BreakdownContext instantiated by this template to be referenced when the template is used.

The following constraints are defined for this template:

Constraint: Uniqueness
Specification: (OCL2.0)
BreakdownElement::allInstances()->isUnique(ids, versionId, viewDefinitionContext, breakdown)
Ensures that the BreakdownElement is unique.

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

The public properties, i.e. those visible in the template's SysML block (See Figure 1) 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 2 -  Parametric diagram for BreakdownElement

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:breakdownElement [1] (Block: Ap239Ap233Psm:BreakdownElement)
Private Part Property:breakdownElementVersion [0..1] (Block: Ap239Ap233Psm:BreakdownElementVersion)
Private Part Property:breakdownElementDefinition [0..1] (Block: Ap239Ap233Psm:BreakdownElementDefinition)
Private Part Property:breakdownContext [0..1] (Block: Ap239Ap233Psm:BreakdownContext)

The following constraint, normally a uniqueness constraint, is applicable when instantiating the BreakdownContext:

rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1
Specification: (OCL2.0)
BreakdownContext::allInstances()->isUnique(Sequence{breakdown, breakdownElement})
Private Part Property:combNameAndDesc [1] (Constraint Block: OASIS:Name:CombineNamesAndDescriptors)

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

There are no constraint blocks defined in this template.

No example data sets have been provided for this DEX.