Template: OASIS:CatalogItemStructure
Introduction

This section specifies the template CatalogItemStructure.

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

The specification comprises the following sections:

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

The CatalogItemStructure template describes how to represent a parent/child relationship in between catalog items

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 diagram diagram diagram diagram diagram diagram
Figure 1 -  Breakdown model
Related Templates

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

NOTE    The CatalogItemStructure 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.

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

Template diagram
Figure 2 -  Template block definition diagram for CatalogItemStructure
Template Properties

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

References:
parent [1] (Template: OASIS:CatalogItem)
The reference to the parent Catalog item
child [1] (Template: OASIS:CatalogItem)
The reference to the child Catalog item
effectivityRole [0..1] (Template: OASIS:Classifier)
The role for the dated effectivity
Parts:
ids [0..*] (Template: OASIS:Identification)
The collection of identifications for the relationship
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 when the relationship starts to be valid
endEffectivityDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)
The date when the relationship ends to be valid
Template Output Ports

The following output ports are defined for this template:

catalogItemStructure (Template: OASIS:BreakdownStructure)
Enables the Template: OASIS:BreakdownStructure instantiated by this template to be referenced when the template is used.
Template constraints

The following constraints are defined for this template:

Constraint: definitionMustBeSet
Specification: (English)
parent.ViewDefinitionContext not null and child.ViewDefinitionContext not null
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 CatalogItemStructure.

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.

Binding diagram
Figure 3 -  Parametric diagram for CatalogItemStructure
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:breakdownStructure [1] (Template: OASIS:BreakdownStructure)
Private Reference Property:clsCIStructure [1] (Block: Ap239Ap233Psm:ExternalOwlClass)

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

rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1
Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)
Private Part Property:structureClassifer [1] (Template: OASIS:Classifier)
Default instances

Figure 3 shows the instances that have been instantiated in the template. These are used to set the default value of blocks.

Instance diagram
Figure 3 -  Model instance diagram for CatalogItemStructure
Instances

The following instances have been created:

classCatalogItemStructure instance of Block: Ap239Ap233Psm:ExternalOwlClass.
ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Catalogue_item_structure

Constraint Blocks

There are no constraint blocks defined in this template.

Example data

No example data sets have been provided for this DEX.