Template:— referencing_resource_as_realized (ref_res_as_rlzd)
Capability:representing_resource_as_realized
[warning:]The use of this template is deprecated. (2007-10-19)
Date: 2008/01/14 08:43:55
Revision: 1.11

[warning:]Error T1: There is no template_proxy in the capability representing_resource_as_realized for the template referencing_resource_as_realized
Deprecation: Template referencing_resource_as_realized

The use of template,referencing_resource_as_realized, has been deprecated since 2007-10-19.

Use assigning_realized_resource instead.

This section specifies the template referencing_resource_as_realized.

NOTE  The template has been defined in the context of the capability representing_resource_as_realized 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 reference a Resource_as_realized_resource_item, which is used to represent tokens of resources that are actually used or consumed or that are intended for use or consumption.

NOTE    This template should only be used when referencing 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 "referencing_resource_as_realized". 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 referencing_resource_as_realized

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

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

Figure 2 —  The graphical representation of the referencing_resource_as_realized template

Input parameters
The following input parameters are defined for this template:
item (Type= 'ENTITY (resource_as_realized_item)'
[warning:]Error EXP-1: The EXPRESS entity resource_as_realized_item
does not exist in data/schemas/ap239_arm_lf.xml.

)
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.
count (Default=1,Type='INTEGER')
The number of resources that was or will be used/consumed.
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 = $referencing_resource_as_realized.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)')
Allow the Resource_as_realized entity instantiated in this path to be referenced when this template is used.
Note: The Resource_as_realized entity can be referenced in a template path by:
%^target = $referencing_resource_as_realized.res_as_rlzd%
where target is the parameter to which the Resource_as_realized is bound.
The Resource_as_realized 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 Templates Help/Information section.
-- Calling representing count template
/representing_count(
    value= @count)/

-- 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.count -> $representing_count.count
^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:
/referencing_resource_as_realized(item='#1', resource_item='#9')/


Figure 3 —  Entities instantiated by referencing_resource_as_realized template

Figure 3 —  Entities instantiated by referencing_resource_as_realized 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',#35,#9); #3 = RESOURCE_AS_REALIZED_ASSIGNMENT(#2,#1); #5 = CLASSIFICATION_ASSIGNMENT(#6,(#3),'/IGNORE'); #6 = EXTERNAL_CLASS('/IGNORE','Resource_as_realized_employed_by','/IGNORE',#7); #7 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std',$); #9 = RESOURCE_ITEM('/IGNORE','/IGNORE',(#33)); #11 = IDENTIFICATION_ASSIGNMENT('Super','/IGNORE',$,(#9)); #13 = CLASSIFICATION_ASSIGNMENT(#14,(#11),'/IGNORE'); #14 = EXTERNAL_CLASS('/IGNORE','Resource_item_identification_code','/IGNORE',#15); #15 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std',$); #17 = ORGANIZATION('/IGNORE','/IGNORE'); #19 = IDENTIFICATION_ASSIGNMENT('ACME Inc','/IGNORE','/IGNORE',(#17)); #21 = CLASSIFICATION_ASSIGNMENT(#22,(#19),'/IGNORE'); #22 = EXTERNAL_CLASS('/IGNORE','Organization_name','/IGNORE',#23); #23 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std',$); #24 = ORGANIZATION_OR_PERSON_IN_ORGANIZATION_ASSIGNMENT(#17,'/IGNORE',(#11)); #26 = CLASSIFICATION_ASSIGNMENT(#27,(#24),'/IGNORE'); #27 = EXTERNAL_CLASS('/IGNORE','Owner_of','/IGNORE',#28); #28 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std',$); #30 = CLASSIFICATION_ASSIGNMENT(#31,(#9),'/IGNORE'); #31 = EXTERNAL_CLASS('/IGNORE','Material_resource_item','/IGNORE',#32); #32 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std',$); #33 = PERSON('Mario','Super',$,$,$); #35 = VALUE_WITH_UNIT(#36,1); #36 = UNIT('/IGNORE','false'); #38 = CLASSIFICATION_ASSIGNMENT(#39,(#36),'/IGNORE'); #39 = EXTERNAL_CLASS('/IGNORE','Count','/IGNORE',#40); #40 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std',$);
Characterizations
The following section details how the referencing_resource_as_realized 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 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.

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.

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.

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.

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.

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.

© OASIS 2010 — All rights reserved