representing_text

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

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

The following input parameters are defined for this template:

The following reference parameters are defined for this template:

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Unique Representation_context

Each instance of the entity (Representation_context) within the data set shall be uniquely identified by a combination of the following parameters on this template (representing_text_property) namely: context, context_ecl_id.
The instance is referenced by the following template parameter: representation_context.

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

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

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

-- Instantiate Representation_context and assign
-- Representation at it
%^representation_context = Representation_context%
^representation.context_of_items -> ^representation_context

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

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

-- Instantiate String_representation_item and assign
-- Representation to it
^representation.items -> String_representation_item

-- Set the String_representation_item attribute name to be ignored
String_representation_item.name = '/IGNORE'

-- Set the String_representation_item attribute string_value to the
-- value of the input parameter value
String_representation_item.string_value -> @value

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Representation.id	'/IGNORE'	—
Representation.name	'/IGNORE'	—
Representation.description	'/IGNORE'	—
Representation_context.id	'/IGNORE'	—
Representation_context.kind	'/IGNORE'	—
String_representation_item.name	'/IGNORE'	Representation_item.name

The following section details how the representing_text_property 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 dates and time

NOTE this characterization is optional.

Dates and time can be associated with the assignment of property value representation by using the template assigning_time.

Figure 6 — Characterization by date and time of representing_text_property template

A creation date is commonly assigned to the template representing_text_property.

The date (and time) 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. The date assignment is classified as: "Date actual creation" (urn:plcs:rdl:std:Date actual creation) to indicate that it is the date when the property value representation was actually created. The assignment of time is illustrated in Figure 5 and instantiated by Figure 6.

Other dates and times may be assigned instead.

Characterization Assigning organization

NOTE this characterization is optional.

An Organization can be associated with the property value representation by using the template assigning_organization. Similarly a Person_in_organization be associated through the template assigning_person_in_organization

Figure 7 — Characterization by organization of representing_text_property template

A common role in which an organization (or person) 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 assigned to Property_value_representation. A creating person (in an organization) is represented by using the template assigning_person_in_organization assigned to Property_value_representation.

The assignment of the organization or person (Organization_or_person_in_organization_assignment) is classified as: "Creator of" (urn:plcs:rdl:std:Creator of) to indicate that this organization or person created the property value representation. The assignment of an organization as being the creator of the representation is illustrated in Figure 5. The instantiation of the assignment of a person in an organization is illustrated in Figure 7.

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