Template: PropertyValueText

This section specifies the template PropertyValueText.

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 PropertyValueText 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 PropertyValueText template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the PropertyValueText template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the PropertyValueText template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the PropertyValueText 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 PropertyValueText template describes how to represent a single text value for a specified property. It provides a context for the value, and the representation may be further characterized by assigning organization etc.

EXAMPLE The colour of an item.

The SysML Block Definition diagram in Figure 1 shows how Properties are represented in the PLCS PSM.

NOTE Figure 1 only shows minimal set of information needed to represent properties. More advanced representation of properties that enables representation of features such as tolerances is given in Figure Properties in the PLCS PSM.

../../../../../data/PLCS/psm_model/images/SysML_Block_Definition_Diagram__Diagrams__Properties.png

Figure 1 - Property model

Related Templates

The following templates are related to the PropertyValueText template:

PropertyValueNumeric (OASIS)
The PropertyValueNumeric template defines how to assign a numeric value with a unit to an identified property.

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

Template Properties

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

References:

property [1] (Block: Ap239Ap233Psm:ProxyItemSelect)

The property for which the value is specified, e.g. "Colour".

The reference data used in Block: Ap239Ap233Psm:ProxyItemSelect is restricted as follows:

RDL constraint 1:

The reference data for:

ExternalOwlObject.individual

is restricted to individuals that are members of the following class:

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

Parts:

value [1] (Block: Ap239Ap233Psm:LocalizedString)

The string value of the property e.g. "Blue".

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

Classification of PropertyValue.

Values:

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

The optional date/time when the property value was measured.

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:

value (Block: Ap239Ap233Psm:PropertyValue)

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

The PropertyValue for use in relationships with other objects.

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

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 PropertyValueText

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 Reference Property:prop [1] (Block: Ap239Ap233Psm:ExternalPropertyDefinition)

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

rule.Ap239Ap233Psm.ExternalOwlClass.ur1

Constraint: UR1

Specification: (OCL2.0)

ExternalPropertyDefinition::allInstances()->isUnique(definition)

Private Part Property:propertyValue [1] (Block: Ap239Ap233Psm:StringValue)

Private Part Property:dateAssignment [0..1] (Block: Ap239Ap233Psm:DateTimeAssignment)

Private Reference Property:dateMeasuredObj [0..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:dateClassifier [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.

Figure 3 - Model instance diagram for PropertyValueText

Instances

The following instances have been created:

classDateActualCreation instance of Block: Ap239Ap233Psm:ExternalOwlClass.

ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Date_actual_creation

This is used in the definition of the template to ensure the date assignment is correctly classified.

Constraint Blocks

There are no constraint blocks defined in this template.

Example data

The following section provides an example XML dataset that has been instantiated in accordance with this template.

Data set: Text property

Text property

text_property.xml

View

download

This example shows the XML instantiated to represent a ProductAsIndividual that has a property "Colour" with a value "Red".