Template: FaultEffectDefinition

This section specifies the template FaultEffectDefinition.

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 FaultEffectDefinition 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 FaultEffectDefinition template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the FaultEffectDefinition template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the FaultEffectDefinition template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the FaultEffectDefinition 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 FaultEffectDefinition template describes how to representthe effect a fault mode could have on a specific function or on the entire product. May be expressed as local effect, intermediate effect or top effect, e.g. a leaking fuelpipe causes local effect on…, itermediate effect on…, and … effect on top level.

Related Templates

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

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

Template Block

Figure 1 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 1 - Template block definition diagram for FaultEffectDefinition

Template Properties

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

References:

resultOf [1] (Template: SwedishDefence:FaultModeDefinition)

Relationship to the fault mode that causes the fault effect.

concernedFunction [0..1] (Template: SwedishDefence:FunctionalElement)

Relationship to the functional structure element that suffers from a fault effect.

Parts:

faultEffectDefinitionDescription [1] (Template: OASIS:Descriptor)

Description of a fault effect.

The reference data used in Template: OASIS:Descriptor is restricted as follows:

RDL constraint 1:

faultEffectDescription constraint

The reference data for:

OASIS:Descriptor.classifiedAs -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#faultEffectDefinitionDescription

faultEffectLevel [0..1] (ValueType: ExternalOwlClass)

The level in the product structure at which the FaultEffectDefinition was discovered, according to DEF-STAN 00-60 (local, next-higher, or end item). Should be used if no FunctionalStructureElement is related (parameter concernedFunction)

The reference data used is restricted to the following set:

local = http://plcs.fmv.se/rd/SwedishDefence-rdl-en#faultEffectLevel_local

nextHigher = http://plcs.fmv.se/rd/SwedishDefence-rdl-en#faultEffectLevel_nextHigher

endEffect = http://plcs.fmv.se/rd/SwedishDefence-rdl-en#faultEffectLevel_endItem

The reference data used in is restricted as follows:

RDL constraint 1:

faultEffectLevel constraint

The reference data for:

OASIS:Identification.role -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#FaultEffectLevel

faultEffectDefinitionId [1] (Template: OASIS:Identification)

Identification of a fault effect definition.

The reference data used in Template: OASIS:Identification is restricted as follows:

RDL constraint 1:

faultEffectId constraint

The reference data for:

OASIS:Identification.role -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#faultEffectDefinitionId

criticalityLevel [0..1] (ValueType: ExternalOwlClass)

Indication of how critical the fault effect is for the product's function and use.

The reference data used is restricted to the following set:

fullMissionCapable = http://plcs.fmv.se/rd/SwedishDefence-rdl-en#criticalityLevel_fullMissionCapable

partialMissionCapable = http://plcs.fmv.se/rd/SwedishDefence-rdl-en#criticalityLevel_partialMissionCapable

notMissionCapable = http://plcs.fmv.se/rd/SwedishDefence-rdl-en#criticalityLevel_notMissionCapable

The reference data used in is restricted as follows:

RDL constraint 1:

criticalityLevel constraint

The reference data for:

OASIS:Identification.role -> ExternalOwlClass.class

is restricted to one of the following classes or a subclass of one of them:

http://plcs.fmv.se/rd/SwedishDefence-rdl-en#CriticalityLevel

Template Output Ports

The following output ports are defined for this template:

stateDefintion (Block: Ap239Ap233Psm:StateDefinition)

Enables the Block: Ap239Ap233Psm:StateDefinition 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 FaultEffectDefinition.

The public properties, i.e. those visible in the template's SysML block (See Figure 1) 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 - FaultEffectDefinition

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 Reference Property:classFaultEffectDefinition [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:FaultEffectDefinitionClass [1] (Template: OASIS:Classifier)

Private Part Property:combineClassification [1] (Constraint Block: OASIS:Classifier:CombineClassification)

Private Part Property:levelCodeClass [0..1] (Template: OASIS:Classifier)

Private Part Property:concernsFunctionalAsg [0..1] (Block: Ap239Ap233Psm:StateDefinitionAssignment)

Private Part Property:causes_FaultModeAsg [1] (Block: Ap239Ap233Psm:StateCauseEffectDefinition)

Private Reference Property:FaultEffectDefinition [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:definition [1] (Block: Ap239Ap233Psm:ExternalItem)

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

rule.Ap239Ap233Psm.ExternalOwlClass.ur1

Constraint: ur1

Specification: (OCL2.0)

ExternalItem::allInstances()->isUnique(Sequence{id, source})

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

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

Default instances

There are no instances that have been instantiated in this template.

Constraint Blocks

There are no constraint blocks defined in this template.

Example data

No example data sets have been provided for this Template.