representing_resource

Template:— representing_resource_item (rep_res_item)

Date: 2009/06/08 10:18:24
Revision: 1.16

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

This section specifies the template representing_resource_item.

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 resource_item and its possible realizations. A resource_item is used as a placeholder for the object that the resource item may refer to. It is expected that each resource_item will be identifiable and be distinguishable from other types of 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". The text highlighted in blue shows the template parameters.

The diagram shows the resource_item being identified.

Figure 1 — An EXPRESS-G representation of the information model for the template 'representing_resource_item'

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

Figure 2 — Graphical representations for the template 'representing_resource_item'

Input parameters

The following input parameters are defined for this template:

res_item_id (Type='STRING')

Identification of the Resource_item

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

The name of the class used to classify the identifier (@res_item_id) and to provide the role or reason for the identification

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 identifier of the Organization that "owns" the identifier.

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

The name of the class being used to classify the identification of the Organization. For example CAGE code.

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)' , Optional)

Item that is 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.res_item%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Resource item

Each instance of the entity (Resource_item) within the data set shall be uniquely identified by a combination of the following parameters on this template (representing_resource_item) namely: res_item_id, res_item_id_class, res_item_id_ecl_id, res_item_id_org_id, res_item_id_org_id_class, res_item_id_org_id_ecl_id.
The instance is referenced by the following template parameter: res_item.

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

-- Mark the Resource_item entity as
-- referable when this template is used by binding it to the reference
-- parameter res_item
%^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(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 template is shown in Figure 4 below.)

Figure 3 — Entities and templates used by the 'representing_resource_item' template

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


DATA;
#1 = PART('/IGNORE','/IGNORE','/IGNORE');
#2 = RESOURCE_ITEM('/IGNORE','/IGNORE',(#1));
#3 = IDENTIFICATION_ASSIGNMENT('PRUS-RI-001-001','/IGNORE',$,(#2));
#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);
ENDSEC;

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 — Invocation of the 'representing_resource_item' template - graphical presentation

Characterizations

The following section details how the representing_resource_item template can be optionally characterized by assigning other constructs to it. These are characterizations commonly applied to the template. The ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.

The following characterizations may apply:

Characterization Assigning classifications