Template:— assigning_scheme_entry_item (asg_scm_entry_item)
Context:— NOLITO

Date: 2008/06/05 13:32:46
Revision: 1.1

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

This section specifies the template assigning_scheme_entry_item.

NOTE The template has been defined in the context of NOLITO. Refer to the business context for details 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 the assignment of a defined entity as the Scheme_entry in a defined Scheme_version.

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

scheme_entry_id (Type='STRING')

The identification of the Scheme_entry.

scheme_entry_id_class_name (Default=Scheme_entry_identification_code,Type='CLASS')

The name of the External_class that determines the type of identifier given by the input parameter @scheme_entry_id.

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

classifications: [Scheme_entry_identification_code]

Error RDL1: The class Scheme_entry_identification_code does not exist in RDL at urn urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml

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

The identification of the External_class_library storing the External_class given by the input parameter @scheme_entry_id_class_name.

scheme_entry_org_id (Type='STRING')

The identification of the Organization that "owns" the Scheme_entry identifier (@scheme_entry_id).

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

The name of the External_class that determines the type of organization identification (@scheme_entry_org_id) being used. For example CAGE code.

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)

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

The identification of the External_class_library storing the External_class given by the input parameter @scheme_entry_org_id_class_name

assignment_role (Type='CLASS')

The role of the assignment.

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

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

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

The External_class_library storing the definition of the class referenced by the parameter @assignment_role

item (Type= 'SELECT (scheme_entry_item_select)' )

The target element of the assignment.

scheme_version (Type= 'ENTITY (Scheme_version)' )

The Scheme_version to which the scheme entry item is being assigned.

Reference parameters

The following reference parameters are defined for this template:

scheme_entry(Type='ENTITY (Scheme_entry)')

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

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

%^target = $assigning_scheme_entry_item.scheme_entry%

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

scheme_entry_asg(Type='ENTITY (Scheme_entry_assignment)')

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

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

%^target = $assigning_scheme_entry_item.scheme_entry_asg%

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

Uniqueness constraints

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.

Scheme_entry
%^scheme_entry = Scheme_entry%
Scheme_entry.name = '/IGNORE'
Scheme_entry.description = '/IGNORE'
Scheme_entry.consequence = '/IGNORE'
Scheme_entry.purpose = '/IGNORE'
Scheme_entry.scheme -> @scheme_version

-- Identify the Scheme_entry
/assigning_identification(
    items=^scheme_entry,
    id=@scheme_entry_id,
    id_class_name=@scheme_entry_id_class_name,
    id_ecl_id=@scheme_entry_id_ecl_id,
    org_id=@scheme_entry_org_id,
    org_id_class_name=@scheme_entry_org_id_class_name,
    org_id_ecl_id=@scheme_entry_org_id_ecl_id )/
Scheme_entry_assignment
%^scheme_entry_asg = Scheme_entry_assignment%
Scheme_entry_assignment.role = '/IGNORE'
Scheme_entry_assignment.items -> @item
Scheme_entry_assignment.assigned_activity_method -> ^scheme_entry

-- Assign the role of the assignment
/assigning_reference_data(
    items=^scheme_entry_asg,
    class_name=@assignment_role,
    ecl_id=@role_ecl_id)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Scheme_entry.name	'/IGNORE'	Activity_method.name
Scheme_entry.description	'/IGNORE'	Activity_method.description
Scheme_entry.consequence	'/IGNORE'	Activity_method.consequence
Scheme_entry.purpose	'/IGNORE'	Activity_method.purpose
Scheme_entry_assignment.role	'/IGNORE'	Applied_activity_method_assignment.role

Instance diagrams

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

/assigning_scheme_entry_item(scheme_entry_id='A-37-22-01-00A-920A', scheme_entry_id_class_name='Scheme_entry_identification_code', scheme_entry_id_ecl_id='urn:plcs:rdl:std', scheme_entry_org_id='Saab Aerosystems', scheme_entry_org_id_class_name='Organization_name', scheme_entry_org_id_ecl_id='urn:plcs:rdl:std', assignment_role='Included_maintenance_task', role_ecl_id='urn:plcs:rdl:sample', item='#1', scheme_version='#2')/

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

Figure 3 — Entities instantiated by assigning_scheme_entry_item 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 assigning_scheme_entry_item template

Characterizations

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