This section specifies the template EventReport.
The specification comprises a SysML Block that represents the template and an
associated Parametric Diagram that defines the templates and
PLCS PSM objects
instantiated by the EventReport 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 Part, Reference and Value properties of the
templates SysML Block;
- Section Template Output Ports
specifies the Output Ports of the templates SysML Block. These bind to the
templates and PLCS PSM objects
instantiated by the EventReport template as
described in section Template
Parametric Diagram;
- Section Template Constraints specifies
the constraints on PLCS PSM objects instantiated by the
EventReport template;
- Section Template Parametric
Diagram specifies the templates and PLCS PSM objects instantiated by the
EventReport template;
- Section Instantiated blocks specifies
the templates and PLCS PSM objects instantiated by the
EventReport 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
overviewThe EventReport template describes how to represent the report of an event. As it
could report on many things, this concept is represented as a Collection and can
potentially contain:
- documents
- observed environments
- observations
- performed activities
- proposed solutions for the problem
- affected items
The SysML Block Definition diagram in Figure 1 shows how a
activity is represented in the PLCS PSM.
Figure 1 - Collection model
No templates have been explicitly defined as being related to the EventReport template.
NOTE
The EventReport template may make reference
to other templates as part of the Parametric Diagram. These are not listed
here.
Figure 2 shows the SysML Block that represents the template. The Block is an abstraction
representing a pattern of templates and PLCS PSM 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 constraints shown on the template's SysML Block are described in the template constraints section.
Figure 2 - Template block definition diagram for EventReport
The following Part, Reference, and Value properties are defined for this template:
References:
documents [0..*] (Template: OASIS:
Document)
A collection of documents assigned to the EventReport
classifications [0..*] (Template: OASIS:
Classifier)
The collection of classifications for the EventReport (
Collection)
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:
approvals [0..*] (Block: Ap239Ap233Psm:
Approval)
The collection of approvals for the report
contract [0..1] (Template: OASIS:
Contract)
The contract reference the event report is linked with
Parts:
ids [1..*] (Template: OASIS:
Identification)
The collection of identification of the EventReport (
Collection)
The reference data used in Template: OASIS:
Identification is restricted as follows:
RDL constraint 1:There must be one identifier that identifies the
Collection.
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
versionId [1] (Template: OASIS:
Identification)
The reference data used in Template: OASIS:
Identification is restricted as follows:
RDL constraint 1:The identifier must be a version identifier.
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
Values:
The following output ports are defined for this template:
report (Block: Ap239Ap233Psm:
Collection)
Enables the
Block: Ap239Ap233Psm:
Collection instantiated by this template to be referenced
when the template is used.
The following constraints are defined for this template:
Constraint: restrictClassifsSpecification: (English)
Classifications are restricted to or subclasses of
http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Event_report
This section describes the template's Parametric Diagrams. Each diagram details
the pattern of templates and PLCS PSM objects that are required to
represent the template EventReport.
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 the Parametric Diagram.
PLCS PSM
objects are shaded khaki and template shaded light green in a Parametric Diagram.
Figure 2 - EventReport basics
Figure 3 - EventReport ReportedBy, Approvals and Documents
Figure 4 - EventReport Contract Assignment
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:
collection [1] (Template: OASIS:
Collection)
Private Part Property:
classifDtaCreation [1] (Template: OASIS:
Classifier)
Private Reference Property:
classDateActualCreation [1] (Block: Ap239Ap233Psm:
ExternalOwlClass)
The following constraint, normally a uniqueness constraint, is
applicable when instantiating the ExternalOwlClass:
rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)
Private Part Property:
classifDtaEnd [0..1] (Template: OASIS:
Classifier)
Private Reference Property:
classDateActualEnd [1] (Block: Ap239Ap233Psm:
ExternalOwlClass)
The following constraint, normally a uniqueness constraint, is
applicable when instantiating the ExternalOwlClass:
rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)
Private Part Property:
stateAsg [0..1] (Block: Ap239Ap233Psm:
StateAssignment)
Private Part Property:
classifPersOrgAsg [0..1] (Template: OASIS:
Classifier)
Private Reference Property:
classActualReporter [0..1] (Block: Ap239Ap233Psm:
ExternalOwlClass)
The following constraint, normally a uniqueness constraint, is
applicable when instantiating the ExternalOwlClass:
rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)
Figure 5 shows the instances that have been instantiated in the template. These are
used to set the default value of blocks.
Figure 5 - Model instance diagram for EventReport
The following instances have been created:
There are no constraint blocks defined in this template.
No example data sets have been provided for this DEX.