Template:— assigning_realized_resource (asg_rlzd_res) Date: 2008/03/04 18:02:17
Revision: 1.7
CoverContentsDescriptionModel diags.Input params.Ref. params.Instantiation pathInstance diags.CharacterizationsIssues

This section specifies the template assigning_realized_resource.

NOTE  An explanation of a template and the associated instantiation path is provided in the Template overview section.

Description

This template describes how to assign a Resource_as_realized_resource_item, which is used to represent tokens of resources that are actually used or consumed.

NOTE    This template should only be used when assigning a Resource_as_realized_resource_item.

Model diagrams
The EXPRESS-G diagram in Figure 1 shows the templates and EXPRESS entities that are required to represent the template "assigning_realized_resource". The text highlighted in blue shows the template parameters.
Grey areas and templates with dashed lines are not included in the template, but may be used to further characterize the template.


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

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

Figure 2 —  The graphical representation of the assigning_realized_resource template

Input parameters
The following input parameters are defined for this template:
item (Type= 'SELECT (resource_as_realized_item)' )
The item using or consuming the Resource_as_realized.
resource_item (Type= 'ENTITY (Resource_item)' )
The Resource_item representing item(s) that occur as the realized resource.
role_class_name (Default=Resource_as_realized_employed_by,Type='CLASS')
The name of the class being used to classify the role of the Resource_as_realized_assignment.
The following classes and their sub-classes can be used:
classifications: "Resource_as_realized_consumed_by" (urn:plcs:rdl:std:Resource_as_realized_consumed_by), "Resource_as_realized_employed_by" (urn:plcs:rdl:std:Resource_as_realized_employed_by)
role_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The RDL where the role of the Resource_as_realized_assignment is defined.
Reference parameters
The following reference parameters are defined for this template:
res_as_rlzd_asg(Type='ENTITY (Resource_as_realized_assignment)')
Allow the Resource_as_realized_assignment entity instantiated in this path to be referenced when this template is used.
Note: The Resource_as_realized_assignment entity can be referenced in a template path by:
%^target = $assigning_realized_resource.res_as_rlzd_asg%
where target is the parameter to which the Resource_as_realized_assignment is bound.
The Resource_as_realized_assignment acts as a reference to the Resource_as_realized and may be further characterized by the optional templates.
res_as_rlzd(Type='ENTITY (Resource_as_realized_resource_item)')
Allow the Resource_as_realized_resource_item entity instantiated in this path to be referenced when this template is used.
Note: The Resource_as_realized_resource_item entity can be referenced in a template path by:
%^target = $assigning_realized_resource.res_as_rlzd%
where target is the parameter to which the Resource_as_realized_resource_item is bound.
The Resource_as_realized_resource_item represents the referenced resource and may be further characterized by the optional templates.
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.
-- Creating resource as realized
Resource_as_realized_resource_item
%^res_as_rlzd = Resource_as_realized_resource_item%
^res_as_rlzd.name = '/IGNORE'
^res_as_rlzd.description = '/IGNORE'
^res_as_rlzd.resource_item -> @resource_item

-- Creating resource assignment
Resource_as_realized_assignment
%^res_as_rlzd_asg = Resource_as_realized_assignment%
^res_as_rlzd_asg.item -> @item
^res_as_rlzd_asg.assigned_resource -> ^res_as_rlzd

-- Calling assigning reference data template
/assigning_reference_data(
    class_name= @role_class_name,
    ecl_id= @role_ecl_id,
    items= ^res_as_rlzd_asg)/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Resource_as_realized_resource_item.name '/IGNORE' Resource_as_realized.name
Resource_as_realized_resource_item.description '/IGNORE' Resource_as_realized.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_realized_resource(item='#1', resource_item='#7', role_class_name='Resource_as_realized_employed_by', role_ecl_id='urn:plcs:rdl:std')/
(an illustration of the consolidated assigning_realized_resource template is shown in Figure 4 below.)


Figure 3 —  Entities instantiated by assigning_realized_resource template

Figure 3 —  Entities instantiated by assigning_realized_resource template

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

          #1 = ACTIVITY_ACTUAL('/IGNORE','/IGNORE','/IGNORE',$);
          #2 = RESOURCE_AS_REALIZED_RESOURCE_ITEM('/IGNORE','/IGNORE',#5,#7);
          #3 = RESOURCE_AS_REALIZED_ASSIGNMENT(#2,#1);
          #4 = PART('/IGNORE','/IGNORE','/IGNORE');
          #7 = RESOURCE_ITEM('/IGNORE','/IGNORE',(#4));
          #9 = IDENTIFICATION_ASSIGNMENT('ABC123','/IGNORE','/IGNORE',(#7));
          #11 = CLASSIFICATION_ASSIGNMENT(#12,(#9),'/IGNORE');
          #12 = EXTERNAL_CLASS('/NULL','Resource_item_identification_code','/IGNORE',#13);
          #13 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std','/IGNORE');
          #16 = ORGANIZATION('/IGNORE','/IGNORE');
          #18 = IDENTIFICATION_ASSIGNMENT('ACME Inc','/IGNORE','/IGNORE',(#16));
          #20 = CLASSIFICATION_ASSIGNMENT(#21,(#18),'/IGNORE');
          #21 = EXTERNAL_CLASS('/NULL','Organization_name','/IGNORE',#13);
          #23 = ORGANIZATION($,$);
          #24 = ORGANIZATION_OR_PERSON_IN_ORGANIZATION_ASSIGNMENT(#23,'/IGNORE',(#9));
          #26 = CLASSIFICATION_ASSIGNMENT(#27,(#24),'/IGNORE');
          #27 = EXTERNAL_CLASS('/NULL','Owner_of','/IGNORE',#13);
          #30 = CLASSIFICATION_ASSIGNMENT(#31,(#3),'/IGNORE');
          #31 = EXTERNAL_CLASS('/NULL','Resource_as_realized_employed_by','/IGNORE',#32);
          #32 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std','/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:
/assigning_realized_resource(item='#1', resource_item='#7', role_class_name='Resource_as_realized_employed_by', role_ecl_id='urn:plcs:rdl:std')/

NOTE    Input parameter resource_item = '#7' refers to an entity instantiated within the template representing_resource_item_realization.



Figure 4 —  Instantiation of assigning_realized_resource template

Figure 4 —  Instantiation of assigning_realized_resource template

Characterizations
The following section details how the assigning_realized_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 EXPRESS-G diagram in Figure 5 shows the possible characterizations of the template "assigning_realized_resource".


Figure 5 —  Characterizations of assigning_realized_resource

Figure 5 —  Characterizations of assigning_realized_resource

The following characterizations may apply:
Characterization Assigning property

NOTE   this characterization is optional.

The assignment of properties (assigning_resource_property) to the Resource_as_realized can be used to represent properties. For example, the quantity of the resource consumed.

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

Characterization Assigning approval

NOTE   this characterization is optional.

The Approval of using or consuming a Resource_as_realized.

NOTE    The assignment of Approval is described in the capability C019: assigning_approvals (NB Capabilities are not documented in this release of the PLCS standard) .

Characterization Assigning time

NOTE   this characterization is optional.

The assigned Date_time state the actual ('Date_actual'), planned ('Date_planned'), or predicted ('Date_predicted') date and time when the referenced Resource_as_realized was, is planned, or is predicted to be used or consumed. Naturally, the type of assigned Date_time is constrained by the resource_as_realized_item referencing the Resource_as_realized, e.g. if an Activity_actual is referencing a Resource_as_realized the assigned Date_time should be of type 'Date_actual' and not 'Date_planned' or 'Date_predicted'.

NOTE    The assignment of Date_time is described in the capability C036: assigning_date_time (NB Capabilities are not documented in this release of the PLCS standard) .

Characterization Assigning organization

NOTE   this characterization is optional.

An Organization that is related to a Resource_as_realized_assignment or a Resource_as_realized, e.g. as a contractor or operator of the resource..

NOTE    The assignment of Organization is described in the capability C094: assigning_organization (NB Capabilities are not documented in this release of the PLCS standard) .

Characterization Assigning person in organization

NOTE   this characterization is optional.

A Person_in_organization that is related to a Resource_as_realized_assignment or a Resource_as_realized, e.g. as an operator of the resource.

NOTE    The assignment of Person_in_organization is described in the capability C016: representing_person_organization (NB Capabilities are not documented in this release of the PLCS standard) .

Characterization Assigning reference data

NOTE   this characterization is optional.

Reference data defining the type of Resource_as_realized_resource_item, e.g. a human, material or financial resource.

NOTE    The assignment of External_class is described in the capability C010: assigning_reference_data (NB Capabilities are not documented in this release of the PLCS standard) .

Characterization Assigning document

NOTE   this characterization is optional.

Documentation of the Resource_as_realized.

NOTE    The assignment of Document, Document_version or Document_definition is described in the capability C005: representing_documents (NB Capabilities are not documented in this release of the PLCS standard) .

© OASIS 2008 — All rights reserved