Template:— resource_usage_cost (res_us_ct)
Context:— UK_Defence

Date: 2009/10/29 13:58:38
Revision: 1.4

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 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 cost of using a particular resource between specific dates.

Business perspective

The resource usage cost business object is used by those UK_Defence Data Exchange Specifications that require information related to the cost of using a particular resource between specific dates.

Business object definition

Figure 1 — Graphical Representation for Business Object Resource Usage Cost

Resource Usage Cost:

The definition of a Resource Usage Cost object is: Data about information related to the operation of the cost of using a particular resource between specific dates.

Attribute name	Attribute description	Attribute type	Optionality
Description	This is a description of the resource usage cost.	Intrinsic	Optional
End date	This is the end date of the period for which the usage cost has been defined..	Intrinsic	Mandatory
ID	This is the identifier of the resource usage cost.	Identifier	Mandatory
Related resource	This is the reference to the resource for which the usage cost is defined.	Relationship to Facility, Inventory Item, Person with skill, Person or Organization with Qualification or Utility.	Mandatory
Start date	This is the start date of the period for which the usage cost has been defined..	Intrinsic	Mandatory
Value	This is the usage cost for the related resource for the period defined.	Intrinsic	Mandatory

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

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

Input parameters

The following input parameters are defined for this template:

description (Type='STRING', Optional)

This is a description of the resource usage cost.

end_date_year (Type= 'TYPE (year_number)' )

The year component of the end date and time of the period for which the usage cost has been defined.

end_date_month (Type= 'TYPE (month_in_year_number)' )

The month component of the end date and time of the period for which the usage cost has been defined.

end_date_day (Type= 'TYPE (day_in_month_number)' )

The day component of the end date and time of the period for which the usage cost has been defined.

end_date_hour (Type= 'TYPE (hour_in_day)' )

The hour component of the end date and time of the period for which the usage cost has been defined.

end_date_minute (Type= 'TYPE (minute_in_hour)' , Optional)

The minute component of the end date and time of the period for which the usage cost has been defined. This parameter is optional. If not given, it will remain unset.

end_date_second (Type= 'TYPE (second_in_minute)' , Optional)

The second component of the end date and time of the period for which the usage cost has been defined. This parameter is optional. If not given, it will remain unset.

ID (Type='STRING')

This is the identifier of the 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 (Type= 'SELECT (characterized_resource_select)' )

This is the reference to the resource for which the usage cost is defined.

start_date_year (Type= 'TYPE (year_number)' )

The year component of the start date and time of the period for which the usage cost has been defined.

start_date_month (Type= 'TYPE (month_in_year_number)' )

The month component of the start date and time of the period for which the usage cost has been defined.

start_date_day (Type= 'TYPE (day_in_month_number)' )

The day component of the start date and time of the period for which the usage cost has been defined.

start_date_hour (Type= 'TYPE (hour_in_day)' )

The hour component of the start date and time of the period for which the usage cost has been defined.

start_date_minute (Type= 'TYPE (minute_in_hour)' , Optional)

The minute component of the start date and time of the period for which the usage cost has been defined. This parameter is optional. If not given, it will remain unset.

start_date_second (Type= 'TYPE (second_in_minute)' , Optional)

The second component of the start date and time of the period for which the usage cost has been defined. This parameter is optional. If not given, it will remain unset.

value (Type= 'TYPE (any_number_value)' )

The value of the measure for the usage cost for the related resource for the period defined.

unit (Type='CLASS')

The class name corresponding to the unit of measure for the usage cost for the related resource for the period defined..

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

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

Reference parameters

The following reference parameters are defined for this template:

res_cost(Type='ENTITY (Activity_property)')

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

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

%^target = $resource_usage_cost.res_cost%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Resource_Usage_Cost

Each instance of the entity (Activity_property) within the data set shall be uniquely identified by a combination of the following parameters on this template (resource_usage_cost) namely: ID, related_resource.
The instance is referenced by the following template parameter: res_cost.

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_process_property
/assigning_process_property(
    property_class_name='Resource_usage_cost_parameter',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=@related_resource)/
%^res_cost = $assigning_process_property.property%

-- value and unit
/process_property_numeric(
    value=@value,
    unit=@unit,
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:std',
    property=^res_cost)/

-- identifier
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type='Resource_usage_cost_identifier',
    items=^res_cost)/

-- [ optional Description]
/assigning_descriptor(
    descr=@description,
    class_name='Description',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^res_cost)/
/assigning_dated_effectivity(
    start_year=@start_date_year,
    start_month=@start_date_month,
    start_day=@start_date_day,
    start_hour=@start_date_hour,
    start_minute=@start_date_minute,
    start_second=@start_date_second,
    start_sense='exact',
    start_hour_offset=0,
    start_minute_offset=0,
    end_year=@end_date_year,
    end_month=@end_date_month,
    end_day=@end_date_day,
    end_hour=@end_date_hour,
    end_minute=@end_date_minute,
    end_second=@end_date_second,
    end_sense='exact',
    end_hour_offset=0,
    end_minute_offset=0,
    role_class_name='Actual_effectivity',
    role_ecl_id='urn:plcs:rdl:std',
    items=^res_cost)/

Instance diagrams

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

/resource_usage_cost(description='This is the description of RUC123', end_date_year='2009', end_date_month='3', end_date_day='17', end_date_hour='10', end_date_minute='12', end_date_second='54', ID='PUP123', source_organization='UK_Defence', related_resource='@257', start_date_year='2009', start_date_month='3', start_date_day='18', start_date_hour='10', start_date_minute='0', start_date_second='0', value='ANY_NUMBER_VALUE(10)', unit='Man_hour')/

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

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

Figure 5 — Instantiation of resource_usage_cost template

Characterizations

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