Template:— failure_relationship (flr_rel)
Context:— UK_Defence

Date: 2009/04/17 11:28:55
Revision: 1.2

Cover Contents Description Bus. perspective Bus. obj.Model diags.Input params.Ref. params.Instantiation path Instance diags.Characterizations Issues in situ

This section specifies the template failure_relationship.

NOTE The template has been defined in the context of UK_Defence. Refer to the business context for details of related templates.

NOTE An explanation of a template and the associated instantiation path is provided in the Template overview section.

Description

This template describes how to represent a relationship between two failures.

Business perspective

This template describes how to represent the UK_Defence concept of a failure relationship in terms of PLCS model elements (templates, entities, and reference data).

Business object definition

The definition of the failure_relationship object is: This object represents a relationship between two failures.

Figure 1 — Graphical Representation for Business Object failure_relationship

Attribute name	Attribute description	Attribute type	Optionality
Description	This is the qualifying description of the relationship between the two failures.	Intrinsic	Optional
ID	This is the identifier of the failure relationship.	Identifier	Mandatory
Related failure	This is the reference to the failure that is related to the relating failure.	Failure	Mandatory
Relating failure	This is the reference to the failure that is related to by the related failure.	Failure	Mandatory

Table 1 — Failure Relationship attribute details

Model diagrams

The EXPRESS-G diagram in Figure 2 shows the templates and EXPRESS entities that are required to represent the template "failure_relationship". The text highlighted in blue shows the template parameters.

Figure 2 — An EXPRESS-G representation of the Information model for failure_relationship

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure 3 below.

Figure 3 — The graphical representation of the failure_relationship template

Input parameters

The following input parameters are defined for this template:

ID (Type='STRING')

This is the identifier of the failure_relationship.

ID_source_organization (Default=UK_Defence,Type='STRING')

The organization that created the associated identifier. Additionally a Person or Information System could be defined when either of these are the source; see Identifier template characterizations.

Description (Default=/OPTIONAL,Type='STRING', Optional)

The description of the failure_relationship.

Related_failure (Type= 'ENTITY (State_definition)' )

This is the reference to the (child) failure that is related to the relating (parent) failure.

Relating_failure (Type= 'ENTITY (State_definition)' )

This is the reference to the (parent) failure that is related to by the related (child) failure.

Reference parameters

The following reference parameters are defined for this template:

state_rel(Type='ENTITY (State_relationship)')

Allow the State_relationship entity instantiated in this path to be referenced when this template is used.

Note: The State_relationship entity can be referenced in a template path by:

%^target = $failure_relationship.state_rel%

where target is the parameter to which the State_relationship is bound.

Instantiation path

The instantiation path shown below specifies the entities that are to be instantiated by the template.

A description of templates and the syntax for the instantiation path is provided in the Templates Help/Information section.

-- failure_relationship
State_relationship
State_relationship.name = '/IGNORE'
State_relationship.description = '/IGNORE'
State_relationship.related -> @Related_failure
State_relationship.relating -> @Relating_failure
%^state_rel = State_relationship%

-- [optional Description]
-- NB SEDS required to add State_relationship to documented_element_select
/assigning_descriptor(
    descr=@Description,
    class_name='Failure_relationship_description',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^state_rel)/

-- ID (mandatory)
/identifier(
    ID=@ID,
    source_organization=@ID_source_organization,
    type='Failure_relationship_identifier',
    items=^state_rel)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
State_relationship.name	'/IGNORE'	—
State_relationship.description	'/IGNORE'	—

Instance diagrams

The instance diagram in Figure 4 shows an example of the EXPRESS entities and templates that are instantiated by the template:

/failure_relationship(ID='FR001', ID_source_organization='UK_Defence', Description='/OPTIONAL')/

(an illustration of the consolidated failure_relationship template is shown in Figure 5 below.)

Figure 4 — Entities instantiated by failure_relationship template

The instance diagram in Figure 5 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:

/failure_relationship(ID='FR001', ID_source_organization='UK_Defence', Description='/OPTIONAL')/

Figure 5 — Instantiation of failure_relationship template

Characterizations

No common characterizations of the template failure_relationship have been identified. However, the ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.