Template:— assigning_dated_effectivity (ass_date_eff)
Capability:assigning_effectivity |
Date: 2009/04/03 08:44:10
Revision: 1.21
|
This section specifies the template assigning_dated_effectivity.
NOTE
The template has been defined in the context of the capability
assigning_effectivity
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.
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
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
The following input parameters are defined for this template:
Calendar_date year_component of the effectivity start date and time.
Calendar_date month_component of the effectivity start date and time.
Calendar_date day_component of the effectivity start date and time.
Local_time hour_component of the effectivity start date and time.
Local_time minute_component of the effectivity start date and time.
This parameter is optional. If not given, it will remain unset.
Local_time day_component of the effectivity start date and time.
This parameter is optional. If not given, it will remain unset.
The direction of the offset. Enumeration values: 'ahead', 'exact' or 'behind'.
The number of hours by which a time is offset from Coordinated Universal Time.
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.
Calendar_date year_component of the effectivity end date and time.
This parameter is optional. If not given, it will remain unset.
Calendar_date month_component of the effectivity end date and time.
This parameter is optional. If not given, it will remain unset.
Calendar_date day_component of the effectivity end date and time.
This parameter is optional. If not given, it will remain unset.
Local_time hour_component of the effectivity end date and time.
This parameter is optional. If not given, it will remain unset.
Local_time minute_component of the effectivity end date and time.
This parameter is optional. If not given, it will remain unset.
Local_time second_component of the effectivity end date and time.
This parameter is optional. If not given, it will remain unset.
The direction of the offset. Enumeration values: 'ahead', 'exact' or 'behind'.
The number of hours by which a time is offset from Coordinated Universal Time.
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.
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:
The identifier of the
External_class_library
storing the definition of the class referenced by the parameter @role_class_name.
The items to which the dated effectivity is assigned.
The following reference parameters are defined for this template:
Allow the
Effectivity_assignment
entity instantiated in this path to be referenced when this template is used.
%^target = $assigning_dated_effectivity.eff_asgn%
Allow the
Dated_effectivity
entity instantiated in this path to be referenced when this template is used.
%^target = $assigning_dated_effectivity.dated_effectivity%
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.
-- 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:
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
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
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.
