relating_requirement

Template:— relating_requirement_versions (req_ver_rel)
Capability:representing_requirements

Date: 2009/03/16 15:14:21
Revision: 1.10

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

This section specifies the template relating_requirement_versions.

NOTE The template has been defined in the context of the capability representing_requirements which provides an overall description of the relevant parts of the ISO 10303-239 information model and a description 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 the creation of relationships between different versions of requirements.

Model diagrams

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

Figure 1 — Relating requirement versions (EXPRESS-G diagram)

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

Figure 2 — Relating requirement versions (condensed EXPRESS-G diagram)

Input parameters

The following input parameters are defined for this template:

related_version (Type= 'ENTITY (Requirement_version)' )

The preceding version of the requirement.

relating_version (Type= 'ENTITY (Requirement_version)' )

The succeding version of the requirement.

rel_type (Default=Successor_of,Type='CLASS')

The type of relationship between the versions.

The following classes and their sub-classes can be used:

classifications: "Requirement_version_relationship" (urn:plcs:rdl:std:Requirement_version_relationship)

rel_type_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The id of the External_class_library that stores the @rel_type definition.

Reference parameters

The following reference parameters are defined for this template:

req_ver_rel(Type='ENTITY (Requirement_version_relationship)')

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

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

%^target = $relating_requirement_versions.req_ver_rel%

where target is the parameter to which the Requirement_version_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.

-- Instantiate the Requirement_version_relationship entity.
Requirement_version_relationship

-- Bind the Requirement entity to the parameter ^req_ver_rel.
%^req_ver_rel = Requirement_version_relationship%
Requirement_version_relationship.relating_version -> @relating_version
Requirement_version_relationship.related_version -> @related_version
Requirement_version_relationship.relation_type = '/IGNORE'
Requirement_version_relationship.description = '/IGNORE'

-- Classify the Requirement_version_relationship
/assigning_reference_data(
    items=^req_ver_rel,
    class_name=@rel_type,
    ecl_id=@rel_type_ecl_id)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Requirement_version_relationship.relation_type	'/IGNORE'	Product_version_relationship.relation_type
Requirement_version_relationship.description	'/IGNORE'	Product_version_relationship.description

Instance diagrams

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

/relating_requirement_versions(related_version='#7', relating_version='#8', rel_type='Successor_of', rel_type_ecl_id='urn:plcs:rdl:sample')/

(an illustration of the consolidated relating_requirement_versions template is shown in Figure 4 below.)

Figure 3 — Entities instantiated by template relating_requirement_versions (EXPRESS-I diagram)

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

/relating_requirement_versions(related_version='#7', relating_version='#8', rel_type='Successor_of', rel_type_ecl_id='urn:plcs:rdl:sample')/

Figure 4 — Instantiation of template relating_requirement_versions

Characterizations

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