Template:— referencing_person_typical (ref_pers_typ) Date: 2008/03/05 21:18:03
Revision: 1.4

This section specifies the template referencing_person_typical.

NOTE  An explanation of a template and the associated instantiation path is provided in the Template overview section.

Description

This template describes how to reference a type of person by its class name.

NOTE    The Type_of_person_definition has been omitted from this template.

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


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

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

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

Figure 2 —  The graphical representation of the referencing_person_typical template

Input parameters
The following input parameters are defined for this template:
type_of_pers_class_name (Type='CLASS')
The name of the External_class that determines the type of person being referenced.
The following classes and their sub-classes can be used:
classifications: "Type_of_person" (urn:plcs:rdl:std:Type_of_person)
type_of_pers_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The identification of the External_class_library storing the External_class given by the input parameter @type_of_person_class_name.
Reference parameters
The following reference parameters are defined for this template:
type_of_pers(Type='ENTITY (Type_of_person)')
Allow the Type_of_person entity instantiated in this path to be referenced when this template is used.
Note: The Type_of_person entity can be referenced in a template path by:
%^target = $referencing_person_typical.type_of_pers%
where target is the parameter to which the Type_of_person is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Type of person
Each instance of the entity (Type_of_person) within the data set shall be uniquely identified by a combination of the following parameters on this template (referencing_person_typical) namely: type_of_pers_class_name, type_of_pers_ecl_id.
The instance is referenced by the following template parameter: type_of_pers.
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.
Type_of_person

-- Mark the Type_of_person entity as
-- referable when this template is used by binding it to the reference
-- parameter type_of_pers
%^type_of_pers = Type_of_person%
Type_of_person.name = '/IGNORE'
Type_of_person.description = '/IGNORE'

-- provide the type of person by classifying the entity Type_of_person
/assigning_reference_data(
    items=^type_of_pers,
    class_name=@type_of_pers_class_name,
    ecl_id=@type_of_pers_ecl_id)/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Type_of_person.name '/IGNORE'
Type_of_person.description '/IGNORE'
Instance diagrams
The instance diagram in Figure  3 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/referencing_person_typical(type_of_pers_class_name='Welder', type_of_pers_ecl_id='urn:plcs:rdl:sample')/
(an illustration of the consolidated referencing_person_typical template is shown in Figure 4 below.)


Figure 3 —  Entities instantiated by referencing_person_typical template

Figure 3 —  Entities instantiated by referencing_person_typical template

The instance model in STEP ASCII exchange file format (ISO 10303 Part 21 syntax) is:
#1 = TYPE_OF_PERSON('/IGNORE','/IGNORE',()); #3 = CLASSIFICATION_ASSIGNMENT(#4,(#1),'/IGNORE'); #5 = EXTERNAL_CLASS('/NULL','Welder','/IGNORE',#6); #6 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:sample',$);
The instance model in STEP XML exchange file format (ISO 10303 Part 28 ed.2 syntax) is:
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:
/referencing_person_typical(type_of_pers_class_name='Welder', type_of_pers_ecl_id='urn:plcs:rdl:sample')/


Figure 4 —  Instantiation of referencing_person_typical template

Figure 4 —  Instantiation of referencing_person_typical template

Characterizations
The following section details how the referencing_person_typical 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 following characterizations may apply:
Characterization Assigning descriptor

NOTE   this characterization is optional.

Additional descriptions, notes etc for the defined Type_of_person may be assigned using the assigning_descriptor template.

© OASIS 2010 — All rights reserved