Template:— fleet (flt)
Context:— UK_Defence
Date: 2010/03/15 14:22:42
Revision: 1.7

This section specifies the template fleet.

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.

Description

This template describes how to represent the concept of a fleet in terms of PLCS model elements (templates, entities, and reference data).

Business perspective

A fleet is a named collection of products that are managed as a whole to meet an operational requirement.

Business object definition

This information object represents a named collection of products that are managed as a whole to meet an operational requirement.



Figure 1 —  A MOOD Business Architect representation of the Business Object: Fleet

Figure 1 —  A MOOD Business Architect representation of the Business Object: Fleet

The attributes of the Fleet object are tabled below.

Attribute name

Attribute description

Attribute type

Optionality

Capability This is a reference to the capability of the fleet components. Relationship to Fleet Capability Mandatory (1:?)
End date This is the date for which the fleet ceased to exist. intrinsic Optional
ID This is the identifier of the fleet. intrinsic Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the fleet. intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the fleet. fleet_id_code Mandatory
Identifier.source_organization This attribute is the value representing the source organization that provides the id of the Identifier given to the fleet. This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Name This is the name of the fleet. intrinsic Mandatory
Operational requirement This is the reference to the operational requirement for which the fleet is assembled. Relationship to Requirement Mandatory
Start date This is the date for which the fleet was assembled. intrinsic Mandatory

Table 1 — Fleet attribute details

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


Figure 2 —  An EXPRESS-G representation of the Information model for fleet

Figure 2 —  An EXPRESS-G representation of the Information model for fleet

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

Figure 3 —  The graphical representation of the fleet template

Input parameters
The following input parameters are defined for this template:
end_date_year (Type= 'TYPE (year_number)' , Optional)
This is the year component of the end date of the existence of the fleet.
end_date_month (Type= 'TYPE (month_in_year_number)' , Optional)
This is the month component of the end date of the existence of the fleet.
end_date_day (Type= 'TYPE (day_in_month_number)' , Optional)
This is the day component of the end date of the existence of the fleet.
ID (Type='STRING')
This is the identifier of the fleet.
source_organization (Default=UK_Defence,Type='STRING')
The organization that created the associated identifier. Additionally a Person or Information System could be defined when either of these are the source; see Identifier template characterizations.
name (Type='STRING')
This is the name of the fleet.
operational_requirement (Type= 'ENTITY (Requirement_view_definition)' )
This is the reference to the (operational) requirement.
start_date_year (Type= 'TYPE (year_number)' )
This is the year component of the date for which the fleet was assembled.
start_date_month (Type= 'TYPE (month_in_year_number)' )
This is the month component of the date for which the fleet was assembled.
start_date_day (Type= 'TYPE (day_in_month_number)' )
This is the day component of the date for which the fleet was assembled.
Reference parameters
The following reference parameters are defined for this template:
prod_grp(Type='ENTITY (Product_group)')
Allow the Product_group entity instantiated in this path to be referenced when this template is used.
Note: The Product_group entity can be referenced in a template path by:
%^target = $fleet.prod_grp%
where target is the parameter to which the Product_group 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 Templates Help/Information section.
Product_group
%^prod_grp = Product_group%

-- ID
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type='fleet_id_code',
    items=^prod_grp)/

-- name
/identifier(
    ID=@name,
    source_organization=@source_organization,
    type='fleet_name',
    items=^prod_grp)/

-- end and start dates
/assigning_dated_effectivity(
    start_year=@start_date_year,
    start_month=@start_date_month,
    start_day=@start_date_day,
    start_hour='',
    start_minute='',
    start_second='',
    start_sense=''exact',
    start_hour_offset='',
    start_minute_offset='',
    end_year=@end_date_year,
    end_month=@end_date_month,
    end_day=@end_date_day,
    end_hour='',
    end_minute='',
    end_second='',
    end_sense=''exact',
    end_hour_offset='',
    end_minute_offset='',
    role_class_name='',
    role_ecl_id='urn:plcs:rdl:std',
    items=^prod_grp)/

-- operational requirement
/assigning_requirement(
    class_name='Fleet_operational_requirement',
    ecl_id='urn:plcs:rdl:uk_defence',
    req=@operational_requirement,
    assigned_to=^prod_grp )/
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/fleet(end_year='', end_month='', end_day='', ID='fleet_123', source_organization='6421', name='the_fleet', start_year='2009', start_month='09', start_day='01', operational_requirement='#69')/
(an illustration of the consolidated fleet template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by fleet template

Figure 4 —  Entities instantiated by fleet 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:
/fleet(end_year='', end_month='', end_day='', ID='fleet_123', source_organization='6421', name='the_fleet', start_year='2009', start_month='09', start_day='01', operational_requirement='#69')/


Figure 5 —  Instantiation of fleet template

Figure 5 —  Instantiation of fleet template

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

© UK MOD 2010 — All rights reserved