Template:— product_property_text (prod_prp_txt) Date: 2009/03/24 12:40:21
Revision: 1.20

This section specifies the template product_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 product 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 "product_property_text". The text highlighted in blue shows the template parameters.


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

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

Figure 2 —   The graphical representation of product_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 product_property_text template used with assigning_product_property template

Figure 3 —   The product_property_text template used with assigning_product_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 (Assigned_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 = $product_property_text.representation%
where target is the parameter to which the Representation is bound.
prop_repr(Type='ENTITY (Property_representation)')
Allow the Property_representation entity instantiated in this path to be referenced when this template is used.
Note: The Property_representation entity can be referenced in a template path by:
%^target = $product_property_text.prop_repr%
where target is the parameter to which the 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 Templates Help/Information section.
-- Instantiate Property_representation entity
Property_representation

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

-- Set the 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_value)
-- to ^representation in this template and assign 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
Property_representation.role '/IGNORE'
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:
/product_property_text(value='Must weigh less than 7.5 kg', context='Text_representation', context_ecl_id='urn:plcs:rdl:sample', property='#2')/
(an illustration of the consolidated product_property_text template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by product_property_text template

Figure 4 —  Entities instantiated by product_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:
/product_property_text(value='Must weigh less than 7.5 kg', context='Text_representation', context_ecl_id='urn:plcs:rdl:sample', property='#2')/


Figure 5 —  Instantiation of product_property_text template

Figure 5 —  Instantiation of product_property_text template

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


Figure 6 —  Characterizations for product_property_text template

Figure 6 —  Characterizations for product_property_text 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 Property_representation (reference parameter ^prop_repr). The Express-G representation is shown in Figure 7. An instantiated example is shown in Figure 4.



Figure 7 —  Characterization by role of product_property_text template

Figure 7 —  Characterization by role of product_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 8 —  Characterization by date of product_property_text template

Figure 8 —  Characterization by date of product_property_text template

A creation date is commonly assigned to the template product_property_text.

The date of creation of the property value representation is represented by using the template assigning_calendar_date to assign a date and time to Representation (reference parameter ^representation in template representing_text_property). The date 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 and times 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 product_property_text template

Figure 9 —  Characterization by organization of product_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 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 9 and Figure 4.

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

© OASIS 2010 — All rights reserved