representing_resource_item

Template:— representing_resource_item_relationship (rep_res_item_rel)
Capability:representing_resource

Date: 2008/02/21 16:29:46
Revision: 1.8

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

This section specifies the template representing_resource_item_relationship.

NOTE The template has been defined in the context of the capability representing_resource 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 how to represent a relationship between two resource items.

Model diagrams

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

Figure 1 — An EXPRESS-G representation of the Information model for representing_resource_item_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_resource_item_relationship template

Input parameters

The following input parameters are defined for this template:

class_name (Type='CLASS')

The name of the External_class used to describe the role of the relationship.

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

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

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

The id of the External_class_library storing the @class_name

relating (Type= 'ENTITY (Resource_item)' )

The Resource_item entity which relates to another Resource_item .

related (Type= 'ENTITY (Resource_item)' )

The Resource_item entity which is related to from another Resource_item .

Reference parameters

The following reference parameters are defined for this template:

res_item_rel(Type='ENTITY (Resource_item_relationship)')

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

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

%^target = $representing_resource_item_relationship.res_item_rel%

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

Resource_item_relationship

-- Mark the Resource_item_relationship entity as
-- referable when this template is used by binding it to the reference
-- parameter res_item_rel
%^res_item_rel = Resource_item_relationship%
Resource_item_relationship.name = '/IGNORE'
Resource_item_relationship.description = '/IGNORE'
Resource_item_relationship.relating -> @relating
Resource_item_relationship.related -> @related

-- Provide the role of the relationship by classifying the Resource_item_relationship
/assigning_reference_data(
    items=^res_item_rel,
    class_name=@class_name,
    ecl_id=@ecl_id)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Resource_item_relationship.name	'/IGNORE'	—
Resource_item_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_resource_item_relationship(class_name='Alternative', ecl_id='urn:plcs:rdl:sample', relating='#1', realted='#2')/

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

Figure 3 — Entities instantiated by representing_resource_item_relationship template

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_resource_item_relationship(class_name='Alternative', ecl_id='urn:plcs:rdl:sample', relating='#1', realted='#2')/

Figure 4 — Instantiation of representing_resource_item_relationship template

Characterizations

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