Template:— assigning_assessed_state (asg_asd_state) Date: 2008/02/20 08:05:00
Revision: 1.16

This section specifies the template assigning_assessed_state.

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 fact that something has been observed to be in a given state. This is purely an observation which has not been confirmed by evidence such as a measurement.

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


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

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

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

Figure 2 —   The graphical representation of assigning_assessed_state template

Input parameters
The following input parameters are defined for this template:
state_class_name (Type='CLASS')
The class name of the External_class corresponding to the State_definition name.
The following classes and their sub-classes can be used:
classifications: "State_definition" (urn:plcs:rdl:std:State_definition)
state_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The identifier of the External_class_library storing the definition of the class referenced by the parameter @state_class_name.
assigned_to (Type= 'SELECT (state_of_item)' )
The activity, product, individual, task_method, etc to which the state is assigned
Reference parameters
The following reference parameters are defined for this template:
state_def(Type='ENTITY (State_definition)')
Allow the State_definition entity instantiated in this path to be referenced when this template is used.
Note: The State_definition entity can be referenced in a template path by:
%^target = $assigning_assessed_state.state_def%
where target is the parameter to which the State_definition is bound.
state_obs(Type='ENTITY (State_observed)')
Allow the State_observed entity instantiated in this path to be referenced when this template is used.
Note: The State_observed entity can be referenced in a template path by:
%^target = $assigning_assessed_state.state_obs%
where target is the parameter to which the State_observed is bound.
state_assess(Type='ENTITY (State_assessment)')
Allow the State_assessment entity instantiated in this path to be referenced when this template is used.
Note: The State_assessment entity can be referenced in a template path by:
%^target = $assigning_assessed_state.state_assess%
where target is the parameter to which the State_assessment is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique state definition
There shall be at most one instance of the entity (State_definition) within the data set uniquely identified by a combination of the following parameters on this template (assigning_assessed_state) namely: state_class_name, state_ecl_id.
The instance is referenced by the following template parameter: state_def.
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 Reading Capability Templates help section.
-- Instantiate an Applied_state_assignment
Applied_state_assignment

-- Assign the Assessed State to the
-- to the instances passed into the template through the @assigned_to
-- input parameter (e.g. a Product_as_individual_view)
Applied_state_assignment.assigned_to -> @assigned_to

-- Instantiate and point at a State_role
Applied_state_assignment.role -> State_role

-- Set the State_role attributes name and description to be ignored
State_role.name = '/IGNORE'
State_role.description = '/IGNORE'

-- Instantiate and point at State_observed
Applied_state_assignment.described_state -> State_observed

-- Bind the State_observed to the parameter ^state_obs.
-- The parameter is a reference parameter so the State_observed
-- entity can be referred to when this template is used.
%^state_obs = State_observed%

-- Set the State_observed attributes name and description to be ignored
State_observed.name = '/IGNORE'
State_observed.description = '/IGNORE'

-- Instantiate State_assessment and point it at
-- State_observed just instantiated
State_assessment.assessed_state -> ^state_obs

-- Set the State_assessment attributes name and description to be ignored
State_assessment.name = '/IGNORE'
State_assessment.description = '/IGNORE'

-- Bind the State_assessment to the parameter ^state_assess.
-- The parameter is a reference parameter so the State_assessment
-- entity can be referred to when this template is used.
%^state_assess = State_assessment%

-- Instantiate and point at a State_definition
^state_assess.comparable_state -> State_definition

-- Bind the State_definition to the parameter ^state_def.
-- The parameter is a reference parameter so the State_definition
-- entity can be referred to when this template is used.
%^state_def = State_definition%

-- Set the State_definition attributes name and description to be ignored
State_definition.name = '/IGNORE'
State_definition.description = '/IGNORE'

-- Assign reference data for name of State_definition
/assigning_reference_data(
    items=^state_def,
    class_name=@state_class_name,
    ecl_id=@state_ecl_id)/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
State_role.name '/IGNORE'
State_role.description '/IGNORE'
State_observed.name '/IGNORE' State.name
State_observed.description '/IGNORE' State.description
State_assessment.name '/IGNORE'
State_assessment.description '/IGNORE'
State_definition.name '/IGNORE'
State_definition.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:
/assigning_assessed_state(state_class_name='Flat_tyre', state_ecl_id='urn:plcs:rdl:sample', assigned_to='#64')/
(an illustration of the consolidated assigning_assessed_state template is shown in Figure 4 below.)
Note that the templates assigning_time, assigning_identification and assigning_person_in_organization are used in the diagram. Namely:
@2 /assigning_time(date_class_name='Date_actual_assessment', date_ecl_id='urn:plcs:rdl:std', year='2005', month='10', day='3', hour='10', minute='34', second='21', sense='OFFSET_ORIENTATION.exact', hour_offset='0', minute_offset='0', items='#2')/
and:
@3 /assigning_person_in_organization(person_id='LA3412', person_id_class_name='Person_identification_code', person_id_ecl_id='urn:plcs:rdl:std', last_name='Smith', first_name='Jack', middle_names='', prefix_titles='', suffix_titles='', person_role_class_name='Assessor_of', person_role_ecl_id='urn:plcs:rdl:std', org_id='BikeHire Limited', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std', items='#2')/
and:
@4 /assigning_time(date_class_name='Date_actual_observation', date_ecl_id='urn:plcs:rdl:std', year='2005', month='10', day='3', hour='10', minute='12', second='55', sense='OFFSET_ORIENTATION.exact', hour_offset='0', minute_offset='0', items='#1')/
and:
@5 /assigning_person_in_organization(person_id='LA3411', person_id_class_name='Person_identification_code', person_id_ecl_id='urn:plcs:rdl:std', last_name='Olsen', first_name='Bob', middle_names='', prefix_titles='', suffix_titles='', person_role_class_name='Observer_of', person_role_ecl_id='urn:plcs:rdl:std', org_id='BikeRent Limited', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std', items='#1')/
and:
@6 /assigning_identification(id='abc123', class_name='Identifier_type', id_ecl_id='urn:plcs:rdl:std', org_id='BikeRent Limited', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std', items='#1')/


Figure 3 —  Entities instantiated by assigning_assessed_state template

Figure 3 —  Entities instantiated by assigning_assessed_state 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_assessed_state(state_class_name='Flat_tyre', state_ecl_id='urn:plcs:rdl:sample', assigned_to='#64')/


Figure 4 —  Instantiation of assigning_assessed_state template

Figure 4 —  Instantiation of assigning_assessed_state template

Characterizations
The following section details how the assigning_assessed_state 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 EXPRESS-G diagram in Figure 5 shows the possible characterizations of the template "assigning_assessed_state".


Figure 5 —  Characterizations for assigning_assessed_state

Figure 5 —  Characterizations for assigning_assessed_state

The following characterizations may apply:
Characterization Assigning dates

NOTE   this characterization is optional.

Dates and times can be associated with the assignment of an assessed state in a given role by using the template assigning_time.



Figure 6 —  Characterization by date and time of assigning_assessed_state template

Figure 6 —  Characterization by date and time of assigning_assessed_state template

Several dates can be assigned to the template assigning_assessed_state, however two dates and times are commonly assigned to these being the date and times on which the state was assessed and the date and time when the state was observed.

The date and time on which the state was assessed is represented by using the template assigning_time to assign a date and time to State_assessment. The date assignment is classified as: "Date_actual_assessment" (urn:plcs:rdl:std:Date_actual_assessment) to indicate that it is the date and time when the state was assessed. This is illustrated in Figure 6.

The date and time on which the state was observed is represented by using the template assigning_time to assign a date and time to State_observed. The date assignment is classified as: "Date_actual_observation" (urn:plcs:rdl:std:Date_actual_observation) to indicate that it is the date and time when the state was observed. This is illustrated in Figure 6.

Characterization Assigning person

NOTE   this characterization is optional.

People can be associated with the assignment of an assessed state in a given role by using the template assigning_person_in_organization to assign a person to either a State_observed or a State_assessment.



Figure 7 —  Characterization by person of assigning_assessed_state template

Figure 7 —  Characterization by person of assigning_assessed_state template

Several roles can be assigned to an assessed state. Two common roles in which people are assigned to the assignment of an assessed state are as an "Assessor of" the state and as an "Observer of" the state.

The person who assessed the state is represented by using the template assigning_person_in_organization to assign a person to State_assessment. The assignment of the person (Organization_or_person_in_organization_assignment) is classified as: "Assessor_of" (urn:plcs:rdl:std:Assessor_of) to indicate that it is this person who has assessed the state. This is illustrated in Figure 7.

The person who observed the state is represented by using the template assigning_person_in_organization to assign a person to State_observed. The assignment of the person (Organization_or_person_in_organization_assignment) is classified as: "Observer_of" (urn:plcs:rdl:std:Observer_of) to indicate that it is this person who has observed the state. This is illustrated in Figure 7.

Characterization Assigning Identification

NOTE   this characterization is optional.

Identifiers can be associated with the assignment of an assessed state by using the template assigning_identification to assign an identifier to a State_observed.



Figure 8 —  Characterization by identifier of assigning_assessed_state template

Figure 8 —  Characterization by identifier of assigning_assessed_state template

An example of the use of an identifier could be to identify the fault that is the reason for a repair activity.

© OASIS 2008 — All rights reserved