Template: FleetItem

This section specifies the template FleetItem.

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 FleetItem 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 FleetItem template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the FleetItem template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the FleetItem template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the FleetItem 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 FleetItem template describes how to represent an item (usually a product) that is a member of a fleet of items

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

../../../../../data/PLCS/psm_model/images/SysML_Block_Definition_Diagram__Diagrams__Collection.png

Figure 1 - Collection model

Related Templates

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

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

Template Properties

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

References:

item [1] (Block: Ap239Ap233Psm:CollectionMemberSelect)

The item in the Fleet

fleet [1] (Template: OASIS:Fleet)

The fleet in which the item belongs to

Parts:

effectivityRole [0..1] (Template: OASIS:Classifier)

The role of the effectivity

Values:

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

The date when the item in the Fleet starts to be 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')

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

The date when the item in the Fleet ends to be 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:

fleetItem (Block: Ap239Ap233Psm:CollectionMembership)

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

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 FleetItem

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

Private Part Property:classifierCM [1] (Template: OASIS:Classifier)

Private Reference Property:classifFleetItem [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:datedEffect [1] (Template: OASIS:DatedEffectivity)

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 FleetItem

Instances

The following instances have been created:

classFleetItem instance of Block: Ap239Ap233Psm:ExternalOwlClass.

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

Constraint Blocks

There are no constraint blocks defined in this template.

Example data

No example data sets have been provided for this Template.