assigning_required

Template:— assigning_required_resource (asg_req_res)
Capability:representing_resource

Date: 2010/09/09 11:24:38
Revision: 1.11

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

This section specifies the template assigning_required_resource.

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 the assignment of a required resource.

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

item (Type= 'SELECT (required_resource_item)' )

The item to which the required resource is assigned.

resource_item (Type= 'ENTITY (Resource_item)' )

The resource item that plays the role of a required resource.

class_name (Type='CLASS')

The name of the External_class that determines the role of the required resource given by the input parameter @resource_item.

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

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

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.

Reference parameters

The following reference parameters are defined for this template:

req_res_item(Type='ENTITY (Required_resource_by_resource_item)')

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

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

%^target = $assigning_required_resource.req_res_item%

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

req_res_asg(Type='ENTITY (Required_resource_assignment)')

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

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

%^target = $assigning_required_resource.req_res_asg%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Unique assignment

Each instance of the entity (Required_resource_assignment) within the data set shall be uniquely identified by a combination of the following parameters on this template (assigning_required_resource) namely: item, resource_item, class_name, ecl_id.
The instance is referenced by the following template parameter: req_res_asg.

There should be one assignment between each assigned resource, item and class in a data set.

Unique constraint: Unique required resource

Each instance of the entity (Required_resource_by_resource_item) within the data set shall be uniquely identified by a combination of the following parameters on this template (assigning_required_resource) namely: item, resource_item, class_name, ecl_id.
The instance is referenced by the following template parameter: req_res_item.

There should be one required resource item relationship between each assigned resource, item and class in a data set.

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 Required_resource_by_resource_item entity
Required_resource_by_resource_item

-- Mark the Required_resource_by_resource_item entity as
-- referable when this template is used by binding it to the reference
-- parameter ^req_res_item
%^req_res_item = Required_resource_by_resource_item%

-- Set the Required_resource_by_resource_item attributes name and description to be ignored
-- and the resource_item attribute to the entity given by the @resource_item input parameter
Required_resource_by_resource_item.name = '/IGNORE'
Required_resource_by_resource_item.description = '/IGNORE'
Required_resource_by_resource_item.resource_item -> @resource_item

-- Assign the External_class in the reference data library
-- being used to determine the role of the required resource item
/assigning_reference_data(
    items=^req_res_item,
    class_name=@class_name,
    ecl_id=@ecl_id)/

-- Instantiate the Required_resource_assignment entity
Required_resource_assignment

-- Mark the Required_resource_assignment entity as
-- referable when this template is used by binding it to the reference
-- parameter ^req_res_asg
%^req_res_asg = Required_resource_assignment%

-- Set the Required_resource_assignment attributes item and assigned_resource
Required_resource_assignment.item -> @item
Required_resource_assignment.assigned_resource -> Required_resource

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Required_resource_by_resource_item.name	'/IGNORE'	Required_resource.name
Required_resource_by_resource_item.description	'/IGNORE'	Required_resource.description

Instance diagrams

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

/assigning_required_resource(item='#2', resource_item='#1', class_name='Consumable', ecl_id='urn:plcs:rdl:sample')/

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

Figure 3 — Entities instantiated by assigning_required_resource template

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


          #1 = RESOURCE_ITEM('/IGNORE','/IGNORE',$);
          #2 = TASK_METHOD_VERSION('/IGNORE','/IGNORE','/IGNORE','/IGNORE',$,$);
          #3 = REQUIRED_RESOURCE_BY_RESOURCE_ITEM('/IGNORE','/IGNORE',$,#1);
          #4 = REQUIRED_RESOURCE_ASSIGNMENT(#3,#2);
          #6 = CLASSIFICATION_ASSIGNMENT(#8,(#3),'/IGNORE');
          #8 = EXTERNAL_CLASS('/NULL','Consumable','/IGNORE',#9);
          #9 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:sample',$);

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:

/assigning_required_resource(item='#2', resource_item='#1', class_name='Consumable', ecl_id='urn:plcs:rdl:sample')/

Figure 4 — Instantiation of assigning_required_resource template

Characterizations

The following section details how the assigning_required_resource 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 property

NOTE this characterization is optional.

The assignment of properties (assigning_resource_property) to the Required_resource_by_resource_item can be used e.g. to represent e.g. quantities.

NOTE Depending on the type of property being defined, one of the following templates will be used together with the assigning_resource_property template: