Template: EffectivityAssertion

This section specifies the template EffectivityAssertion.

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 EffectivityAssertion 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 EffectivityAssertion template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the EffectivityAssertion template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the EffectivityAssertion template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the EffectivityAssertion 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

This template describes how to represent the fact that a relationship or object is asserted to have the specified effectivity.

The specified effectivity is provided by the sameAs parameter that must be a member of the class http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/plcs/plcs-psm/refdata/plcs-psm#Effectivity.

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

../../../../../data/PLCS/psm_model/images/SysML_Block_Definition_Diagram__Diagrams__Effectivity.png

Figure 1 - Effectivity model

Related Templates

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

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

Template Properties

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

References:

sameAs [1] (Block: Ap239Ap233Psm:ExternalOwlObject)

The reference to the member that identifies this effectivity.

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

rule.Ap239Ap233Psm.ExternalOwlClass.ur1

Constraint: ur1

Specification: (OCL2.0)

ExternalOwlObject::allInstances()->isUnique(individual)

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

RDL constraint 1:

The effectivity asserted must be defined as a member of the OWL class Effectivity

The reference data for:

OASIS:EffectivityAssertion.sameAs -> 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#Effectivity

Example reference data is:

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

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

Parts:

assignedTo [1..*] (Block: Ap239Ap233Psm:EffectivityAssignmentSelect)

The items that are asserted to have this effectivity.

Template Output Ports

There are no output ports are defined for this template.

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

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 EffectivityAssertion

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

Private Part Property:effectivityAssignment [1] (Block: Ap239Ap233Psm:EffectivityAssignment)

Private Part Property:effectivityProxy [1] (Block: Ap239Ap233Psm:Proxy)

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 EffectivityAssertion

Instances

The following instances have been created:

sameAsNotEffective instance of Block: Ap239Ap233Psm:ExternalOwlObject.

ExternalOwlObject.individual = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Not_Effective

This is a common effectivity for use with this template to signify the fact that the object to which this is assigned is not effective.

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 EffectivityAssertion

The following constraint blocks have been created:

Constraint: CombineItems

Specification: (OCL2.0)

combinedItems = items1->union(items2, items3, items4)

The constraint block allows multiple items to be combined into a single collection for assignment using this template.

Example data

No example data sets have been provided for this Template.