Template: OASIS:ActualProductUsage

This section specifies the template ActualProductUsage.

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 ActualProductUsage template.

The specification comprises the following sections:

NOTE    An explanation of a template and its specification is provided in the Template overview

The ActualProductUsage template describes how to represent a record of the usage of a product, e.g. the use of an airplane for a specific mission or the use of a truck for a specific transportation.

It represents an activity that has at least started and may have finished - an actual activity.

It can be used to record any information about a product usage, such as what product individual was used, who has reported the product usage, what typical activity was followed, and when the product was used. It is mandatory to assign an identifier or name to the activity, provide a start time if the activity, and identify the product being used.

The ActualProductUsage is one of a set of templates used to represent activities. These are summarized in Figure 1 which shows that the model contains templates for:

The actual templates are:

Figure 1 -  Templates representing activities

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

Figure 2 -  Activity model

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

NOTE    The ActualProductUsage template may make reference to other templates as part of the Parametric Diagram. These are not listed here.

Figure 3 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 3 -  Template block definition diagram for ActualProductUsage

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

References:
product [1] (Template: OASIS:RealizedPart)
that actual product that performed the activity.
operator [0..*] (Block: Ap239Ap233Psm:OrganizationOrPersonInOrganizationSelect)
the operator of the product when the product was used
location [0..*] (Block: Ap239Ap233Psm:Location)
The location where the product was used.
methodUsed [0..1] (Block: Ap239Ap233Psm:ActivityMethod)
the method by which the product was used
plannedProductUsage [0..1] (Block: Ap239Ap233Psm:Activity)
the planned product usage that resulted in this usage of the product being undertaken.
resourcesUsed [0..*] (Block: Ap239Ap233Psm:ResourceAsRealized)
the resources that were used to perform the activity
Parts:
classifications [0..*] (Template: OASIS:Classifier)
The classification of the activity.
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 the following class or a subclass:
ids [1..*] (Template: OASIS:Identification)
The collection of identifiers of the activity.
The reference data used in Template: OASIS:Identification is restricted as follows:
RDL constraint 1:
The id must be classified as an Activity_identification_code or a subclass thereof.
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
descriptions [0..*] (Template: OASIS:Descriptor)
the descriptions of the activity
status [0..1] (Template: OASIS:StateAssertion)
the status of the activity
The reference data used in Template: OASIS:StateAssertion is restricted as follows:
RDL constraint 1:
The status is represented subclasses of State_of_activity.
The reference data for:
OASIS:StateAssertion.sameAs -> ExternalOwlObject.individual
is restricted to the following class or a subclass:
names [0..*] (Template: OASIS:Name)
The names of the activity
Values:
actualStartDate [1] (Block: Ap239Ap233Psm:DateTimeString)
the date and time when the activity started.

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')
actualEndDate [0..1] (Block: Ap239Ap233Psm:DateTimeString)
the date and time when the activity ended.

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')

The following output ports are defined for this template:

activityActual (Block: Ap239Ap233Psm:ActivityActual)
Enables the Block: Ap239Ap233Psm:ActivityActual instantiated by this template to be referenced when the template is used.

There are no constraints defined for this template.

This section describes the template's Parametric Diagrams. Each diagram details the pattern of templates and PLCS PSMTemplate objects that are required to represent the template ActualProductUsage.

The public properties, i.e. those visible in the template's SysML block (See Figure 3) 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 2 -  ActualProductUsage
Figure 3 -  ActualProductUsage Dates
Figure 4 -  ActualProductUsage Status
Figure 5 -  ActualProductUsage Operator
Figure 6 -  ActualProductUsage Resources used
Figure 7 -  ActualProductUsage Project

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:activityActual [1] (Block: Ap239Ap233Psm:ActivityActual)
Private Part Property:productActAsg [1] (Block: Ap239Ap233Psm:ActivityAssignment)
Private Reference Property:classProductUsage [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:classifyProductUsage [0..*] (Template: OASIS:Classifier)
Private Part Property:activityHappening [0..1] (Block: Ap239Ap233Psm:ActivityHappening)
Private Part Property:classifyActualStartDate [0..1] (Template: OASIS:Classifier)
Private Reference Property:classActualStart [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:actualStartDateAsg [1] (Block: Ap239Ap233Psm:DateTimeAssignment)
Private Part Property:actualEndDateAsg [0..1] (Block: Ap239Ap233Psm:DateTimeAssignment)
Private Part Property:classifyActualEndDate [0..1] (Template: OASIS:Classifier)
Private Reference Property:classActualEnd [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:stateAsgn [0..1] (Block: Ap239Ap233Psm:StateAssignment)
Private Reference Property:classPerformedBy [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:classifiyPersOrgAsg [0..*] (Template: OASIS:Classifier)
Private Part Property:persOrgAsgn [0..*] (Block: Ap239Ap233Psm:OrganizationOrPersonInOrganizationAssignment)
Private Part Property:resourceAsRealizedAsg [0..*] (Block: Ap239Ap233Psm:ResourceAsRealizedAssignment)
Private Part Property:classifyResourceAsg [0..*] (Template: OASIS:Classifier)
Private Reference Property:classResourceAsRealizedUsedBy [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:locationAssignment [0..*] (Block: Ap239Ap233Psm:LocationAssignment)
Private Part Property:classifyActivityPerformedAt [0..*] (Template: OASIS:Classifier)
Private Reference Property:classActivityPerformedAt [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:combNamAndDesc [1] (Constraint Block: OASIS:Descriptor:CombineDescriptors)

Figure 8 shows the instances that have been instantiated in the template. These are used to set the default value of blocks.

Instance diagram
Figure 8 -  Model instance diagram for ActualProductUsage

The following instances have been created:

There are no constraint blocks defined in this template.

No example data sets have been provided for this Template.