assigning_information

Template:— assigning_information_collection (asg_info_cltn)
Capability:representing_project_information

Date: 2010/01/28 16:42:55
Revision: 1.1

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

This section specifies the template assigning_information_collection.

NOTE The template has been defined in the context of the capability representing_project_information which provides an overall description of the relevant parts of the ISO 10303-239 information model and a description 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 assignment of an information collection, either to a member of the information collection, or to the object for which the information collection is defined.

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

info_collection_ver (Type= 'ENTITY (Document_version)' )

The information collection which is assigned to either its members or its target object.

items (Type= 'SELECT (documented_element_select)' )

The target of the assignment, i.e. the entity instance that is either a member or the target for the information collection.

role (Type='CLASS')

The name of the External_class used to determine the the role of the assignment.

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

classifications: "Information_collection_member" (urn:plcs:rdl:std:Information_collection_member), "Information_collection_target" (urn:plcs:rdl:std:Information_collection_target)

role_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The identifier of the External_class_library storing the definition of the External_class referenced by the parameter @role.

Reference parameters

The following reference parameters are defined for this template:

info_collection_asg(Type='ENTITY (Document_assignment)')

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

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

%^target = $assigning_information_collection.info_collection_asg%

where target is the parameter to which the Document_assignment is bound.

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Information_collection_assignment

Each instance of the entity (Document_assignment) within the data set shall be uniquely identified by a combination of the following parameters on this template (assigning_information_collection) namely: info_collection_ver, items, role, role_ecl_id.
The instance is referenced by the following template parameter: info_collection_asg.

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.

Document_assignment
Document_assignment.role = '/IGNORE'
Document_assignment.is_assigned_to -> @items

-- Mark the Document_assignment entity representing the information collection assignment
-- as referable when this template is used.
-- In other words, bind the Document_assignment instance to the reference
-- parameter info_collection_asg
%^info_collection_asg = Document_assignment%

-- Assign the role through ref data
/assigning_reference_data(
    items=^info_collection_asg,
    class_name=@role,
    ecl_id=@role_ecl_id)/

-- Assign the document representing the information collection to be used
Document_assignment.assigned_document -> @info_collection_ver

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Document_assignment.role	'/IGNORE'	—

Instance diagrams

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

/assigning_information_collection(info_collection_ver='#2', items='#4', role='Information_collection_member', role_ecl_id='urn:plcs:rdl:sample')/

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

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

/assigning_information_collection(info_collection_ver='#2', items='#4', role='Information_collection_member', role_ecl_id='urn:plcs:rdl:sample')/

Figure 4 — Instantiation of assigning_information_collection template

Characterizations

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