Template: FunctionalElement

This section specifies the template FunctionalElement.

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 FunctionalElement 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 FunctionalElement template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the FunctionalElement template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the FunctionalElement template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the FunctionalElement 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 FunctionalElement template describes how to represent the nodes or functional elements in the functional breakdown of a product.

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

../../../../../data/PLCS/psm_model/images/SysML_Block_Definition_Diagram__Diagrams__FunctionalBreakdown.png

Figure 1 - Function Breakdown model.

Related Templates

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

NOTE The FunctionalElement 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 FunctionalElement

Template Properties

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

References:

viewDefinitionContext [0..1] (Template: OASIS:ViewDefinitionContext)

The ViewDefinitionContext of the FunctionalElementDefinition.

functionalBreakdown [0..1] (Template: OASIS:FunctionalBreakdown)

The FunctionalBreakdown of which the FunctionalElement is a constituent.

Parts:

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

The descriptions of the FunctionalElement.

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

The collection of identifiers of the FunctionalElement.

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

RDL constraint 1:

There must be one identifier that identifies the FunctionalElement.

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

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

The names of the FunctionalElement.

versionId [0..1] (Template: OASIS:Identification)

The identifier of the FunctionalElementVersion version.

NOTE If no versionId is specified a unique, unidentified FunctionalElementVersion 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#Functional_element_version_identification_code

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

The classification of the FunctionalElement

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

Template Output Ports

The following output ports are defined for this template:

functionalBreakdownContext (Block: Ap239Ap233Psm:FunctionalBreakdownContext)

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

functionalElement (Block: Ap239Ap233Psm:FunctionalElement)

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

functionalElementVersion (Block: Ap239Ap233Psm:FunctionalElementVersion)

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

functionalElementDefinition (Block: Ap239Ap233Psm:FunctionalElementDefinition)

Enables the Block: Ap239Ap233Psm:FunctionalElementDefinition 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 PSMTemplate objects that are required to represent the template FunctionalElement.

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 FunctionalElement

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

Private Part Property:functionalElementVersion [0..1] (Block: Ap239Ap233Psm:FunctionalElementVersion)

Private Part Property:functionalElementDefinition [0..1] (Block: Ap239Ap233Psm:FunctionalElementDefinition)

Private Part Property:functionalBreakdownContext [0..1] (Block: Ap239Ap233Psm:FunctionalBreakdownContext)

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.