Template: OASIS:FailureEffect

This section specifies the template FailureEffect.

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

The specification comprises the following sections:

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

The FailureEffect template defines how to represent the effect of a Failure mode on functionality.

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

Figure 1 -  State representation model.

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

NOTE    The FailureEffect 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 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 constraints shown on the template's SysML Block are described in the template constraints section.

The SysML Parametric diagrams for the template Block are shown in template parametric diagram section.

Figure 2 -  Template block definition diagram for FailureEffect

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

References:
affects [0..1] (Template: OASIS:FunctionalElement)
The affect of the FailureEffect on a FunctionalElement.
resultOf [1] (Template: OASIS:FailureMode)
The FailureMode that the FailureEffect is a result of.
classifications [1..*] (Template: OASIS:Classifier)
The classifications of the FailureEffect.
Parts:
failureEffectId [1] (Template: OASIS:Identification)
The identifier of the FailureEffect.
effectDescription [1] (Template: OASIS:Descriptor)
The description of the FailureEffect.
restriction [0..1] (Template: OASIS:PropertyValueText)
Proposed restrictions on the FunctionalElement related to the FailureEffect.

The following output ports are defined for this template:

failureEffect (Block: Ap239Ap233Psm:StateDefinition)
Enables the Block: Ap239Ap233Psm:StateDefinition instantiated by this template to be referenced when the template is used.
failureEffectModeRelationship (Block: Ap239Ap233Psm:StateCauseEffectDefinition)
Enables the Block: Ap239Ap233Psm:StateCauseEffectDefinition instantiated by this template to be referenced when the template is used.

The following constraints are defined for this template:

Constraint: classificationConstraint
Specification: (English)
Classifications are restricted to, or subclass of http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Failure_effect
Classifications are restricted to, or sublcass of, failureEffect.

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

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 FailureEffect

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:failureEffectModeRelationship [0..1] (Block: Ap239Ap233Psm:StateCauseEffectDefinition)
Private Part Property:failureEffect [1] (Block: Ap239Ap233Psm:StateDefinition)

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

rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: UR1
Specification: (OCL2.0)
StateDefinition::allInstances()->isUnique(definition)
Private Part Property:stateDefinitionAssignment [0..1] (Block: Ap239Ap233Psm:StateDefinitionAssignment)
Private Part Property:classFunctionEffectedState [1] (Block: Ap239Ap233Psm:Classification)
Private Part Property:functionEffectedState [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:propertyValueAssignment [0..1] (Block: Ap239Ap233Psm:PropertyValueAssignment)

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

Instance diagram
Figure 3 -  Model instance diagram for FailureEffect

The following instances have been created:

classFunctionEffectedState instance of Block: Ap239Ap233Psm:ExternalOwlClass.
ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Function_effected_state

The Failure effect relationship is represented by a State cause effect definition which is classified as functionEffectedState.
classFailureEffect instance of Block: Ap239Ap233Psm:ExternalOwlClass.
ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Failure_effect

The Failure effect is represented by a State definition which, at least, is classified as failureEffect.

There are no constraint blocks defined in this template.

No example data sets have been provided for this Template.

Issue reporting