representing_task

Template:— representing_task_step (rep_task_step)

Date: 2010/01/28 09:39:51
Revision: 1.5

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

This section specifies the template representing_task_step.

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 task step. A task step contains the details for a task version.

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

task_step_id (Type='STRING')

The task step identifier, e.g. the task step number.

task_step_id_class_name (Default=Task_step_identification_code,Type='CLASS')

The name of the class being used to classify the task step identifier (i.e. the @task_step_id)

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

classifications: "Task_step_identification_code" (urn:plcs:rdl:std:Task_step_identification_code), "Task_step_name" (urn:plcs:rdl:std:Task_step_name)

task_step_id_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 @task_step_id_class_name.

task_step_org_id (Type='STRING')

The name or identifier of the Organization that owns the @task_step_id.

task_step_org_id_class_name (Default=Organization_name,Type='CLASS')

The name of the class being used to classify the identification of the Organization responsible for creating the @task_step_id.

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

classifications: "Organization_identification_code" (urn:plcs:rdl:std:Organization_identification_code), "Organization_name" (urn:plcs:rdl:std:Organization_name)

task_step_org_id_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 @task_step_org_id_class_name.

task_step_details (Type='STRING')

Detailed description of how the to perform the task step.

Reference parameters

The following reference parameters are defined for this template:

task_step(Type='ENTITY (Task_step)')

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

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

%^target = $representing_task_step.task_step%

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

Task_step
%^task_step = Task_step%
Task_step.name = '/IGNORE'
Task_step.description = '/IGNORE'
Task_step.consequence = '/IGNORE'
Task_step.purpose = '/IGNORE'

-- Identify the Task_step
/assigning_identification(
    items= ^task_step,
    id= @task_step_id,
    id_class_name= @task_step_id_class_name,
    id_ecl_id= @task_step_id_ecl_id,
    org_id= @task_step_org_id,
    org_id_class_name= @task_step_org_id_class_name,
    org_id_ecl_id= @task_step_org_id_ecl_id )/
/assigning_descriptor(
    descr= @task_step_details,
    class_name= 'Description',
    ecl_id= 'urn:plcs:rdl:std',
    is_assigned_to= ^task_step)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Task_step.name	'/IGNORE'	Activity_method.name
Task_step.description	'/IGNORE'	Activity_method.description
Task_step.consequence	'/IGNORE'	Activity_method.consequence
Task_step.purpose	'/IGNORE'	Activity_method.purpose

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_step(task_step_id='1', task_step_id_class_name='Task_step_identification_code', task_step_id_ecl_id='urn:plcs:rdl:std', task_step_org_id='Bike Ltd', task_step_org_id_class_name='Organization_name', task_step_org_id_ecl_id='urn:plcs:rdl:std', task_step_details='Remove the wheel from ......')/

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

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

Figure 4 — Instantiation of representing_task_step template

Characterizations

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