representing_task_element_state

Template:— representing_task_element_state_relationship (rep_task_elem_state_rel)
Capability:representing_task

Date: 2011/05/20 09:00:51
Revision: 1.6

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

This section specifies the template representing_task_element_state_relationship.

NOTE The template has been defined in the context of the capability representing_task 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 relationship between a task element and a defined state.

Model diagrams

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

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

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 representing_task_element_state_relationship template

Input parameters

The following input parameters are defined for this template:

rel_type (Type='CLASS')

The name of the External_class being used to categorize the relationship.

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

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

rel_type_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the External_class referenced by the parameter @rel_type.

task_element (Type= 'ENTITY (Task_element)' )

The Task_element that is related to a state.

state (Type= 'SELECT (state_or_state_definition_select)' )

The State or State_definition that is related to the Task_element entity instance.

Reference parameters

The following reference parameters are defined for this template:

task_elem_state_rel(Type='ENTITY (Task_element_state_relationship)')

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

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

%^target = $representing_task_element_state_relationship.task_elem_state_rel%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Task element state relationship

Each instance of the entity (Task_element_state_relationship) within the data set shall be uniquely identified by a combination of the following parameters on this template (representing_task_element_state_relationship) namely: rel_type, rel_type_ecl_id, task_element, state.
The instance is referenced by the following template parameter: task_elem_state_rel.

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.

Task_element_state_relationship
%^task_elem_state_rel = Task_element_state_relationship%
Task_element_state_relationship.task_element -> @task_element
Task_element_state_relationship.state -> @state

-- provide the role of the relationship by classifying it
/assigning_reference_data(
    items=^task_elem_state_rel,
    class_name=@rel_type,
    ecl_id=@rel_type_ecl_id)/

Instance diagrams

The instance diagram in Figure 3 shows an example of the EXPRESS entities and templates that are instantiated by the template:

/representing_task_element_state_relationship(rel_type='Subtask_objective_state', rel_type_ecl_id='urn:plcs:rdl:sample', task_element='#1', state='#2')/

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

Figure 3 — Entities instantiated by representing_task_element_state_relationship template

The instance model in STEP ASCII exchange file format (ISO 10303 Part 21 syntax) is:


          #1 = TASK_STEP('/IGNORE','/IGNORE','/IGNORE','/IGNORE',$);
          #2 = STATE_DEFINITION('/IGNORE','/IGNORE');
          #3 = TASK_ELEMENT_STATE_RELATIONSHIP(#2,#1);
          #5 = CLASSIFICATION_ASSIGNMENT(#6,(#3),'/IGNORE');
          #6 = EXTERNAL_CLASS('/NULL','Subtask_objective_state','/IGNORE',#7);
          #7 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:sample','/IGNORE');

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_task_element_state_relationship(rel_type='Subtask_objective_state', rel_type_ecl_id='urn:plcs:rdl:sample', task_element='#1', state='#2')/

Figure 4 — Instantiation of representing_task_element_state_relationship template

Characterizations

No common characterizations of the template representing_task_element_state_relationship have been identified. However, the ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.