Template:— recommended_utilities (recomm_utilities)
Context:— UK_Defence		 Date: 2010/02/17 17:10:35
Revision: 1.7
CoverContentsDescriptionBus. perspectiveBus. obj.Model diags.Input params.Ref. params.Instantiation pathInstance diags.CharacterizationsIssuesin situ
Template: recommended_utilities

XML references to the Template

These can be cut and pasted into the XML as required.

recommended_utilities

Set up a hyperlink to the template definition.
<template_ref name="recommended_utilities" context="UK_Defence" />

Set up a table of the template parameters.
<template_table figure_id="?" instance="?" name="recommended_utilities" context="UK_Defence" >
  <param name="assumptions">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="constraints">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="source_organization">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="related_support_solution">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="time_period">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="time_period_units">
    <param_value>Man_hour</param_value>
    <description></description>
  </param>
  <param name="utilities">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="utility_types">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="version">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="recommended_utilities">
  <param_in name="assumptions" value=""/>
  <param_in name="constraints" value=""/>
  <param_in name="id" value=""/>
  <param_in name="source_organization" value=""/>
  <param_in name="name" value=""/>
  <param_in name="related_support_solution" value=""/>
  <param_in name="time_period" value=""/>
  <param_in name="time_period_units" value="Man_hour"/>
  <param_in name="utilities" value=""/>
  <param_in name="utility_types" value=""/>
  <param_in name="version" value=""/>
</template_example>

recommended_utilities
/recommended_utilities(assumptions='', constraints='', id='', source_organization='', name='', related_support_solution='', time_period='', time_period_units='Man_hour', utilities='', utility_types='', version='')/

Path

-- required resource
Required_resource_by_specification
%^utility_req_res_spec = Required_resource_by_specification%

-- utilities
/representing_resource_item_realization(
    res_item_id='',
    res_item_id_class='',
    res_item_id_ecl_id='urn:plcs:rdl:std',
    res_item_id_org_id='',
    res_item_id_org_id_class='',
    res_item_id_org_id_ecl_id='urn:plcs:rdl:std',
    res_item_items=@utilities)/
%^utility_res_item = $representing_resource_item_realization.res_item%

-- required resource resource item
Required_resource_by_resource_item
Required_resource_by_resource_item.resource_item -> ^utility_res_item
%^utility_req_res_item = Required_resource_by_resource_item%

-- relate required resources specification and resource item
/representing_required_resource_relationship(
    req_res_rel_class_name='Required_resource_relationship',
    req_res_rel_ecl_id='urn:plcs:rdl:std',
    relating_req_res=^utility_req_res_spec,
    related_req_res=^utility_req_res_item)/

-- [optional utility_types [0:?]]
/representing_required_resource_relationship(
    req_res_rel_class_name='Required_resource_relationship',
    req_res_rel_ecl_id='urn:plcs:rdl:std',
    relating_req_res=^utility_req_res_spec,
    related_req_res=@utility_types)/

-- [Optional assumptions 0:?]
/assigning_document(
    doc_ass_role='Related_assumption',
    doc_ar_ecl_id='urn:plcs:rdl:std',
    assigned_document=@assumptions,
    is_assigned_to=^utility_req_res_spec)/

-- [Optional constraints 0:?]
Requirement_assignment
Requirement_assignment.assigned_requirement -> @constraints
Requirement_assignment.assigned_to -> ^utility_req_res_spec

-- related_support_solution
/assigning_document(
    doc_ass_role='Related_support_solution_definition',
    doc_ar_ecl_id='urn:plcs:rdl:std',
    assigned_document=@related_support_solution,
    is_assigned_to=^utility_req_res_spec)/

-- provide the role of the required resource
/assigning_reference_data(
    items=^utility_req_res_spec,
    class_name='recommended',
    ecl_id='urn:plcs:rdl:uk_defence')/

-- id
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='Recommended_utilities_id_code',
    items=^utility_req_res_spec )/

-- name
/identifier(
    ID=@name,
    source_organization=@source_organization,
    type='Recommended_utilities_name',
    items=^utility_req_res_spec )/

-- version
/assigning_descriptor(
    descr=@version,
    class_name='Recommended_utilities_version',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^utility_req_res_spec)/

XML representation of path

<refpath
   template="recommended_utilities">
   <comment>
      required resource
   </comment>
   <instantiate
      entity="Required_resource_by_specification"
      context="UK_Defence">
      
   </instantiate>
   <bind
      parameter="utility_req_res_spec">
      <express_entity
         entity="Required_resource_by_specification"
         context="UK_Defence">
         
      </express_entity>
   </bind>
   <comment>
      utilities
   </comment>
   <call_template
      name="representing_resource_item_realization"
      business_context="UK_Defence">
      <param_in
         name="res_item_id"
         value="''">
         
      </param_in>
      <param_in
         name="res_item_id_class"
         value="''">
         
      </param_in>
      <param_in
         name="res_item_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="res_item_id_org_id"
         value="''">
         
      </param_in>
      <param_in
         name="res_item_id_org_id_class"
         value="''">
         
      </param_in>
      <param_in
         name="res_item_id_org_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="res_item_items"
         value="@utilities">
         
      </param_in>
   </call_template>
   <bind
      parameter="utility_res_item">
      <template_instance
         template="representing_resource_item_realization"
         parameter="res_item">
         
      </template_instance>
   </bind>
   <comment>
      required resource resource item
   </comment>
   <instantiate
      entity="Required_resource_by_resource_item"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Required_resource_by_resource_item"
            attribute="resource_item"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="utility_res_item">
            
         </bound_parameter>
      </source>
   </assign>
   <bind
      parameter="utility_req_res_item">
      <express_entity
         entity="Required_resource_by_resource_item"
         context="UK_Defence">
         
      </express_entity>
   </bind>
   <comment>
      relate required resources specification and resource item
   </comment>
   <call_template
      name="representing_required_resource_relationship"
      business_context="UK_Defence">
      <param_in
         name="req_res_rel_class_name"
         value="'Required_resource_relationship'">
         
      </param_in>
      <param_in
         name="req_res_rel_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="relating_req_res"
         value="^utility_req_res_spec">
         
      </param_in>
      <param_in
         name="related_req_res"
         value="^utility_req_res_item">
         
      </param_in>
   </call_template>
   <comment>
      [optional utility_types [0:?]]
   </comment>
   <call_template
      name="representing_required_resource_relationship"
      business_context="UK_Defence">
      <param_in
         name="req_res_rel_class_name"
         value="'Required_resource_relationship'">
         
      </param_in>
      <param_in
         name="req_res_rel_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="relating_req_res"
         value="^utility_req_res_spec">
         
      </param_in>
      <param_in
         name="related_req_res"
         value="@utility_types">
         
      </param_in>
   </call_template>
   <comment>
      [Optional assumptions 0:?]
   </comment>
   <call_template
      name="assigning_document"
      business_context="UK_Defence">
      <param_in
         name="doc_ass_role"
         value="'Related_assumption'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="assigned_document"
         value="@assumptions">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^utility_req_res_spec">
         
      </param_in>
   </call_template>
   <comment>
      [Optional constraints 0:?]
   </comment>
   <instantiate
      entity="Requirement_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Requirement_assignment"
            attribute="assigned_requirement"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="constraints">
            
         </param_in_ref>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Requirement_assignment"
            attribute="assigned_to"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="utility_req_res_spec">
            
         </bound_parameter>
      </source>
   </assign>
   <comment>
      related_support_solution
   </comment>
   <call_template
      name="assigning_document"
      business_context="UK_Defence">
      <param_in
         name="doc_ass_role"
         value="'Related_support_solution_definition'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="assigned_document"
         value="@related_support_solution">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^utility_req_res_spec">
         
      </param_in>
   </call_template>
   <comment>
      provide the role of the required resource
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^utility_req_res_spec">
         
      </param_in>
      <param_in
         name="class_name"
         value="'recommended'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
   </call_template>
   <comment>
      id
   </comment>
   <call_template
      name="identifier"
      business_context="UK_Defence">
      <param_in
         name="ID"
         value="@id">
         
      </param_in>
      <param_in
         name="source_organization"
         value="@source_organization">
         
      </param_in>
      <param_in
         name="type"
         value="'Recommended_utilities_id_code'">
         
      </param_in>
      <param_in
         name="items"
         value="^utility_req_res_spec ">
         
      </param_in>
   </call_template>
   <comment>
      name
   </comment>
   <call_template
      name="identifier"
      business_context="UK_Defence">
      <param_in
         name="ID"
         value="@name">
         
      </param_in>
      <param_in
         name="source_organization"
         value="@source_organization">
         
      </param_in>
      <param_in
         name="type"
         value="'Recommended_utilities_name'">
         
      </param_in>
      <param_in
         name="items"
         value="^utility_req_res_spec ">
         
      </param_in>
   </call_template>
   <comment>
      version
   </comment>
   <call_template
      name="assigning_descriptor"
      business_context="UK_Defence">
      <param_in
         name="descr"
         value="@version">
         
      </param_in>
      <param_in
         name="class_name"
         value="'Recommended_utilities_version'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^utility_req_res_spec">
         
      </param_in>
   </call_template>
</refpath>

© UK MOD 2010 — All rights reserved