| Template:— representing_planned_activity (rep_plan_act) |
Date: 2010/01/14 16:56:09
Revision: 1.20
|
This section specifies the template representing_planned_activity.
NOTE
An explanation of a template and the associated instantiation path is
provided in the
Template overview
section.
This template describes how to represent a specific activity that is planned to take place
some time in the future but is not authorized by a work order i.e. directed.
NOTE
This template is primarily intended to represent planned product usage in operational stages, but may also be used
to represent activities planned to be done to a product that are not formally authorised
by a Work_order.
Where the activity is work planned to be done on a product and authorised
by a Work_order, the template
representing_work_order
should be used.
Where the activity is work that has been done to a product in response to
a planned activity (a Directed_activity) that has been authorized
by a Work_order, the template
representing_work_done
should be used.
Where the activity is a record of a usage of a product that has taken place, e.g.
a sortie flown by an aircraft , the template
representing_product_usage
should be used.
Where the activity is a record of an activity that has taken place that is neither an authorized activity i.e. not authorized by
a Work_order such as part of a directed
change or technical bulletin, nor an activity performed by a product the
more generic template
representing_activity_actual should be used.
NOTE
A planned activity may include reference to a specific product,
but this is not included in the template.
The EXPRESS-G diagram in
Figure
1
shows the templates and EXPRESS entities that are required
to represent the template
"representing_planned_activity".
The text highlighted in blue shows the template parameters.
Grey areas and templates with dashed lines are not included in the template, but may be used to further characterize
the template.
Figure 1 — An EXPRESS-G representation of the Information model for representing_planned_activity
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 representing_planned_activity template
The following input parameters are defined for this template:
The identifier of the planned activity.
id_class_name (Default=Activity_identification_code,Type='CLASS')
The name of the class being used to classify the identification
(
Identification_assignment)
of the planned activity. This provides the role or reason for the identification.
The following classes and their sub-classes can be used:
id_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 @id_class_name class.
The name or identifier of the organization owning the identifier.
The name of the class being used to classify the
identification of the organization. For example CAGE code, or organization name.
The following classes and their sub-classes can be used:
The typical activity of which this planned activity is an instance,
or other regulating method.
The name of the class being used to classify the date or time.
Must be either a planned start or end date or time.
The following classes and their sub-classes can be used:
Calendar_date year_component
Calendar_date month_component
Calendar_date day_component
Local_time year_component of the date and time.
Local_time month_component of the date and time.
This parameter is optional. If not given, it will remain unset.
Local_time day_component of the 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 following reference parameters are defined for this template:
Allow the
Activity
entity instantiated in this path to be referenced when this template is used.
Note: The
Activity
entity can be referenced in a template path by:
%^target = $representing_planned_activity.plan_act%
where
target
is the parameter to which the
Activity
is bound.
Allows referencing of entity Activity from outside the template, e.g.
in order to characterize the Activity further.
The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique planned activity
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 planned Activity Activity%^plan_act =
Activity%
^plan_act.id = '/IGNORE'
^plan_act.name = '/IGNORE'
^plan_act.description = '/IGNORE'
^plan_act.chosen_method ->
@typical_act-- assign ID to planned activity /
assigning_identification(
id=@id,
id_class_name=@id_class_name,
id_ecl_id=@id_ecl_id,
org_id=@id_owner,
org_id_class_name=@id_owner_class_name,
org_id_ecl_id=@id_owner_ecl_id,
items=^plan_act)/
-- classify the Activity as planned /
assigning_reference_data(
class_name='Planned_Activity',
ecl_id='urn:plcs:rdl:std',
items=^plan_act)/
-- assigning a planned date of the planned activity /
assigning_time(
date_class_name=@date_class_name,
date_ecl_id=@date_ecl_id,
year=@year,
month=@month,
day=@day,
hour=@hour,
minute=@minute,
second=@second,
sense=@sense,
hour_offset=@hour_offset,
minute_offset=@minute_offset,
items= ^plan_act)/
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:
/representing_planned_activity(id='M142345242-P', id_class_name='Activity_identification_code', id_ecl_id='urn:plcs:rdl:std', id_owner='ExpressDeliveryInc', id_owner_class_name='Organization_name', id_owner_ecl_id='urn:plcs:rdl:std', items='#65', method='#40', date_class_name='Date_planned_start', date_ecl_id='urn:plcs:rdl:std', year='2007', month='1', day='7', hour='', minute='10', second='0', sense='.EXACT.', hour_offset='0', minute_offset='0')/
(an illustration of the consolidated representing_planned_activity template is shown in
Figure
4 below.)
Figure 3 — Entities instantiated by representing_planned_activity 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:
/representing_planned_activity(id='M142345242-P', id_class_name='Activity_identification_code', id_ecl_id='urn:plcs:rdl:std', id_owner='ExpressDeliveryInc', id_owner_class_name='Organization_name', id_owner_ecl_id='urn:plcs:rdl:std', items='#65', method='#40', date_class_name='Date_planned_start', date_ecl_id='urn:plcs:rdl:std', year='2007', month='1', day='7', hour='', minute='10', second='0', sense='.EXACT.', hour_offset='0', minute_offset='0')/
Figure 4 — Instantiation of representing_planned_activity template
The following section details how the
representing_planned_activity
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 product
NOTE this characterization is optional.
A planned activity may relate to a product that is going to be used in the activity, or on which
the activity will be performed.
A product is assigned to an activity using template
assigning_activity
assigned to
Activity.
See
Figure 1
for an Express-G overview.
Characterization Assigning classification or code
NOTE this characterization is optional.
Classifications and codes may be assigned to a planned activity
through external reference data.
See
Figure 1
for an Express-G overview.
A class of an Activity is represented using the template
assigning_reference_data
assigned to
Activity.
A code of an Activity is represented by using the template
assigning_code
assigned to
Activity.
Characterization Assigning additional time
NOTE this characterization is optional.
This template mandates the assignment of a start time for the actual activity.
If the duration or end time of the Activity needs to be recorded, additional time may be assigned as well.
Additional time can be assigned to an Activity
by using the template
assigning_time.
See
Figure 1
for an Express-G overview.
A planned end date is commonly assigned to the template
representing_planned_activity.
The date and time assignment is classified as:
"Date planned end"
(urn:plcs:rdl:std:Date planned end)
to indicate that it is the date (and time) when the usage of the product ended.
Characterization Assigning organization
NOTE this characterization is optional.
Characterization Assigning work output
NOTE this characterization is optional.
If waste or by products are anticipated, such may be associated to the planned activity
by using the template
assigning_work_output.
See
Figure 1
for an Express-G overview.
Characterization Assigning location
NOTE this characterization is optional.
A location can be associated to the planned activity
by using the template
assigning_location.
The location may be expressed as a global location, an address-based location, an organization-based location,
or as a location in a regional grid. See further Capability C049: assigning_location (NB Capabilities are not documented in this release of the PLCS standard)
.
See
Figure 1
for an Express-G overview.
The assignment of the location
(assigning_location)
may be classified e.g. as 'Actual_start_location' or 'Actual_maintenance_location'.
Characterization Assigning approval and state
NOTE this characterization is optional.
Approvals and states may be associated with a planned activity.
See
Figure 1
for an Express-G overview.
An approval is associated with the planned activity
by using the template
assigning_approval.
A state is associated with the planned activity
by using the template
assigning_asserted_state.
