assigning_effectivity

NOTE An explanation of a template and the associated instantiation path is provided in the Template overview section.

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

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

%^target = $assigning_effectivity.eff_asg%

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

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

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

%^target = $assigning_effectivity.effectivity%

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

-- Instantiate the Effectivity entity
Effectivity

-- Set the Effectivity attributes id, name and description to be ignored
Effectivity.id = '/IGNORE'
Effectivity.name = '/IGNORE'
Effectivity.description = '/IGNORE'

-- Bind the Effectivity entity to the parameter ^effectivity.
-- The parameter is a reference parameter so the Effectivity
-- entity can be referred to when this template is used.
%^effectivity = Effectivity%

-- Assign reference data to Effectivity
/assigning_reference_data(
    items=^effectivity,
    class_name=@eff_class_name,
    ecl_id=@eff_ecl_id)/

-- Instantiate Effectivity_assignment entity
Effectivity_assignment

-- Set the Effectivity_assignment attribute role to be ignored
Effectivity_assignment.role = '/IGNORE'

-- Bind the Effectivity_assignment to the parameter ^eff_asg.
-- The parameter is a reference parameter so the Effectivity_assignment
-- entity can be referred to when this template is used.
%^eff_asg = Effectivity_assignment%

-- Assign reference data to Effectivity_assignment
/assigning_reference_data(
    items=^eff_asg,
    class_name=@role_class_name,
    ecl_id=@role_ecl_id)/

-- Set the Effectivity_assignment.assigned_effectivity attribute to the Effectivity entity
-- instantiated at the beginning of this path
Effectivity_assignment.assigned_effectivity -> Effectivity

-- Assign the Effectivity_assignment
-- to the instances passed into the template through the @items
-- input parameter
Effectivity_assignment.items -> @items

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

/assigning_effectivity(items='#1', eff_class_name='Design_effectivity', eff_ecl_id='urn:plcs:rdl:sample', role_class_name='Effectivity_target', role_ecl_id='urn:plcs:rdl:sample')/

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

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


          #1 = TASK_METHOD_VERSION_ASSIGNMENT($,(),'/IGNORE');
          #2 = EFFECTIVITY('/IGNORE','/IGNORE','/IGNORE');
          #3 = EFFECTIVITY_ASSIGNMENT(#2,'/IGNORE',(#1));
          #5 = CLASSIFICATION_ASSIGNMENT(#7,(#3),'/IGNORE');
          #7 = EXTERNAL_CLASS('/NULL','Effectivity_target','/IGNORE',#8);
          #8 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:sample',$);
          #10 = CLASSIFICATION_ASSIGNMENT(#12,(#2),'/IGNORE');
          #12 = EXTERNAL_CLASS('/NULL','Design_effectivity','/IGNORE',#8);

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_effectivity(items='#1', eff_class_name='Design_effectivity', eff_ecl_id='urn:plcs:rdl:sample', role_class_name='Effectivity_target', role_ecl_id='urn:plcs:rdl:sample')/

The following section details how the assigning_effectivity 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 descriptions

NOTE this characterization is optional.

Descriptions can be assigned to Effectivity using the template assigning_descriptor.

Characterization Assigning identifications

NOTE this characterization is optional.

Names can be assigned to the Effectivity using the template assigning_identification.

Entity in path	Value	Inherited from
Effectivity.id	'/IGNORE'	—
Effectivity.name	'/IGNORE'	—
Effectivity.description	'/IGNORE'	—
Effectivity_assignment.role	'/IGNORE'	—