Template:— representing_value_range (rep_range) |
Date: 2009/04/23 13:25:36 Revision: 1.27
|
This section specifies the template representing_value_range.
NOTE
An explanation of a template and the associated instantiation path is
provided in the
Template overview
section.
This template describes how to represent a property value range (with units) for any property.
EXAMPLE
The weight of an item may range in weight from 5.05 down to 4.95 kilgrames.
The range (in terms of upper and lower values) of a property value defined in specific units (e.g. time, length
etc..) that may be associated with an item.
NOTE
The specification and definition of the property and the item to which it is associated, are outside the scope
of this template. This template, however, defines the representation andvalues (range of) that may be associated with such
a property.
The EXPRESS-G diagram in
Figure
1
shows the templates and EXPRESS entities that are required
to represent the template
"representing_value_range".
The text highlighted in blue shows the template parameters.
Figure 1 — An EXPRESS-G representation of the Information model for representing_value_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 representing_value_range template, related to a resource property
The following input parameters are defined for this template:
The upper limit value of the property.
The datatype must also be indicated in this parameter, e.g.
"ANY_NUMBER_VALUE(5)".
The lower limit value of the property.
The datatype must also be indicated in this parameter, e.g.
"ANY_NUMBER_VALUE(5)".
The class name of the unit in which the value is expressed.
The following classes and their sub-classes can be used:
The identifier of the
External_class_library
storing the definition of the class referenced by the parameter @unit.
si_unit (Default=false,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 (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".
The following classes and their sub-classes can be used:
The identifier of the
External_class_library
storing the definition of the class referenced by the parameter @context.
The following reference parameters are defined for this template:
%^target = $representing_value_range.representation%
%^target = $representing_value_range.num_rep_cntxt%
%^target = $representing_value_range.lower_item%
%^target = $representing_value_range.upper_item%
The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique numerical representation context
There will be one numerical context for the representation of a value.
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_range and assign -- Property_value_representation to it
^representation.items ->
Value_range-- Set the Value_range attribute name to be ignored Value_range.name = '/IGNORE'
-- Instantiate template representing_numerical_item -- for upper limit /
representing_numerical_item(
value= @upper_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_range.upper_limit to it %^upper_item = $representing_numerical_item.item%
Value_range.upper_limit ->
^upper_item
-- Instantiate template representing_numerical_item -- for lower limit /
representing_numerical_item(
value= @lower_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_range.lower_limit to it %^lower_item = $representing_numerical_item.item%
Value_range.lower_limit ->
^lower_item
The following entities are instantiated with attributes as specified:
The instance diagram in Figure
3
shows an example of the EXPRESS entities and templates that are instantiated by the template:
/representing_value_range(upper_limit='ANY_NUMBER_VALUE(5.05)', lower_limit='ANY_NUMBER_VALUE(4.95)', unit='kilogram', unit_ecl_id='urn:plcs:rdl:std', si_unit='.T.', context='Representation_context', context_ecl_id='urn:plcs:rdl:std')/
(an illustration of the consolidated representing_value_range template is shown in
Figure
4 below.)
Figure 3 — Entities instantiated by representing_value_range 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_range(upper_limit='ANY_NUMBER_VALUE(5.05)', lower_limit='ANY_NUMBER_VALUE(4.95)', unit='kilogram', unit_ecl_id='urn:plcs:rdl:std', si_unit='.T.', context='Representation_context', context_ecl_id='urn:plcs:rdl:std')/
Figure 4 — Instantiation of representing_value_range template
The following section details how the
representing_value_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 EXPRESS-G diagram in Figure
5
shows the possible characterizations of the template
"representing_value_range".
Figure 5 — Characterizations for representing_value_range template
The following characterizations may apply:
Characterization Assigning time (and Dates)
NOTE this characterization is optional.
Characterization Assigning organization or person
NOTE this characterization is optional.