assigning_resource

Template:— assigning_resource_property (asg_res_prp)

Date: 2008/03/06 21:45:39
Revision: 1.19

Cover Contents Description Model diags.Input params.Ref. params.Instantiation path Instance diags.Characterizations Issues

This section specifies the template assigning_resource_property.

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 named property to a Managed_resource, Required_resource, Resource_as_realized, Resource_item, and a Resource_item_relationship, or any of their subtypes. The name of the property is provided by a class in reference data where the property is defined.

The value representation of the property can be either numerical or textual, but is not part of this template. This template must be used with one (or more) of the templates resource_property_text, resource_property_numeric, resource_property_range, resource_property_limit, and resource_property_w_tolerances.

A description of representing and relating multiple representations for a property, for example the values of a property changing over time, is provided in capability C056: representing_evolution_of_property_values (NB Capabilities are not documented in this release of the PLCS standard) .

Model diagrams

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

NOTE In any exchange file, a class name should only be represented by a single instance of External_class.

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

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

Input parameters

The following input parameters are defined for this template:

property_class_name (Type='CLASS')

The class name of the property type corresponding to the property name.

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

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

property_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 @property.

described_element (Type= 'SELECT (characterized_resource_select)' )

The item to which the property is assigned

Reference parameters

The following reference parameters are defined for this template:

property(Type='ENTITY (Resource_property)')

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

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

%^target = $assigning_resource_property.property%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Unique property

There shall be at most one instance of the entity (Resource_property) within the data set uniquely identified by a combination of the following parameters on this template (assigning_resource_property) namely: described_element, property_class_name, property_ecl_id.
The instance is referenced by the following template parameter: property.

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.

-- Instantiate a Resource_property
Resource_property

-- Bind the Assigned_property to the parameter ^property.
-- The parameter is a reference parameter so the Assigned_property
-- entity can be referred to when this template is used.
%^property = Resource_property%

-- Set the Assigned_property attributes name and description to be ignored
Resource_property.name = '/IGNORE'
Resource_property.description = '/IGNORE'

-- Assign reference data for name of property
/assigning_reference_data(
    items=^property,
    class_name=@property_class_name,
    ecl_id=@property_ecl_id)/

-- Assign the property to the
-- to the instances passed into the template through the @described_element
-- input parameter (e.g. an Activity_actual)
Resource_property.described_element -> @described_element

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Resource_property.name	'/IGNORE'	—
Resource_property.description	'/IGNORE'	—

Instance diagrams

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

/assigning_resource_property(property_class_name='Mean_time_to_repair', property_ecl_id='urn:plcs:rdl:sample', described_element='#1')/

(an illustration of the consolidated assigning_resource_property template is shown in Figure 4 below.)

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

/assigning_resource_property(property_class_name='Mean_time_to_repair', property_ecl_id='urn:plcs:rdl:sample', described_element='#1')/

Figure 4 — Instantiation of assigning_resource_property template

Characterizations

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