Template: Descriptor

This section specifies the template Descriptor.

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 Descriptor 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 Descriptor template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the Descriptor template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the Descriptor template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the Descriptor 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 Descriptor template describes how to represent a text based description.

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

../../../../../data/PLCS/psm_model/images/SysML_Block_Definition_Diagram__Diagrams__Description.png

Figure 1 - Description model

Related Templates

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

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

Template Properties

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

References:

context [0..1] (Block: Ap239Ap233Psm:IdentificationContextSelect)

the context in which the description has been made.

describedBy [0..1] (Block: Ap239Ap233Psm:OrganizationOrPersonInOrganizationSelect)

the person or organization that created the description.

Parts:

text [1] (Block: Ap239Ap233Psm:LocalizedString)

the LocalizedString representing providing the textual content of the description.

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

the identifications of the description

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

RDL constraint 1:

The id must be classified as a Descriptor_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#Descriptor_identification_code

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

The classification of the Descriptor

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

Values:

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

the date from which the description is valid

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

rule.Ap239Ap233Psm.ExternalOwlClass.ur1

Constraint: XSDDATETIME

Specification: (OCL2.0)

self.matches('[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z')

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

the date from which the description is valid

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

rule.Ap239Ap233Psm.ExternalOwlClass.ur1

Constraint: XSDDATETIME

Specification: (OCL2.0)

self.matches('[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z')

Template Output Ports

The following output ports are defined for this template:

descriptor (Block: Ap239Ap233Psm:Descriptor)

Enables the Block: Ap239Ap233Psm:Descriptor 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 Descriptor.

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 Descriptor

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

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

Private Part Property:describedByAssignment [0..1] (Block: Ap239Ap233Psm:OrganizationOrPersonInOrganizationAssignment)

Default instances

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

Constraint Blocks

Figure 3 shows the constraint blocks that have been created in the template.

Constraint Blocks are typically used to combine blocks into a collection that can then be bound to a property. For example, combining a set of identifications that can then be bound to property of type Identification.

Figure 3 - Constraint block diagram for Descriptor

The following constraint blocks have been created:

Constraint: CombineDescriptions

Specification: (OCL2.0)

combinedDescr=descr1->union(descr2, descr3, descr4)

The constraint block allows multiple Descriptor Blocks to be combined into a single collection.

Constraint: CombineDescriptors

Specification: (OCL2.0)

combinedDescr=descr1->union(descr2, descr3, descr4)

The constraint block allows multiple Descriptor templates to be combined into a single collection.

Example data

No example data sets have been provided for this Template.