representing_required_resource

Template:— representing_required_resource_relationship (rep_req_res_rel)

Date: 2008/03/05 16:17:55
Revision: 1.5

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

This section specifies the template representing_required_resource_relationship.

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 required resources, where type of relationship is determined by classification.

Model diagrams

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

Figure 1 — An EXPRESS-G representation of the Information model for representing_required_resource_relationship

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

Figure 2 — The graphical representation of the representing_required_resource_relationship template

Input parameters

The following input parameters are defined for this template:

req_res_rel_class_name (Type='CLASS')

The name of the External_class that determines type of relationship.

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

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

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

The identification of the External_class_library storing the External_class given by the input parameter @class_name.

relating_req_res (Type= 'ENTITY (Required_resource)' )

The Required_resource that relates to another Required_resource .

related_req_res (Type= 'ENTITY (Required_resource)' )

The Required_resource being related to by another Required_resource .

Reference parameters

The following reference parameters are defined for this template:

relationship(Type='ENTITY (Required_resource_relationship)')

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

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

%^target = $representing_required_resource_relationship.relationship%

where target is the parameter to which the Required_resource_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 and bind Required_resource_relationship
Required_resource_relationship
%^relationship = Required_resource_relationship%
^relationship.name = '/IGNORE'
^relationship.description = '/IGNORE'
^relationship.relating -> @relating_req_res
^relationship.related -> @related_req_res

-- Invocate template assigning_reference_data and
-- assign it to Required_resource_relationship
/assigning_reference_data(
    class_name= @req_res_rel_class_name,
    ecl_id= @req_res_rel_ecl_id,
    items= ^relationship)/

The following entities are instantiated with attributes as specified:

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

Instance diagrams

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

/representing_required_resource_relationship(class_name='Alternative_resource', ecl_id='urn:plcs:rdl:sample', relating_req_res='#1', related_req_res='#2')/

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

Figure 3 — Entities instantiated by representing_required_resource_relationship template

The instance model in STEP ASCII exchange file format (ISO 10303 Part 21 syntax) is:


          #1 = REQUIRED_RESOURCE_BY_RESOURCE_ITEM('/IGNORE','/IGNORE',$,$);
          #2 = REQUIRED_RESOURCE_BY_RESOURCE_ITEM('/IGNORE','/IGNORE',$,$);
          #3 = REQUIRED_RESOURCE_RELATIONSHIP('/IGNORE','/IGNORE',#1,#2);
          #5 = CLASSIFICATION_ASSIGNMENT(#6,(#3),'/IGNORE');
          #6 = EXTERNAL_CLASS('/NULL','Alternative_resource','/IGNORE',#7);
          #7 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:sample','/IGNORE');

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:

/representing_required_resource_relationship(class_name='Alternative_resource', ecl_id='urn:plcs:rdl:sample', relating_req_res='#1', related_req_res='#2')/

Figure 4 — Instantiation of representing_required_resource_relationship template

Characterizations

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