Template:— inventory_resource_event_relationship (invntry_res_event_rel)
Context:— UK_Defence

Date: 2009/04/17 09:34:16
Revision: 1.5

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

This section specifies the template inventory_resource_event_relationship.

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 relationship between a required resource and a resource event, for example, the relationship between a dues in and an inventory item receipt.

Model diagrams

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

Figure 1 — An EXPRESS-G representation of the Information model for inventory_resource_event_relationship

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

Input parameters

The following input parameters are defined for this template:

relating_resource_event (Type= 'ENTITY (Resource_event)' )

The related resource event.

related_required_resource (Type= 'ENTITY (Required_resource)' )

The related required resource.

resource_event_correspondence_rel_role (Type='CLASS')

The name of the External_class being used to determine the role of the correspondence relationship.

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

classifications: "Resource_event_correspondence_relationship" (urn:plcs:rdl:std:Resource_event_correspondence_relationship)

Reference parameters

The following reference parameters are defined for this template:

res_event_corresp_rel(Type='ENTITY (Resource_event_correspondence_relationship)')

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

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

%^target = $inventory_resource_event_relationship.res_event_corresp_rel%

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

Resource_event_correspondence_relationship
Resource_event_correspondence_relationship.name = '/IGNORE'
Resource_event_correspondence_relationship.relating -> @relating_resource_event
Resource_event_correspondence_relationship.related -> @related_required_resource

-- ref param
%^res_event_corresp_rel = Resource_event_correspondence_relationship%

-- role of relationship
/assigning_reference_data(
    items=^res_event_corresp_rel,
    class_name=@resource_event_correspondence_rel_role,
    ecl_id='urn:plcs:rdl:uk_defence')/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Resource_event_correspondence_relationship.name	'/IGNORE'	—

Instance diagrams

The instance diagram in Figure 3 shows an example of the EXPRESS entities and templates that are instantiated by the template:

/inventory_resource_event_relationship(relating_resource_event='#2', related_required_resource='#34', resource_event_correspondence_rel_role='dues_in_cleared_by')/

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

Figure 3 — Entities instantiated by inventory_resource_event_relationship 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:

/inventory_resource_event_relationship(relating_resource_event='#2', related_required_resource='#34', resource_event_correspondence_rel_role='dues_in_cleared_by')/

Figure 4 — Instantiation of inventory_resource_event_relationship template

Characterizations

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