Template:— activity_resource_usage_cost (act_res_us_ct)
Context:— UK_Defence

Date: 2009/04/17 10:08:03
Revision: 1.3

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

This section specifies the template activity_resource_usage_cost.

NOTE The template has been defined in the context of UK_Defence. 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 activity resource usage cost for a specified resource type used in an activity. It relates the quantified resource used to the actual cost of the resource.

Business perspective

The activity resource usage cost business object is used by those UK_Defence Data Exchange Specifications that require information related to the activity resource usage cost for a specified resource type used in an activity.

Business object definition

Figure 1 — Graphical Representation for Business Object Activity Resource Usage Cost

Activity Resource Usage Cost:

The definition of an Activity Resource Usage Cost object is: Data about information related to the operation of the activity resource usage cost for a specified resource type used in an activity. It relates the quantified resource used to the actual cost of the resource.

Attribute name	Attribute description	Attribute type	Optionality
Description	This is a textual description of the activity resource usage cost.	Intrinsic	Optional
ID	This is the identifier for the activity resource usage cost.	Identifier	Mandatory
Related resource feedback	This is a reference to the related Activity resource feedback.	Relationship to Activity Resource Feedback	Mandatory
Related usage cost	This is a reference to the related usage cost of the activity resource.	Relationship to Resource Usage Cost	Mandatory

Table 1 — Activity Resource Usage Cost attribute details

Model diagrams

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

Figure 2 — An EXPRESS-G representation of the Information model for activity_resource_usage_cost

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure 3 below.

Figure 3 — The graphical representation of the activity_resource_usage_cost template

Input parameters

The following input parameters are defined for this template:

description (Type='STRING', Optional)

This is a textual description of the activity resource usage cost.

ID (Type='STRING')

This is the identifier for the activity resource usage cost.

source_organization (Type='STRING')

The organization that created the identifier. Additionally a Person or Information System could be defined when either of these are the source; see Identifier template.

related_resource_feedback (Type= 'ENTITY (Activity_actual)' )

This is a reference to the related Activity resource feedback..

related_usage_cost (Type= 'ENTITY (Activity_property)' )

This is a reference to the related usage cost of the activity resource.

Reference parameters

The following reference parameters are defined for this template:

act_res_us_ct(Type='ENTITY (Applied_activity_assignment)')

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

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

%^target = $activity_resource_usage_cost.act_res_us_ct%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Activity_resource_usage_cost'

Each instance of the entity (Applied_activity_assignment) within the data set shall be uniquely identified by the following parameters on this template (activity_resource_usage_cost) namely: ID.
The instance is referenced by the following template parameter: act_res_us_ct.

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.

-- assigning_activity
/assigning_activity(
    role_class_name='Activity_resource_usage_cost',
    role_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_activity=@related_resource_feedback,
    items=@related_usage_cost)/
%^act_res_us_ct = $assigning_activity.appl_act%

-- ID (mandatory)
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type='Activity_resource_usage_cost_identifier',
    items=^act_res_us_ct)/

-- [optional description]
/assigning_descriptor(
    descr=@description,
    class_name='Description',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^act_res_us_ct)/

Instance diagrams

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

/activity_resource_usage_cost(description='This is a description of ARUC123', ID='ARUC123', source_organization='UK_Defence', related_resource_feedback='@178', related_usage_cost='@293')/

(an illustration of the consolidated activity_resource_usage_cost template is shown in Figure 5 below.)

Figure 4 — Entities instantiated by activity_resource_usage_cost template

The instance diagram in Figure 5 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:

/activity_resource_usage_cost(description='This is a description of ARUC123', ID='ARUC123', source_organization='UK_Defence', related_resource_feedback='@178', related_usage_cost='@293')/

Figure 5 — Instantiation of activity_resource_usage_cost template

Characterizations

No common characterizations of the template activity_resource_usage_cost have been identified. However, the ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.