Template:— assigning_dated_effectivity (ass_date_eff) Date: 2008/03/06 06:55:59
Revision: 1.19

This section specifies the template assigning_dated_effectivity.

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 an Effectivity.

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


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

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

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

Figure 2 —   The graphical representation of template assigning_dated_effectivity

Input parameters
The following input parameters are defined for this template:
start_year (Type= 'TYPE (year_number)' )
Calendar_date year_component of the effectivity start date and time.
start_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component of the effectivity start date and time.
start_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component of the effectivity start date and time.
start_hour (Type= 'TYPE (hour_in_day)' )
Local_time hour_component of the effectivity start date and time.
start_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time minute_component of the effectivity start date and time. This parameter is optional. If not given, it will remain unset.
start_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time day_component of the effectivity start date and time. This parameter is optional. If not given, it will remain unset.
start_sense (Type= 'ENUMERATION (offset_orientation)' )
The direction of the offset. Enumeration values: 'ahead', 'exact' or 'behind'.
start_hour_offset (Type='INTEGER')
The number of hours by which a time is offset from Coordinated Universal Time.
start_minute_offset (Type='INTEGER', Optional)
The number of minutes by which a time is offset from Coordinated Universal Time. The value of this attribute need not be specified. This parameter is optional. If not given, it will remain unset.
end_year (Type= 'TYPE (year_number)' , Optional)
Calendar_date year_component of the effectivity end date and time. This parameter is optional. If not given, it will remain unset.
end_month (Type= 'TYPE (month_in_year_number)' , Optional)
Calendar_date month_component of the effectivity end date and time. This parameter is optional. If not given, it will remain unset.
end_day (Type= 'TYPE (day_in_month_number)' , Optional)
Calendar_date day_component of the effectivity end date and time. This parameter is optional. If not given, it will remain unset.
end_hour (Type= 'TYPE (hour_in_day)' , Optional)
Local_time hour_component of the effectivity end date and time. This parameter is optional. If not given, it will remain unset.
end_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time minute_component of the effectivity end date and time. This parameter is optional. If not given, it will remain unset.
end_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time second_component of the effectivity end date and time. This parameter is optional. If not given, it will remain unset.
end_sense (Type= 'ENUMERATION (offset_orientation)' , Optional)
The direction of the offset. Enumeration values: 'ahead', 'exact' or 'behind'.
end_hour_offset (Type='INTEGER', Optional)
The number of hours by which a time is offset from Coordinated Universal Time.
end_minute_offset (Type='INTEGER', Optional)
The number of minutes by which a time is offset from Coordinated Universal Time. The value of this attribute need not be specified. This parameter is optional. If not given, it will remain unset.
role_class_name (Type='CLASS')
The name of the class being used to classify the effectivity assignment (Effectivity_assignment) This provides the role for the assignment.
The following classes and their sub-classes can be used:
classifications: "Effectivity_assignment" (urn:plcs:rdl:std:Effectivity_assignment)
role_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 @role_class_name class.
items (Type= 'SELECT (effectivity_item)' )
The items to which the effectivity is assigned, e.g. an identification_assignment, a next_assembly_usage, etc.
Reference parameters
The following reference parameters are defined for this template:
eff_asgn(Type='ENTITY (Effectivity_assignment)')
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_dated_effectivity.eff_asgn%
where target is the parameter to which the Effectivity_assignment is bound.
dated_effectivity(Type='ENTITY (Dated_effectivity)')
Allow the Dated_effectivity entity instantiated in this path to be referenced when this template is used.
Note: The Dated_effectivity entity can be referenced in a template path by:
%^target = $assigning_dated_effectivity.dated_effectivity%
where target is the parameter to which the Dated_effectivity 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 Reading Capability Templates help section.
-- 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_asgn.
-- The parameter is a reference parameter so the Effectivity_assignment
-- entity can be referred to when this template is used.
%^eff_asgn = Effectivity_assignment%

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

-- Instantiate representing_dated_effectivity
/representing_dated_effectivity(
    start_year=@start_year,
    start_month=@start_month,
    start_day=@start_day,
    start_hour=@start_hour,
    start_minute=@start_minute,
    start_second=@start_second,
    start_sense=@start_sense,
    start_hour_offset=@start_hour_offset,
    start_minute_offset=@start_minute_offset,
    end_year=@end_year,
    end_month=@end_month,
    end_day=@end_day,
    end_hour=@end_hour,
    end_minute=@end_minute,
    end_second=@end_second,
    end_sense=@end_sense,
    end_hour_offset=@end_hour_offset,
    end_minute_offset=@end_minute_offset)/

-- Bind the Dated_effectivity instantiated by the
-- template representing_dated_effectivity
-- to the parameter ^dated_effectivity.
-- The parameter is a reference parameter so the
-- Dated_effectivity can be referred to when this template is used.
-- %^dated_effectivity = $representing_dated_effectivity.^dated_effectivity%
%^dated_effectivity = $representing_dated_effectivity.dated_effectivity%

-- Set the Effectivity_assignment.assigned_effectivity to
-- the Dated_effectivity entity instantiated by
-- representing_dated_effectivity
-- Effectivity_assignment.assigned_effectivity -> $representing_dated_effectivity.^dated_effectivity
-- Effectivity_assignment.assigned_effectivity -> $representing_dated_effectivity.dated_effectivity
Effectivity_assignment.assigned_effectivity -> ^dated_effectivity

-- Assign the Effectivity_assignment
-- to the instances passed into the template through the @items
-- input parameter (e.g. an Next_assembly_usage)
Effectivity_assignment.items -> @items
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Effectivity_assignment.role '/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_dated_effectivity(start_year='2005', start_month='11', start_day='22', start_hour='15', start_minute='15', start_second='00', start_sense='ahead', start_hour_offset='2', start_minute_offset='', end_year='2005', end_month='12', end_day='24', end_hour='15', end_minute='15', end_second='', end_sense='ahead', end_hour_offset='1', end_minute_offset='', role_class_name='Actual_effectivity', role_ecl_id='urn:plcs:rdl:std')/
(an illustration of the consolidated assigning_dated_effectivity template is shown in Figure 4 below.)


Figure 3 —  Entities instantiated by template assigning_dated_effectivity

Figure 3 —  Entities instantiated by template assigning_dated_effectivity

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_dated_effectivity(start_year='2005', start_month='11', start_day='22', start_hour='15', start_minute='15', start_second='00', start_sense='ahead', start_hour_offset='2', start_minute_offset='', end_year='2005', end_month='12', end_day='24', end_hour='15', end_minute='15', end_second='', end_sense='ahead', end_hour_offset='1', end_minute_offset='', role_class_name='Actual_effectivity', role_ecl_id='urn:plcs:rdl:std')/


Figure 4 —  Instantiation of template assigning_dated_effectivity

Figure 4 —  Instantiation of template assigning_dated_effectivity

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

© OASIS 2008 — All rights reserved