representing_resource_item

Template:— representing_resource_item_realization (rep_res_item_real)

Date: 2008/02/26 19:03:42
Revision: 1.8

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

This section specifies the template representing_resource_item_realization.

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 the realization of a resource item, where the resource item is used as a placeholder for the object that the resource item may refer to.

NOTE The resource item under consideration shall already exist in the data set, and been created in accordance with the template representing_resource_item.

NOTE The reference parameter defined within this template shall not be used ouside the scope of this template, i.e. the reference parameter shall be regarded as being 'private' to this template. This is due to that entity instances being used in this template already exists and can be referenced using reference parameters in other templates.

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_realization". The text highlighted in blue shows the template parameters.

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

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_realization template

Input parameters

The following input parameters are defined for this template:

res_item_id (Type='STRING')

The identification of the Resource_item

res_item_id_class (Default=Resource_item_identification_code,Type='CLASS')

The type of identifier (@res_item_id) being referenced

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

classifications: "Resource_item_identification_code" (urn:plcs:rdl:std:Resource_item_identification_code), "Resource_item_name" (urn:plcs:rdl:std:Resource_item_name)

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

The id of the External_class_library storing the @res_item_id_class

res_item_id_org_id (Type='STRING')

The Organization that "owns" the identifier.

res_item_id_org_id_class (Default=Organization_name,Type='CLASS')

The type of Organization identifier.

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

classifications: "Organization_identification_code" (urn:plcs:rdl:std:Organization_identification_code), "Organization_name" (urn:plcs:rdl:std:Organization_name)

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

The id of the External_class_library storing the definition of the class used to classify the organization identifier.

res_item_items (Type= 'SELECT (resource_item_select)' )

Item that shall be added to the SET of resource items that realizes the resource item under consideration.

Reference parameters

The following reference parameters are defined for this template:

res_item(Type='ENTITY (Resource_item)')

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

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

%^target = $representing_resource_item_realization.res_item%

where target is the parameter to which the Resource_item 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 Reading Capability Templates help section.

Resource_item

-- Mark the file entity as
-- referable when this template is used by binding it to the reference
-- parameter id_assgn
%^res_item = Resource_item%
Resource_item.name = '/IGNORE'
Resource_item.description = '/IGNORE'
Resource_item.resource_items -> @res_item_items

-- Identification of the Resource_item
/assigning_identification(
    items=^res_item,
    id=@res_item_id,
    id_class_name=@res_item_id_class,
    id_ecl_id=@res_item_id_ecl_id,
    org_id=@res_item_id_org_id,
    org_id_class_name=@res_item_id_org_id_class,
    org_id_ecl_id=@res_item_id_org_id_ecl_id )/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Resource_item.name	'/IGNORE'	—
Resource_item.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_realization(res_item_id='PRUS-RI-001-001', res_item_id_class='Resource_item_identification_code', res_item_id_ecl_id='urn:plcs:rdl:std', res_item_id_org_id='Parts R Us Ltd', res_item_id_org_id_class='Organization_name', res_item_id_org_id_ecl_id='urn:plcs:rdl:std', res_item_items='#1')/

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

Figure 3 — Entities and templates used by representing_resource_item_realization template

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


#1 = RESOURCE_ITEM('/IGNORE','/IGNORE',(#25));
#3 = IDENTIFICATION_ASSIGNMENT('PRUS-RI-001-001','/IGNORE',$,(#1));
#5 = CLASSIFICATION_ASSIGNMENT(#7,(#3),'/IGNORE');
#7 = EXTERNAL_CLASS('/NULL','Resource_item_identification_code','/IGNORE',#8);
#8 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std',$);
#10 = ORGANIZATION('/IGNORE','/IGNORE');
#12 = IDENTIFICATION_ASSIGNMENT('Parts R Us Ltd','/IGNORE','/IGNORE',(#10));
#14 = CLASSIFICATION_ASSIGNMENT(#16,(#12),'/IGNORE');
#16 = EXTERNAL_CLASS('/NULL','Organization_name','/IGNORE',#8);
#18 = ORGANIZATION_OR_PERSON_IN_ORGANIZATION_ASSIGNMENT(#10,'/IGNORE',(#3));
#20 = CLASSIFICATION_ASSIGNMENT(#22,(#18),'/IGNORE');
#22 = EXTERNAL_CLASS('/NULL','Owner_of','/IGNORE',#8);
#25 = PART('/IGNORE','/IGNORE','/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:

Figure 4 — Instantiation of representing_resource_item_realization template

Characterizations

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