assigning_condition_text

Template:— assigning_condition_text_based (asg_cond_txt)
Capability:representing_condition

Date: 2008/01/21 20:21:02
Revision: 1.10

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

This section specifies the template assigning_condition_text_based.

NOTE The template has been defined in the context of the capability representing_condition 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 assign a text based condition, i.e assign a non-computable condition without condition parameters. This template enables:

the assignment of a textually described condition to something;
classification of the assignment to define the role of the condition being assigned;
classification of the condition as a text based condition.

Model diagrams

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

Figure 1 — EXPRESS-G representation for the template 'assigning_condition_text_based'

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure 2 below.

Figure 2 — Graphical representations for the template 'assigning_condition'

Input parameters

The following input parameters are defined for this template:

cond_item (Type= 'SELECT (condition_item)' )

The item to which the Condition_assignment is assigned

cond_asg_class (Type='CLASS')

The name of the class used to classify the Condition_assignment and to provide the role or reason for the condition.

The following classes and their sub-classes can be used:

classifications: "Condition_assignment" (urn:plcs:rdl:std:Condition_assignment)

cond_asg_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 @cond_asg_class.

cond_descr (Type='STRING')

Textual description of the condition being applied.

Reference parameters

The following reference parameters are defined for this template:

cond(Type='ENTITY (Condition)')

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

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

%^target = $assigning_condition_text_based.cond%

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

cond_asg(Type='ENTITY (Condition_assignment)')

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

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

%^target = $assigning_condition_text_based.cond_asg%

where target is the parameter to which the Condition_assignment 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.

-- Mark the Condition entity as
-- referable when this template is used by binding it to the reference
-- parameter ^cond
%^cond = Condition%
Condition.name = '/IGNORE'
Condition.description = '/IGNORE'

-- Provide type of condition by the assignment of reference data
/assigning_reference_data(
    items=^cond,
    class_name='Text_based_condition',
    ecl_id='urn:plcs:rdl:std')/

-- Provide the description of the text based condition
/assigning_descriptor(
    is_assigned_to=^cond,
    descr=@cond_descr,
    class_name='Description',
    ecl_id='urn:plcs:rdl:std')/

-- Mark the Condition_assignment entity as
-- referable when this template is used by binding it to the reference
-- parameter cond_asg
%^cond_asg = Condition_assignment%
Condition_assignment.item -> @cond_item
Condition_assignment.assigned_condition -> ^cond

-- Provide the role of the condition by the assignment of reference data
/assigning_reference_data(
    items=^cond_asg,
    class_name=@cond_asg_class,
    ecl_id=@cond_asg_ecl_id)/

The following entities are instantiated with attributes as specified:

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

/assigning_condition(cond_item='#3', cond_asg_class='Trigger', cond_asg_ecl_id='urn:plcs:rdl:sample', cond_descr='The task shall be initiated every 200 flight hours')/

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

The example shows a textual description of a task trigger being associated with a specific type of part.

Figure 3 — Instance diagram instantiated by the template example

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:

/assigning_condition(cond_item='#3', cond_asg_class='Trigger', cond_asg_ecl_id='urn:plcs:rdl:sample', cond_descr='The task shall be initiated every 200 flight hours')/

Figure 4 — Invocation of template - graphical presentation

Characterizations

The following section details how the assigning_condition_text_based 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 description

NOTE this characterization is optional.

A assigning_descriptor may be assigned to either the Condition_assignment or the Condition in order to provide further information.

AP239 Issue (GYL-1)

The ISO-10303-239 1st edition does not support the assignment of a Document to a Condition_assignment.

This has been raised as issue, GYL-1, 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.

Characterization Assigning justification

NOTE this characterization is optional.

A assigning_justification may be assigned to the Condition_assignment in order to provide further information about the justification for the defined condition.

AP239 Issue (GYL-2)

The ISO-10303-239 1st edition does not support the assignment of a Justification to a Condition_assignment.

This has been raised as issue, GYL-2, 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.