assigning

Template:— assigning_time (asg_time)

Date: 2008/02/28 15:59:44
Revision: 1.17

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

This section specifies the template assigning_time.

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 time to something. The purpose of the assignment is provided by classification. For example, the time is assigned as the start time.

Model diagrams

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

Figure 1 — Information model overview - Assigning time

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

Input parameters

The following input parameters are defined for this template:

date_class_name (Type='CLASS')

The name of the class being used to classify the role date assignment, e.g. the start date.

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

classifications: "Date_or_date_time_assignment" (urn:plcs:rdl:std:Date_or_date_time_assignment), "Date_time" (urn:plcs:rdl:std:Date_time), "Local_time" (urn:plcs:rdl:std:Local_time)

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

The id of the External_class_library in which the date class is defined.

year (Type= 'TYPE (year_number)' )

Calendar_date year_component

month (Type= 'TYPE (month_in_year_number)' )

Calendar_date month_component

day (Type= 'TYPE (day_in_month_number)' )

Calendar_date day_component

hour (Type= 'TYPE (hour_in_day)' )

Local_time year_component of the date and time.

minute (Type= 'TYPE (minute_in_hour)' , Optional)

Local_time month_component of the date and time. This parameter is optional. If not given, it will remain unset.

second (Type= 'TYPE (second_in_minute)' , Optional)

Local_time day_component of the date and time. This parameter is optional. If not given, it will remain unset.

sense (Type= 'ENUMERATION (offset_orientation)' )

The direction of the offset. Enumeration values: 'ahead', 'exact' or 'behind'.

hour_offset (Type='INTEGER')

The number of hours by which a time is offset from Coordinated Universal Time.

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.

items (Type= 'SELECT (date_or_date_time_item)' )

The items to which the date is assigned.

Reference parameters

The following reference parameters are defined for this template:

time_assgn(Type='ENTITY (Date_or_date_time_assignment)')

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

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

%^target = $assigning_time.time_assgn%

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

Date_or_date_time_assignment
%^time_assgn = Date_or_date_time_assignment%

-- the template assigning_reference_data is being called with parameters set.
-- The reference data is being assigned to the subject of the template,
-- in this case Date_or_date_time_assignment.
/assigning_reference_data(
    items=^time_assgn,
    class_name=@date_class_name,
    ecl_id=@date_ecl_id)/
Date_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items -> @items

-- the template representing_date_time is being instantiated with parameters set.
/representing_date_time(
    year=@year,
    month=@month,
    day=@day,
    hour=@hour,
    minute=@minute,
    second=@second,
    sense=@sense,
    hour_offset=@hour_offset,
    minute_offset=@minute_offset)/

-- the attribute Date_or_date_time_assignment.assigned_date is assigned to entity bound to
-- reference parameter date_time in the template representing_date_time
%^ldate_time = $representing_date_time.date_time%
Date_or_date_time_assignment.assigned_date -> ^ldate_time

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Date_or_date_time_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_time(items='#12', date_class_name='Date_actual_start', date_ecl_id='urn:plcs:rdl:std', year='2005', month='5', day='12', hour='14', minute='15', second='0', sense='.EXACT.', hour_offset='0', minute_offset='0')/

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

Note that the assigning_reference_data and representing_date_time templates are used in the diagram. Namely:

/assigning_reference_data(items='#1', class_name='Date_actual_start', ecl_id='urn:plcs:rdl:std')/

and

/representing_date_time(year='2005', month='5', day='12', hour='14', minute='15', second='0', sense='.EXACT.', hour_offset='0', minute_offset='0')/

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

Characterizations

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