Template:— representing_resource_item_group (rep_res_item_grp)
Context:— NDLO |
Date: 2007/09/28 12:44:03
Revision: 1.2
|
This section specifies the template representing_resource_item_group.
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.
This template describes how to represent the relationship between resource_items in order to group it and categorize it as
well as a further explanation why a resource is used (e.g, Stock owner).
The EXPRESS-G diagram in
Figure
1
shows the templates and EXPRESS entities that are required
to represent the template
"representing_resource_item_group".
The text highlighted in blue shows the template parameters.
...
Figure 1 — An EXPRESS-G representation of the Information model for representing_resource_item_group
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_group template
The following input parameters are defined for this template:
The value of the property.
unit_type (Type=
'ENTITY
(
![[warning:]]()
Error ER1: The entity SUBTYPE OF(unit) does not existSUBTYPE OF(unit))'
![[warning:]]()
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.
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".
The class name of the code of the unit. The code can be metre, hours, count.
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:
The identifier of the
External_class_library
storing the definition of the class referenced by the parameter @unit_code_type.
The class name of the description related to the unit_code.
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]![[warning:]](../../../../../../images/dex/warning.gif)
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
The identifier of the
External_class_library
storing the definition of the class referenced by the parameter @unit_descr.
The class name where the reason of the assignment is expressed, defined in external reference data.
The following classes and their sub-classes can be used:
classifications: [Stock_owner]Error RDL1: The class Stock_owner does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
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 @asg_class_name.
The class name where the role of the resource_item is expressed, defined in external reference data.
The following classes and their sub-classes can be used:
classifications: [Local_stock]Error RDL1: The class Local_stock does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml[Central_stock]Error RDL1: The class Central_stock does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
The identifier of the
External_class_library
storing the definition of the class referenced by the parameter @res_itm_class_name.
The class name where the kind of the relationship is expressed, defined in external reference data.
The following classes and their sub-classes can be used:
classifications: [Spare_part_stock_requirement]Error RDL1: The class Spare_part_stock_requirement does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
The identifier of the
External_class_library
storing the definition of the class referenced by the parameter @grp_rel_class_name.
The instances to which the resource_item defined applies.
The instances to which the resource_item defined applies.
The following reference parameters are defined for this template:
%^target = $representing_resource_item_group.res_itm_asg%
%^target = $representing_resource_item_group.res_grp_rel%
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_group.res_itm%
where
target
is the parameter to which the
Resource_item
is bound.
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/
assigning_reference_data(
items=^res_itm,
class_name=@res_itm_class_name,
ecl_id=@res_itm_ecl_id)/
%^res_itm_asg =
Resource_item_assignment%
^res_itm_asg.assigned_resource ->
^res_itm
^res_itm_asg.item ->
@item-- provide the type of the resource assignment by classifying assignment /
assigning_reference_data(
items=^res_itm_asg,
class_name=@asg_class_name,
ecl_id=@asg_ecl_id)/
Resource_group_relationship-- Mark the file entity as -- referable when this template is used %^res_grp_rel =
Resource_group_relationship%
^res_grp_rel.name = '/IGNORE'
^res_grp_rel.description = '/IGNORE'
^res_grp_rel.resource_item ->
^res_itm
-- provide the type of the resource group assignment by classifying assignment /
assigning_reference_data(
items=^res_grp_rel,
class_name=@grp_rel_class_name,
ecl_id=@grp_rel_ecl_id)/
-- 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 )/
The following entities are instantiated with attributes as specified:
The instance diagram in Figure
3
shows an example of the EXPRESS entities and templates that are instantiated by the template:
/representing_resource_item_group(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_resource_item_group template is shown in
Figure
4 below.)
Figure 3 — Entities instantiated by representing_resource_item_group 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_group(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='')/
Figure 4 — Instantiation of representing_resource_item_group template
Characterizations
No common characterizations of the template
representing_resource_item_group
have been identified. However, the ISO 10303-239 EXPRESS model
may enable other assignments to the entities instantiated by the template.
