Template:— zone_function (zn_fcn)
Context:— UK_Defence |
Date: 2009/04/17 12:54:31
Revision: 1.2
|
This section specifies the template zone_function.
NOTE
The template has been defined in the context of
UK_Defence.
Refer to the business context for details of related templates.
NOTE
An explanation of a template and the associated instantiation path is
provided in the
Template overview
section.
This template describes how to reference the functionality realized by a zone.
This Information Object represents the relationship between a zone and the functions / system elements that are performed
/ located within it.
This Information Object represents the relationship between a zone and the functions / system elements that are performed
/ located within it.
Figure 1 — Graphical Representation for Business Object Zone Function
|
Attribute name
|
Attribute description
|
Attribute type
|
Optionality
|
| id |
This attribute provides the identification of the zone function. |
Identifier |
Mandatory |
| Identifier.id |
This is the value of the id attribute of the Identifier applied to the zone function. |
intrinsic |
Mandatory |
| Identifier.type |
This attribute is the type associated with the id of the Identifier given to the Zone Function. This must be one of the classes
provided.
|
Zone_realization_identification_code |
Mandatory |
| Identifier.source_organization |
This attribute is the value representing the source organization that provides the id of the Identifier given to the Zone
Function. This value is assumed to be a type of Organization_identification_code.
|
Organization_identification_code |
Mandatory |
| Related_item |
This atttibute provides the reference to the function / system element that is performed / located within, the related zone. |
Relationship to Function/System Element |
Mandatory |
| Zone |
This is the reference to the zone within which the related function / system element is performed / located. |
Relationship to Zone |
Mandatory |
Table 1 — Zone_function attribute details
The EXPRESS-G diagram in
Figure
2
shows the templates and EXPRESS entities that are required
to represent the template
"zone_function".
The text highlighted in blue shows the template parameters.
Figure 2 — An EXPRESS-G representation of the Information model for zone_function
The graphic for the template to be used in other EXPRESS-G diagrams
is shown in Figure
3
below.
Figure 3 — The graphical representation of the zone_function template
The following input parameters are defined for this template:
This is the identifier of the zone breakdown item functionality relationship
This attribute is provides the type associated with the id of the Identifier given to the relationship. This must
be one of the classes provided.
The following classes and their sub-classes can be used:
classifications: [Zone_realization_identification_code]![[warning:]](../../../../../../images/dex/warning.gif)
Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
The identifier of the organization that owns the id. It is assumed that this will be of type Organization_identification_code
and not an Organization name.
This is the zone breadkdown element definition that is realizing the function.
The functional element definition being realized.
The following reference parameters are defined for this template:
Allow the
View_definition_usage
entity instantiated in this path to be referenced when this template is used.
%^target = $zone_function.realization_relationship%
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.
/
representing_breakdown_element_realization(
breakdown=@zone_breakdown_item,
product=@is_realization_of,
class_name='Zone_realization',
class_ecl_id='urn:plcs:rdl:uk_defence')/
%^realization_relationship = $representing_breakdown_element_realization.bkdn_elem_real%
-- assign ID to breakdown_element_realization /
identifier(
ID=@realization_id,
source_organization=@id_source_organization,
type=@realization_id_type,
items=^realization_relationship)/
The instance diagram in Figure
4
shows an example of the EXPRESS entities and templates that are instantiated by the template:
/zone_function(realization_id='ZR-001-001', realization_id_type='Zone_realization_identification_code', id_source_organization='6421')/
(an illustration of the consolidated zone_function template is shown in
Figure
5 below.)
Figure 4 — Entities instantiated by zone_function template
The instance diagram in
Figure
5
shows the graphic symbol for the template that is to be
used in other instance diagrams. The example template is:
/zone_function(realization_id='ZR-001-001', realization_id_type='Zone_realization_identification_code', id_source_organization='6421')/
Figure 5 — Instantiation of zone_function template
The following section details how the
zone_function
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 EXPRESS-G diagram in Figure
6
shows the possible characterizations of the template
"zone_function".
Figure 6 — Characterizations for zone_function
The following characterizations may apply:
Characterization Applicability date
NOTE this characterization is optional.
A UK_Defence.zone_function
may have effectivities assigned to it, such as an actual or planned effectivity, through the use of the following templates
(or those based upon these):
assigning_dated_effectivity. The following template calls show how these characterizations
might be instantiated.
/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', role_class_name='Actual_effectivity', role_ecl_id='urn:plcs:rdl:std', items='@@@@')/
/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', role_class_name='Planned_effectivity', role_ecl_id='urn:plcs:rdl:std', items='@@@@')/
Characterization Property
NOTE this characterization is optional.
A UK_Defence.zone_function
may have specific properties assigned to it, through the use of the following templates (or those based upon these):
UK_Defence.property. The following template calls show how these characterizations
might be instantiated.
/property(property_identifier='', property_ecl_id='', property_value='', property_unit='', unit_ecl_id='', si_unit='', disposition='', a_property_of='')/
Characterization Status Assignment
NOTE this characterization is optional.
An UK_Defence.zone_function
may have one or more status assigned to it, through the use of the following templates (or those based upon these):
UK_Defence.status_assignment.
The following template calls show how these characterizations
might be instantiated.
/status_assignment(assigned_status='', assigned_status_ecl_id='', ID='', ID_type='', ID_organization='', subject='', type='', type_ecl_id='')/
Characterization Document Association
NOTE this characterization is optional.
An UK_Defence.zone_function
may have specific documents assigned to it, through the use of the following templates (or those based upon these):
UK_Defence.document_association
, and the associated UK_Defence.document
. The following template calls show how these characterizations
might be instantiated.
/document_association(id='', type='', source_organization='', purpose='', related_document='', related_item='')/
