independent_property

Template:— independent_property_text (indpt_prp_txt)
Capability:representing_independent_property

Date: 2009/06/08 08:42:53
Revision: 1.13

Cover Contents Description Model diags.Input params.Ref. params.Instantiation path Instance diags.Characterizations Issues in situ

This section specifies the template independent_property_text.

NOTE The template has been defined in the context of the capability representing_independent_property which provides an overall description of the relevant parts of the ISO 10303-239 information model and a description of related templates.

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 an independent property.

Model diagrams

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

Figure 1 — An EXPRESS-G representation of the Information model for independent_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 the independent_property_text 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 (Independent_property)' )

The property to which the text representation is assigned

Reference parameters

The following reference parameters are defined for this template:

prop_repr(Type='ENTITY (Independent_property_representation)')

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

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

%^target = $independent_property_text.prop_repr%

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

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 = $independent_property_text.representation%

where target is the parameter to which the 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 Independent_property_representation entity
Independent_property_representation

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

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

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

-- Bind the Independent_property_representation.rep to the Representation
-- entity instantiated in the template representing_text_property via its reference parameter
-- ^representation
%^representation = $representing_text_property.representation%
^prop_repr.rep -> ^representation

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

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Independent_property_representation.role	'/IGNORE'	—
Independent_property_representation.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:

/independent_property_text(value='Green', context='Bike Ltd ILS Database', context_ecl_id='urn:plcs:rdl:sample', property='#1')/

(an illustration of the consolidated independent_property_text template is shown in Figure 4 below.)

NOTE The instance #12 shown above is the Independent_property instantiated by the template representing_independent_property

Figure 3 — Entities instantiated by independent_property_text 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:

/independent_property_text(value='Green', context='Bike Ltd ILS Database', context_ecl_id='urn:plcs:rdl:sample', property='#1')/

NOTE The instance #12 shown above is the Independent_property instantiated by the template representing_independent_property

Figure 4 — Instantiation of independent_property_text template

Characterizations

The following section details how the independent_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 Effectivity

NOTE this characterization is optional.

A property value for a defined property might just be effective under specific conditions. Effectivity is represented by assigning an effectivity to the Independent_property_representation using the assigning_effectivity template.

AP239 Issue (GYL-5)

The ISO-10303-239 1st edition does not support the assignment of Effectivity_assignment to an Independent_property_representation.

This has been raised as issue, GYL-5, against ISO 10303-239. The EXPRESS schema has been modified in DEXlib (Long form: dexlib/data/schemas/ap239_arm_lf.exp, short form: dexlib/data/schemas/ap239_arm_sf.exp). These changes will be made to ISO 10303-239 as a Technical Corrigendum at some stage.