Template:— representing_required_resource (rep_req_res)
Context:— NDLO

Date: 2007/09/28 12:44:03
Revision: 1.2

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

This section specifies the template representing_required_resource.

NOTE The template has been defined in the context of NDLO. Refer to the business context for details 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 which type of resource including the further specification of the resource_item which is required to perform for example an activity or task etc.

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

...

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

Input parameters

The following input parameters are defined for this template:

value (Type= 'SELECT (measure_value)' )

The value of the property.

unit_type (Type= 'ENTITY (

Error ER1: The entity SUBTYPE OF(unit) does not exist
SUBTYPE OF(unit))'

Error EXP-1: The EXPRESS entity SUBTYPE OF(unit)
does not exist in data/schemas/ap239_arm_lf.xml.
)

The value of the parameter is an entity name consisting of one of the subtypes of unit.

si_unit (Type='BOOLEAN')

Value should be set to true if the unit is a SI base unit defined by ISO, i.e. kilogram (kg) for Mass, second (s) for Time, metre (m) for Displacement, ampere (A) for Electrical current, kelvin (K) for Temperature, mole (mol) for Amount of substance, and candela (cd) for Luminous intensity. If this is not the case it should be set to false.
Note that the representation of true and false depends on exchange format. In Part 11 (a STEP file) true is represented by the string ".T.", and false by ".F.", while in Part 28 (XML) they are represented by text strings "true" and "false".

unit_code (Type='STRING')

The class name of the code of the unit. The code can be metre, hours, count.

unit_code_type (Type='CLASS')

The type of class name of the unit in which the value is expressed, defined in external reference data.

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

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

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

The identifier of the External_class_library storing the definition of the class referenced by the parameter @unit_code_type.

unit_name (Type='STRING')

The class name of the description related to the unit_code.

unit_descr (Type='CLASS')

The class name providing a description of the identification, defined in external reference data.

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

classifications: [Unit_description]

Error RDL1: The class Unit_description does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml

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

The identifier of the External_class_library storing the definition of the class referenced by the parameter @unit_descr.

res_asg_class_name (Type='CLASS')

The class name of the unit in which the value is expressed, defined in external reference data.

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

classifications: [Task_resource]

Error RDL1: The class Task_resource does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml

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

The identifier of the External_class_library storing the definition of the class referenced by the parameter @res_asg_class_name.

item_1 (Type= 'SELECT (required_resource_item)' )

The instances to which the resource_item defined applies.

res_items (Type= 'SELECT (resource_item_select)' )

The instances to which the resource_item defined applies.

Reference parameters

The following reference parameters are defined for this template:

req_res_res_itm(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 = $representing_required_resource.req_res_res_itm%

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 = $representing_required_resource.req_res_asg%

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

res_itm(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_required_resource.res_itm%

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 Templates Help/Information section.

Resource_item

-- Mark the file entity as
-- referable when this template is used
%^res_itm = Resource_item%
^res_itm.name = '/IGNORE'
^res_itm.description = '/IGNORE'
^res_itm.resource_items -> @res_items
Required_resource_by_resource_item

-- Mark the file entity as
-- referable when this template is used
%^req_res_res_itm = Required_resource_by_resource_item%
^req_res_res_itm.name = '/IGNORE'
^req_res_res_itm.description = '/IGNORE'
^req_res_res_itm.resource_item -> ^res_itm

-- defining a value of measure
/representing_value_with_unit_explicit(
    value=@value,
    unit_type=@unit_type,
    si_unit=@si_unit,
    unit_code=@unit_code,
    unit_code_type=@unit_code_type,
    unit_code_type_ecl_id=@unit_code_type_ecl_id,
    unit_name=@unit_name,
    unit_descr=@unit_descr,
    unit_descr_ecl_id=@unit_descr_ecl_id )/
%^req_res_asg = Required_resource_assignment%
^req_res_asg.assigned_resource -> ^req_res_res_itm
^req_res_asg.item_1 -> @item_1

-- provide the type of the resource assignment by classifying assignment
/assigning_reference_data(
    items=^req_res_asg,
    class_name=@res_asg_class_name,
    ecl_id=@res_asg_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'	—
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:

/representing_required_resource(value='', unit_type='', si_unit='', unit_code='', unit_code_type='', unit_code_type_ecl_id='', unit_name='', unit_descr='', unit_descr_ecl_id='', res_asg_class_name='', res_asg_ecl_id='')/

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

Figure 3 — Entities instantiated by representing_required_resource 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:

Figure 4 — Instantiation of representing_required_resource template

Characterizations

The following section details how the representing_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 classifications

NOTE this characterization is optional.

Several entities may be classified to provide further semantics to the data.

The type of resource can be further defined by using the template assigning_reference_data to assign a class to an Resource_item.

The reason or role for the assignment of a person to an approval is represented by using the template assigning_reference_data to assign a class to Required_resource_by_resource_item. Possible classification values could be [Support_organization_for_task]
Error RDL1: The class Support_organization_for_task does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
, [Document_for_task]
Error RDL1: The class Document_for_task does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
, etc.