Capability (C078):— assigning_resource

Capability (C078):— assigning_resource_properties

Date: 2007/06/22 12:22:09
Revision: 1.43

Cover Contents Intro.Overview Info. model Templates Capabilities.Ref. data Issues

Business overview

This section provides a business level overview of this capability.

A property is a qualitative or quantitative characteristic that a product, activity or resource may possess. Any given product, activity or resource may have multiple properties assigned to it.

EXAMPLE The weight and colour of a car are two properties of the car.

There are two primary components to a property, the property itself, which is identified, or named (as described in this capability for resources) and the representation of the value of the property. (see C079: representing_properties_numerically, C084: representing_property_value_ranges, and C080: representing_properties_textually)

EXAMPLE The weight is the name of the property and 2000 Kgs is the value.

The STEP approach to properties is flexible, allowing new properties to be defined "on the fly". This can lead to problems of properties not be understood by receiving partners. Hence, the AP239 approach extends the STEP property model, but requires that all assigned properties must be classified using reference data. (See: C010: assigning_reference_data). This retains the flexibility, but adds the semantic rigour required for unambiguous data exchange.

Resource Properties

A property which has a value (i.e. one that is "represented") must be assigned to something, which in this case is a resource. This is illustrated in Figure 1 below.

EXAMPLE A required viscosity property may be assigned to a required resource representing lubricating oil.

Figure 1 — Resource Property Assignment

NOTE In addition to resources, properties can be assigned to processes, described in C078: assigning_resource_properties, products, described in C076: assigning_product_properties, and documents, described in C087: assigning_document_properties.

Information model overview

This section provides an overview of the information model that supports this capability.

Figure 2 shows all express entities used for resource properties.

Figure 2 — Express-G model for resource properties

Figure 3 shows a simplified view of the entities and templates used for numeric and textual resource properties.

Figure 3 — Simplified model for assigning resource properties

To assign a property to a resource the following entities are required:

Resource_property - This entity is the property itself. The name should be assigned using reference data. An external class should always be assigned to the property to fully define it.
Resource_property_representation - One instance of this entity should be created for each representation of the property.

The value (and unit) of the property is related to the Resource_property_representation through C080: representing_properties_textually, for textual property values; through C079: representing_properties_numerically, for simple numerical values; and through C084: representing_property_value_ranges, for numerical value ranges.

Use of templates

There are many templates that can be used to instantiate all different properties.

assigning_resource_property is always used to assign a property to a resource. It carries the name of the property, through external reference data.
A representation of the property value (the role may be classified by external reference data) is related to the resource property through one of the following templates:
- resource_property_text - for textual properties.
- resource_property_numeric - for simple numerical values.
- resource_property_limit - for a maximum or minimum value.
- resource_property_range - for a range between two numerical values.
- resource_property_w_tolerances - for a value with plus and minus tolerances.
Each of these templates use other templates in their instantiation, such as:
- representing_text_property
- representing_numeric_property, which uses representing_numerical_item.
- representing_value_limit, which uses representing_numerical_item.
- representing_value_range, which uses two instances of representing_numerical_item.
- representing_value_w_tolerances, which uses representing_numerical_item.

Figure 4 shows the principle for how templates are used.

Figure 4 — Templates used for resource properties

A property may have more than one value or representation, which in that case must be differentiated through time stamps (assigning_time) and organization (assigning_organization or assigning_person_in_organization).

There may be several reasons for having multiple values or representations:

A property may be measured at different times, so the property value changes over time.
In this case, the same Assigned_property is used, but it is related to two (or more) different Property_representations (see further C056: representing_evolution_of_property_values).
A property may be set by different organizations independently, because they might have different means of calculating or measuring the value. This is also the case where feedback plays an important role, i.e. where an estimated value is set by the OEM, and an actual value based on experience is set by the user organization(s).
In this case, the same Assigned_property is used, but it is related to two (or more) different Property_representations.
A property may have several representations of a specific value (less common, but possible). One example is a text representation 'high probability' and a numeric property '0.9'; Both of these represents the same property, and they can be considered similar in value, but their context is different.
Another example weight property may be represented as '1 kg' and as '2.2 lbs', i.e. exactly the same weight but using different units.
PLCS discourage the use of property representations in this way, in favour of real-time conversion based on pre-defined logics. In some rare cases business requirements might however force you to do this.
A property value may consist of several values, e.g. a text property with more than one paragraph of text. This is a special case for text properties, and should not be used for numeric properties. The use of multi-string text properties is discouraged in PLCS since it sets high demands on the external reference data used to manage the pieces correctly. Use a descriptor (assigning_descriptor) instead of text properties.

Figure 5 shows how to use the templates for different types of properties.

Figure 5 — Use of templates for the different types of resource properties

Assignment of a Numerical Property with a Unit

Where an Assigned_property is a numerical value which has units, the Property_value_representation is assigned to a Numerical_item_with_unit. see Capability C079: representing_properties_numerically.

The use of external reference data for Units is described in Capability C096: representing_value_with_unit.

Instance Example

The Resource_property instance is assigned to a Resource_item - e.g. Managed_resource, Required_resource_by_specification, etc. The Resource_property is named using external reference data (see C010: assigning_reference_data). The name should describe the nature of the property, preferably also in terms of lifecycle (e.g. "required", "predicted", etc.).

The property is given a value using the STEP representation mechanism - C079: representing_properties_numerically, C084: representing_property_value_ranges, and C080: representing_properties_textually.

Figure 6 — Required Accuracy of Test Equipment

A required resource (a test equipment) is given a property Required_accuracy of 99 percent above, represented as a numerical value.

Characterization of Resource Properties

Role of Representation

Recording the role or definition method of a Resource_property_representation is optional. The role is represented in external reference data, through C010: assigning_reference_data.

Figure 7 — Assigning Role or Definition Method to a Property Representation

Above, the required viscosity property has a representation which is a value with tolerances. The role of the representation is that it is normalized, i.e. measured under certain conditions according to an external standard.

NOTE Other representations may be assigned to the same property, but with different roles, e.g. measured in higher/lower temperatures, or normalized according to a different standard. See section 'Use of templates' above.

Date and Time Assignment

Date and time may be assigned to the Property_value_representation, but not to the Resource_property itself. This is described in Capabilities C079: representing_properties_numerically and C080: representing_properties_textually.

Person and Organization Assignment

An organization or person in an organization may be assigned to the Property_value_representation, but not to the Resource_property itself. This is described in Capabilities C079: representing_properties_numerically and C080: representing_properties_textually.

Capability templates

The following sections define a set of templates for the capability, where a template is a specification of a set of entities that need to be instantiated to represent a given set of information.

Template: assigning_resource_property (Short name: asg_res_prp)

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.

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

Each instance of the entity (Resource_property) within the data set shall be 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.

Template: resource_property_numeric (Short name: res_prp_num)

This section specifies the template resource_property_numeric.

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 a numerical value with unit for a resource property.

EXAMPLE The required viscosity of engine oil.

Model diagrams

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

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

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

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 resource_property_numeric template, being assigned to template assigning_resource_property

Input parameters

The following input parameters are defined for this template:

value (Type= 'TYPE (any_number_value)' )

The value of the property. The datatype is always 'any_number_value' and should not be registered together with the value, i.e. enter the value as a number, without datatype.

unit (Type='CLASS')

The name of the unit in which the value is expressed, referenced by an External_class.

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

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

unit_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the unit name referenced by the parameter @unit.

si_unit (Type='BOOLEAN')

Value should be set to true if the unit is a SI base unit defined by ISO, i.e. kilogram (kg) for Mass, second (s) for Time, metre (m) for Displacement, ampere (A) for Electrical current, kelvin (K) for Temperature, mole (mol) for Amount of substance, and candela (cd) for Luminous intensity. If this is not the case it should be set to false.
Note that the representation of true and false depends on exchange format. In Part 11 (a STEP file) true is represented by the string ".T.", and false by ".F.", while in Part 28 (XML) they are represented by text strings "true" and "false".

context (Default=Numerical_representation_context,Type='CLASS')

The name of the class being used to classify the Representation_context of the property.

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

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

context_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 @context.

property (Type= 'ENTITY (Resource_property)' )

The target of the template, i.e. the Resource_property (or template assigning_resource_property) to which the Resource_property_representation is related.

Reference parameters

The following reference parameters are defined for this template:

prop_repr(Type='ENTITY (Resource_property_representation)')

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

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

%^target = $resource_property_numeric.prop_repr%

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

representation(Type='ENTITY (Property_value_representation)')

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

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

%^target = $resource_property_numeric.representation%

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

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 Resource_property_representation entity
Resource_property_representation

-- Bind the Resource_property_representation entity to reference parameter ^prop_repr
%^prop_repr = Resource_property_representation%

-- Set the Resource_property_representation attributes role and description to be ignored
^prop_repr.role = '/IGNORE'
^prop_repr.description = '/IGNORE'

-- Instantiate template representing_numeric_property
/representing_numeric_property(
    value=@value,
    unit=@unit,
    unit_ecl_id=@unit_ecl_id,
    si_unit=@si_unit,
    context=@context,
    context_ecl_id=@context_ecl_id)/

-- Bind the Property_value_representation entity instantiated in the template representing_numeric_property
-- (bound to the reference parameter representation in representing_numeric_property)
-- to ^representation in this template and assign Resource_property_representation.rep to it
%^representation = $representing_numeric_property.representation%
^prop_repr.rep -> ^representation

-- Assign text value to property
^prop_repr.property -> @property

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Resource_property_representation.role	'/IGNORE'	—
Resource_property_representation.description	'/IGNORE'	—

Instance diagrams

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

/resource_property_numeric(value='any_number_value(1.5)', unit='Hour', unit_ecl_id='urn:plcs:rdl:std', si_unit='false', context='Time_context', context_ecl_id='urn:plcs:rdl:sample', property='#2')/

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

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

/resource_property_numeric(value='any_number_value(1.5)', unit='Hour', unit_ecl_id='urn:plcs:rdl:std', si_unit='false', context='Time_context', context_ecl_id='urn:plcs:rdl:sample', property='#2')/

Figure 5 — Instantiation of template

Characterizations

The following section details how the resource_property_numeric 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 6 shows the possible characterizations of the template "resource_property_numeric".

Figure 6 — Characterizations for resource_property_numeric template

The following characterizations may apply:

Characterization Assigning representation role

NOTE this characterization is optional.

A role can be assigned to each representation of a property through external reference data. The role is used to distinguish several representations from each other, such as Textual_estimate, Numeric_estimate, and Numeric_actual.

The role of the property representation is represented by using the template assigning_reference_data to assign a role to Resource_property_representation (reference parameter ^prop_repr). Only one role may be assigned to each representation.

Figure 7 — Characterization by role of resource_property_numeric template

Characterization Assigning date and time

NOTE this characterization is optional.

Dates can be associated with the assignment of property value representation by using the templates assigning_time.

Figure 8 — Characterization by date of resource_property_numeric template

A creation date is commonly assigned to the template resource_property_numeric.

The date of creation of the property value representation is represented by using the template assigning_time to assign a date and time to Property_value_representation (reference parameter ^representation in template representing_numeric_property). The date and time assignment is classified as: "Date actual creation" (urn:plcs:rdl:std:Date actual creation) to indicate that it is the date (and time) when the property value representation was actually created. This is illustrated in Figure 8.

Other dates may be assigned instead.

Characterization Assigning organization or person

NOTE this characterization is optional.

An organization or a person within an organization can be associated with the property value representation by using the templates assigning_organization, or assigning_person_in_organization.

Figure 9 — Characterization by organization of resource_property_numeric template

A common role in which an organization is assigned to a property value representation is as a "Creator of" the representation. The creating organization is represented by using the template assigning_organization or assigning_person_in_organization assigned to Property_value_representation (reference parameter ^representation in template representing_numeric_property). The assignment of the organization (Organization_or_person_in_organization_assignment) is classified as: "Creator of" (urn:plcs:rdl:std:Creator of) to indicate that this organization created the property value representation. This is illustrated in Figure 9.

Other roles of an organization with regard to a property value representation may be assigned instead.

Template: resource_property_text (Short name: res_prp_txt)

This section specifies the template resource_property_text.

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 a text string value for a resource property.

EXAMPLE A quantity property may be represented with a text string; "As required".

Model diagrams

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

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

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

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

Figure 3 — The resource_property_text template used with assigning_resource_property template

Input parameters

The following input parameters are defined for this template:

value (Type='STRING')

The text value of the property.

context (Default=Representation_context,Type='CLASS')

The name of the class being used to classify the Representation_context of the property.

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

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

context_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 @context.

property (Type= 'ENTITY (Resource_property)' )

The property to which the text representation is assigned

Reference parameters

The following reference parameters are defined for this template:

representation(Type='ENTITY (Representation)')

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

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

%^target = $resource_property_text.representation%

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

prop_repr(Type='ENTITY (Resource_property_representation)')

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

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

%^target = $resource_property_text.prop_repr%

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

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 Resource_property_representation entity
Resource_property_representation

-- Bind the Resource_property_representation entity to reference parameter ^prop_repr
%^prop_repr = Resource_property_representation%

-- Set the Resource_property_representation attributes role and description to be ignored
^prop_repr.role = '/IGNORE'
^prop_repr.description = '/IGNORE'

-- Instantiate template representing_text_property
/representing_text_property(
    value=@value,
    context=@context,
    context_ecl_id=@context_ecl_id)/

-- Bind the Representation entity instantiated in the template representing_text_property
-- (bound to the reference parameter representation in representing_text_property)
-- to ^representation in this template and assign Resource_property_representation.rep to it
%^representation = $representing_text_property.representation%
^prop_repr.rep -> ^representation

-- Assign text value to property
^prop_repr.property -> @property

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Resource_property_representation.role	'/IGNORE'	—
Resource_property_representation.description	'/IGNORE'	—

Instance diagrams

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

/resource_property_text(value='As required', context='Text_context', context_ecl_id='urn:plcs:rdl:sample', property='#2')/

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

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

/resource_property_text(value='As required', context='Text_context', context_ecl_id='urn:plcs:rdl:sample', property='#2')/

Figure 5 — Instantiation of resource_property_text template

Characterizations

The following section details how the resource_property_text 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 representation role

NOTE this characterization is optional.

A role can be assigned to each representation of a property through external reference data.

Figure 6 — Characterization by role of resource_property_text template

Characterization Assigning date and time

NOTE this characterization is optional.

Dates can be associated with the assignment of property value representation by using the templates assigning_time.

Figure 7 — Characterization by date of resource_property_text template

A creation date is commonly assigned to the template resource_property_text.

The date of creation of the property value representation is represented by using the template assigning_time to assign a date and time to Property_value_representation (reference parameter ^representation in template representing_text_property). The date and time assignment is classified as: "Date actual creation" (urn:plcs:rdl:std:Date actual creation) to indicate that it is the date (and time) when the property value representation was actually created. This is illustrated in Figure 7.

Other dates may be assigned instead.

Characterization Assigning organization or person

NOTE this characterization is optional.

An Organization or a Person_in_organization can be associated with the property value representation by using the templates assigning_organization, or assigning_person_in_organization.

Figure 8 — Characterization by organization of resource_property_text template

A common role in which an organization is assigned to a property value representation is as a "Creator of" the representation. The creating organization is represented by using the template assigning_organization or assigning_person_in_organization assigned to Property_value_representation (reference parameter ^representation in template representing_text_property). The assignment of the organization (Organization_or_person_in_organization_assignment) is classified as: "Creator of" (urn:plcs:rdl:std:Creator of) to indicate that this organization created the property value representation. This is illustrated in Figure 8.

Other roles of an organization with regard to a property value representation may be assigned instead.

Template: resource_property_limit (Short name: res_prp_limit)

This section specifies the template resource_property_limit.

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 a numerical value with limit for a resource property.

Model diagrams

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

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

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

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 resource_property_limit template, being assigned to template assigning_resource_property

Input parameters

The following input parameters are defined for this template:

limit (Type= 'TYPE (any_number_value)' )

The qualified numerical value representing either the lower limit or the upper limit of the property. The datatype is always 'any_number_value' and should not be registered together with the value, i.e. enter the value as a number, without datatype.

qualifier (Type= 'ENUMERATION (limit_qualifier_list)' )

The limit qualifier of the property. Allowed values are 'maximum' or 'minimum'

unit (Type='CLASS')

The name of the unit in which the value is expressed, referenced by an External_class.

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

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

unit_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the unit name referenced by the parameter @unit.

si_unit (Type='BOOLEAN')

context (Default=Numerical_representation_context,Type='CLASS')

The name of the class being used to classify the Representation_context of the property.

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

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

context_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 @context.

property (Type= 'ENTITY (Resource_property)' )

The target of the template, i.e. the Resource_property (or template assigning_resource_property) to which the Resource_property_representation is related.

Reference parameters

The following reference parameters are defined for this template:

prop_repr(Type='ENTITY (Resource_property_representation)')

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

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

%^target = $resource_property_limit.prop_repr%

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

representation(Type='ENTITY (Property_value_representation)')

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

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

%^target = $resource_property_limit.representation%

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

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 Resource_property_representation entity
Resource_property_representation

-- Bind the Resource_property_representation entity to reference parameter ^prop_repr
%^prop_repr = Resource_property_representation%

-- Set the Resource_property_representation attributes role and description to be ignored
^prop_repr.role = '/IGNORE'
^prop_repr.description = '/IGNORE'

-- Instantiate template representing_value_limit
/representing_value_limit(
    limit=@limit,
    qualifier=@qualifier,
    unit=@unit,
    unit_ecl_id=@unit_ecl_id,
    si_unit=@si_unit,
    context=@context,
    context_ecl_id=@context_ecl_id)/

-- Bind the Property_value_representation entity instantiated in the template representing_value_limit
-- to ^representation in this template and assign Resource_property_representation.rep to it
%^representation = $representing_value_limit.representation%
^prop_repr.rep -> ^representation

-- Assign value with limit to property
^prop_repr.property -> @property

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Resource_property_representation.role	'/IGNORE'	—
Resource_property_representation.description	'/IGNORE'	—

Instance diagrams

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

/resource_property_limit(value='any_number_value(22)', qualifier='MINIMUM', unit='Square_millimetres_per_second', unit_ecl_id='urn:plcs:rdl:sample', si_unit='false', context='Numeric_context', context_ecl_id='urn:plcs:rdl:sample', property='#2')/

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

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

Characterizations

The following section details how the resource_property_limit 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 representation role

NOTE this characterization is optional.

A role or definition method can be associated with the property representation by using the template assigning_reference_data assigned to Resource_property_representation (reference parameter ^prop_repr). Only one role may be assigned to each representation.

Figure 6 — Characterization by role of resource_property_limit template

Characterization Assigning date and time

NOTE this characterization is optional.

Dates can be associated with the assignment of property value representation by using the templates assigning_time.

Figure 7 — Characterization by date of resource_property_limit template

A creation date is commonly assigned to the template resource_property_limit.

The date of creation of the property value representation is represented by using the template assigning_time to assign a date and time to Property_value_representation (reference parameter ^representation in template representing_value_limit). The date and time assignment is classified as: "Date actual creation" (urn:plcs:rdl:std:Date actual creation) to indicate that it is the date (and time) when the property value representation was actually created. This is illustrated in Figure 7.

Other dates may be assigned instead.

Characterization Assigning organization or person

NOTE this characterization is optional.

An Organization or a Person_in_organization can be associated with the property value representation by using the templates assigning_organization, or assigning_person_in_organization.

Figure 8 — Characterization by organization of resource_property_limit template

A common role in which an organization is assigned to a property value representation is as a "Creator of" the representation. The creating organization is represented by using the template assigning_organization or assigning_person_in_organization assigned to Property_value_representation (reference parameter ^representation in template representing_value_limit). The assignment of the organization (Organization_or_person_in_organization_assignment) is classified as: "Creator of" (urn:plcs:rdl:std:Creator of) to indicate that this organization created the property value representation. This is illustrated in Figure 8.

Other roles of an organization with regard to a property value representation may be assigned instead.

Template: resource_property_range (Short name: res_prp_range)

This section specifies the template resource_property_range.

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 a numerical value range for a resource property.

Model diagrams

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

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

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

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 resource_property_range template, being assigned to template assigning_resource_property

Input parameters

The following input parameters are defined for this template:

upper_limit (Type= 'TYPE (any_number_value)' )

The upper limit value of the property. The datatype is always 'any_number_value' and should not be registered together with the value, i.e. enter the value as a number, without datatype.

lower_limit (Type= 'TYPE (any_number_value)' )

The lower limit value of the property. The datatype is always 'any_number_value' and should not be registered together with the value, i.e. enter the value as a number, without datatype.

unit (Type='CLASS')

The name of the unit in which the value is expressed, referenced by an External_class.

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

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

unit_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the unit name referenced by the parameter @unit.

si_unit (Type='BOOLEAN')

context (Default=Numerical_representation_context,Type='CLASS')

The name of the class being used to classify the Representation_context of the property.

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

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

context_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 @context.

property (Type= 'ENTITY (Resource_property)' )

The target of the template, i.e. the Resource_property (or template assigning_resource_property) to which the Resource_property_representation is related.

Reference parameters

The following reference parameters are defined for this template:

prop_repr(Type='ENTITY (Resource_property_representation)')

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

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

%^target = $resource_property_range.prop_repr%

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

representation(Type='ENTITY (Property_value_representation)')

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

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

%^target = $resource_property_range.representation%

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

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 Resource_property_representation entity
Resource_property_representation

-- Bind the Resource_property_representation entity to reference parameter ^prop_repr
%^prop_repr = Resource_property_representation%

-- Set the Property_representation attributes role and description to be ignored
^prop_repr.role = '/IGNORE'
^prop_repr.description = '/IGNORE'

-- Instantiate template representing_value_range
/representing_value_range(
    upper_limit=@upper_limit,
    lower_limit=@lower_limit,
    unit=@unit,
    unit_ecl_id=@unit_ecl_id,
    si_unit=@si_unit,
    context=@context,
    context_ecl_id=@context_ecl_id)/

-- Bind the Property_value_representation entity instantiated in the template representing_value_range
-- to ^representation in this template and assign Resource_property_representation.rep to it
%^representation = $representing_value_range.representation%
^prop_repr.rep -> ^representation

-- Assign value range to property
^prop_repr.property -> @property

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Resource_property_representation.role	'/IGNORE'	—
Resource_property_representation.description	'/IGNORE'	—

Instance diagrams

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

/resource_property_range(upper_limit='ANY_NUMBER_VALUE(680)', lower_limit='ANY_NUMBER_VALUE(220)', unit='Square_millimetres_per_second', unit_ecl_id='urn:plcs:rdl:sample', si_unit='false', context='Numerical_context', context_ecl_id='urn:plcs:rdl:sample', property='#2')/

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

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

Characterizations

The following section details how the resource_property_range 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 representation role

NOTE this characterization is optional.

Figure 6 — Characterization by role of resource_property_range template

Characterization Assigning date and time

NOTE this characterization is optional.

Dates can be associated with the assignment of property value representation by using the templates assigning_time.

Figure 7 — Characterization by date of resource_property_range template

A creation date is commonly assigned to the template resource_property_range.

The date of creation of the property value representation is represented by using the template assigning_time to assign a date and time to Property_value_representation (reference parameter ^representation in template representing_value_range). The date and time assignment is classified as: "Date actual creation" (urn:plcs:rdl:std:Date actual creation) to indicate that it is the date (and time) when the property value representation was actually created. This is illustrated in Figure 7.

Other dates may be assigned instead.

Characterization Assigning organization or person

NOTE this characterization is optional.

An Organization or a Person_in_organization can be associated with the property value representation by using the templates assigning_organization, or assigning_person_in_organization.

Figure 8 — Characterization by organization of resource_property_range template

A common role in which an organization is assigned to a property value representation is as a "Creator of" the representation. The creating organization is represented by using the template assigning_organization or assigning_person_in_organization assigned to Property_value_representation (reference parameter ^representation in template representing_value_range). The assignment of the organization (Organization_or_person_in_organization_assignment) is classified as: "Creator of" (urn:plcs:rdl:std:Creator of) to indicate that this organization created the property value representation. This is illustrated in Figure 8.

Other roles of an organization with regard to a property value representation may be assigned instead.

Template: resource_property_w_tolerances (Short name: res_prp_tol)

This section specifies the template resource_property_w_tolerances.

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 a numerical value with tolerances for a resource property.

Model diagrams

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

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

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

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 resource_property_tolerance template, being assigned to template assigning_resource_property

Input parameters

The following input parameters are defined for this template:

value (Type= 'TYPE (any_number_value)' )

The qualified numerical value representing the value of the property. The datatype is always 'any_number_value' and should not be registered together with the value, i.e. enter the value as a number, without datatype.

upper_limit (Default=0,Type='REAL')

The upper tolerance limit of the property value given as an offset from the base value.

lower_limit (Default=0,Type='REAL')

The lower tolerance limit of the property value given as an offset from the base value. This value should always be negative as upper_limit

unit (Type='CLASS')

The name of the unit in which the value is expressed, referenced by an External_class.

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

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

unit_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the unit name referenced by the parameter @unit.

si_unit (Type='BOOLEAN')

context (Default=Numerical_representation_context,Type='CLASS')

The name of the class being used to classify the Representation_context of the property.

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

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

context_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 @context.

property (Type= 'ENTITY (Resource_property)' )

The target of the template, i.e. the Resource_property (or template assigning_resource_property) to which the Resource_property_representation is related.

Reference parameters

The following reference parameters are defined for this template:

prop_repr(Type='ENTITY (Resource_property_representation)')

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

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

%^target = $resource_property_w_tolerances.prop_repr%

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

representation(Type='ENTITY (Property_value_representation)')

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

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

%^target = $resource_property_w_tolerances.representation%

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

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 Resource_property_representation entity
Resource_property_representation

-- Set the Resource_property_representation attributes role and description to be ignored
Resource_property_representation.role = '/IGNORE'
Resource_property_representation.description = '/IGNORE'

-- Bind the Resource_property_representation entity to reference parameter ^prop_repr
%^prop_repr = Resource_property_representation%

-- Instantiate template representing_value_w_tolerances
/representing_value_w_tolerances(
    value=@value,
    upper_limit=@upper_limit,
    lower_limit=@lower_limit,
    unit=@unit,
    unit_ecl_id=@unit_ecl_id,
    si_unit=@si_unit,
    context=@context,
    context_ecl_id=@context_ecl_id)/

-- Bind the Property_value_representation entity instantiated in the
-- template representing_value_w_tolerances to ^representation in
-- this template and assign Resource_property_representation.rep to it
%^representation = $representing_value_w_tolerances.representation%
Resource_property_representation.rep -> ^representation

-- Assign value with tolerances to property
Resource_property_representation.property -> @property

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Resource_property_representation.role	'/IGNORE'	—
Resource_property_representation.description	'/IGNORE'	—

Instance diagrams

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

/resource_property_tolerance(value='ANY_NUMBER_VALUE(46)', upper_limit='4.6', lower_limit='-4.6', unit='Square_millimetres_per_second', unit_ecl_id='urn:plcs:rdl:sample', si_unit='false', context='Numerical_context', context_ecl_id='urn:plcs:rdl:sample', property='#2')/

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

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

Characterizations

The following section details how the resource_property_w_tolerances 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 representation role

NOTE this characterization is optional.

Figure 6 — Characterization by role of resource_property_w_tolerances template

Characterization Assigning date and time

NOTE this characterization is optional.

Dates can be associated with the assignment of property value representation by using the templates assigning_time.

Figure 7 — Characterization by date of resource_property_w_tolerances template

A creation date is commonly assigned to the template resource_property_w_tolerances.

The date of creation of the property value representation is represented by using the template assigning_time to assign a date and time to Property_value_representation (reference parameter ^representation in template representing_value_w_tolerances). The date and time assignment is classified as: "Date actual creation" (urn:plcs:rdl:std:Date actual creation) to indicate that it is the date (and time) when the property value representation was actually created. This is illustrated in Figure 7.

Other dates may be assigned instead.

Characterization Assigning organization or person

NOTE this characterization is optional.

An Organization or a Person_in_organization can be associated with the property value representation by using the templates assigning_organization, or assigning_person_in_organization.

Figure 8 — Characterization by organization of resource_property_w_tolerances template

A common role in which an organization is assigned to a property value representation is as a "Creator of" the representation. The creating organization is represented by using the template assigning_organization or assigning_person_in_organization assigned to Property_value_representation (reference parameter ^representation in template representing_value_w_tolerances). The assignment of the organization (Organization_or_person_in_organization_assignment) is classified as: "Creator of" (urn:plcs:rdl:std:Creator of) to indicate that this organization created the property value representation. This is illustrated in Figure 8.

Other roles of an organization with regard to a property value representation may be assigned instead.

Related capabilities

This capability "Assigning Properties to Resources" is related to the following capabilities:

Dependent capabilities

This capability "Assigning Properties to Resources" is dependent on the following capabilities:

Model reference data

The following classes of reference data are required for this capability:

[Property]

Error RDL1: The class Property does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
[Qualified_property]

Error RDL1: The class Qualified_property does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
[Quantified_property]

Error RDL1: The class Quantified_property does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml