Template:— representing_value_limit (rep_limit) Date: 2008/03/07 06:34:59
Revision: 1.24

This section specifies the template representing_value_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 value limit with associated unit for any property.

EXAMPLE    The maximum weight (in kilograms) of an item.

NOTE    The definition of the property itself (e.g. weight) and the item to which it may be assigned, are not in scope of this template. This template provides for the value limit and associated unit for the value.

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


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

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

Figure 2 —   The graphical representation of representing_value_limit template

Input parameters
The following input parameters are defined for this template:
limit (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 the datatype.
qualifier (Default=maximum,Type= 'ENUMERATION (limit_qualifier_list)' )
The qualifier of the limit value, either 'maximum' or 'minimum'.
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 and Part 21 (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".
unit (Type='CLASS')
The class name of the unit in which the value is expressed.
The following classes and their sub-classes can be used:
classifications: "Context_dependent_unit" (urn:plcs:rdl:std:Context_dependent_unit)
unit_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 @unit.
context (Type='CLASS')
The name of the class being used to classify the representation context (Numerical_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.
Reference parameters
The following reference parameters are defined for this template:
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 = $representing_value_limit.representation%
where target is the parameter to which the Property_value_representation is bound.
num_rep_cntxt(Type='ENTITY (Numerical_representation_context)')
Allow the Numerical_representation_context entity instantiated in this path to be referenced when this template is used.
Note: The Numerical_representation_context entity can be referenced in a template path by:
%^target = $representing_value_limit.num_rep_cntxt%
where target is the parameter to which the Numerical_representation_context is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique numerical representation context
Each instance of the entity (Numerical_representation_context) within the data set shall be uniquely identified by a combination of the following parameters on this template (representing_value_limit) namely: context, context_ecl_id.
The instance is referenced by the following template parameter: num_rep_cntxt.
There will be one numerical context for the representation of a value.
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.
-- Instantiate Property_value_representation entity
Property_value_representation

-- Set the Property_value_representation attributes id, name and description to be ignored
Property_value_representation.id = '/IGNORE'
Property_value_representation.name = '/IGNORE'
Property_value_representation.description = '/IGNORE'

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

-- Instantiate Numerical_representation_context and assign
%^num_rep_cntxt = Numerical_representation_context%

-- Set the Numerical_representation_context attributes id and kind to be ignored
Numerical_representation_context.id = '/IGNORE'
Numerical_representation_context.kind = '/IGNORE'

-- Property_value_representation at it
^representation.context_of_items -> ^num_rep_cntxt

-- Assign reference data for kind of Numerical_representation_context
/assigning_reference_data(
    items=^num_rep_cntxt,
    class_name=@context,
    ecl_id=@context_ecl_id)/

-- Instantiate Value_limit and assign
-- Property_value_representation to it
^representation.items -> Value_limit

-- Set the Value_limit attributes
Value_limit.name = '/IGNORE'
Value_limit.limit_qualifier = @qualifier

-- Instantiate template representing_numerical_item
-- for value
/representing_numerical_item(
    value= @limit,
    unit= @unit,
    unit_ecl_id= @unit_ecl_id,
    si_unit= @si_unit)/

-- Bind ref param ^item in just instantiated template
-- representing_numerical_item to ref param ^item in this template,
-- and point attribute Value_with_tolerances.item_value to it
%^item = $representing_numerical_item.item%
Value_limit.limit -> ^item
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Property_value_representation.id '/IGNORE' Representation.id
Property_value_representation.name '/IGNORE' Representation.name
Property_value_representation.description '/IGNORE' Representation.description
Numerical_representation_context.id '/IGNORE' Representation_context.id
Numerical_representation_context.kind '/IGNORE' Representation_context.kind
Value_limit.name '/IGNORE' Representation_item.name
Value_limit.limit_qualifier @qualifier
Instance diagrams
The instance diagram in Figure  3 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/representing_value_limit(limit='any_number_value(5.2)', qualifier='maximum', unit='kilogram', unit_ecl_id='urn:plcs:rdl:std', si_unit='true', context='Calculated_in_design', context_ecl_id='urn:plcs:rdl:std')/
(an illustration of the consolidated representing_value_limit template is shown in Figure 4 below.)


Figure 3 —  Entities instantiated by representing_value_limit template

Figure 3 —  Entities instantiated by representing_value_limit 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:
/representing_value_limit(limit='any_number_value(5.2)', qualifier='maximum', unit='kilogram', unit_ecl_id='urn:plcs:rdl:std', si_unit='true', context='Calculated_in_design', context_ecl_id='urn:plcs:rdl:std')/


Figure 4 —  Instantiation of representing_value_limit template, related to an assigned product property

Figure 4 —  Instantiation of representing_value_limit template, related to an assigned product property

Characterizations
The following section details how the representing_value_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 EXPRESS-G diagram in Figure 5 shows the possible characterizations of the template "representing_value_limit".


Figure 5 —  Characterizations for representing_value_limit template

Figure 5 —  Characterizations for representing_value_limit template

The following characterizations may apply:
Characterization Assigning time

NOTE   this characterization is optional.

Time (and dates) can be associated with the assignment of property value representation as in Figure 5. This is described in C079: representing_properties_numerically (NB Capabilities are not documented in this release of the PLCS standard) , template representing_numeric_property. No additional characterization capability is introduced in this template.

Characterization Assigning organization

NOTE   this characterization is optional.

An Organization (or a Person_in_organization) can be associated with the property value representation as in Figure 5. This is described in C079: representing_properties_numerically (NB Capabilities are not documented in this release of the PLCS standard) , template representing_numeric_property. No additional characterization capability is introduced in this template.

© OASIS 2010 — All rights reserved