Template:— operating_environment (op_env)
Context:— UK_Defence

Date: 2010/03/18 12:06:29
Revision: 1.5

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

This section specifies the template operating_environment.

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 an environment in which a product may operate or an activity may be carried out.

Business perspective

The Operating_environment business object is used by those UK_Defence Data Exchange Specifications that require information about the environment in which a product may operate or an activity may be carried out. The environment is characterized in terms of the ambient physical characteristics that typically exist there. This information is important from the viewpoint of the likely impact of the environment on the requirements for support and on the execution of support processes

Business object definition

Figure 1 — Graphical Representation for Business Object Operating_environment

Operating_environment:

The definition of an Operating_environment object is: Data about an environment in which a product may operate or an activity may be carried out.

Attribute name	Attribute description	Attribute type	Optionality
ID	This is the Identifier of the Operating_environment.	Identifier	Mandatory
Related assumptions	This is the reference to the set of assumptions from which the operating environment has been derived.	Relationship to Assumption	Optional(0:?)
Related_item	This is the relationship to the Activity or Product that is operated in this environment.	Relationship to Activity, or Product	Mandatory
Related locations	This is the reference to the environment in which the related product is operated or the related activity is carried out..	Relationship to Location	Mandatory(1:?)
Related requirements	This is the reference to the set of requirements from which the operating environment has been derived	Relationship to Requirement	Mandatory(1:?)

Table 1 — Operating_environment attribute details

Model diagrams

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

Figure 2 — An EXPRESS-G representation of the Information model for operating_environment

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure 3 below.

Figure 3 — The graphical representation of the operating_environment template

Input parameters

The following input parameters are defined for this template:

ID (Type='STRING')

This is the identifier of the Operating_environment.

source_organization (Type='STRING')

The organization that created the associated identifier. Additionally a Person or Information System could be defined when either of these are the source; see Identifier template.

related_assumptions (Type= 'ENTITY (Document)' , Optional)

This is the reference to the set of assumptions from which the operating environment has been derived

related_item (Type= 'SELECT (state_definition_of_item)' )

The item to which the operating environment is assigned

related_locations (Type= 'ENTITY (Location)' )

This is the reference to the environment in which the related product is operated or the related activity is carried out..

related_requirements (Type= 'ENTITY (Requirement_view_definition)' )

This is the reference to the set of requirements from which the operating environment has been derived

Reference parameters

The following reference parameters are defined for this template:

op_env(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 = $operating_environment.op_env%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Operating environment

Each instance of the entity (State_definition) within the data set shall be uniquely identified by a combination of the following parameters on this template (operating_environment) namely: ID, related_item, related_locations.
The instance is referenced by the following template parameter: op_env.

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.

-- Operating_environment
/assigning_state_type(
    sd_class_name='Operating_environment',
    sd_ecl_id='urn:plcs:rdl:uk_defence',
    sd_role_class_name='Operating_environment_definition_assignment',
    sd_role_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_to=@related_item)/
%^op_env = $assigning_state_type.state_def%

-- Operating_environment identifier
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type='Operating_environment_identifier',
    items=^op_env)/

-- [ OPTIONAL Document_assignment ] to indicate the assumption
Document_assignment

-- Set the OPTIONAL Document_assignment attribute role to be ignored
Document_assignment.role = '/IGNORE'
Document_assignment.assigned_document -> @related_assumptions
Document_assignment.is_assigned_to -> ^op_env

-- Instantiate the Requirement_assignment entity and link it to state_definition.
Requirement_assignment.assigned_requirement -> @related_requirements
Requirement_assignment.id = '/IGNORE'
Requirement_assignment.description = '/IGNORE'

-- Populate the Applied_state_definition_assignment
Applied_state_definition_assignment.described_state_definition -> ^op_env
Applied_state_definition_assignment.assigned_to -> @related_locations
Applied_state_definition_assignment.role -> ^op_env

The following entities are instantiated with attributes as specified:

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

Instance diagrams

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

/operating_environment(ID='OE123', source_organization='UK_Defence', related_assumptions='@504', related_item='@14', related_locations='@323', related_requirements='@357')/

(an illustration of the consolidated operating_environment template is shown in Figure 5 below.)

Figure 4 — Entities instantiated by operating_environment template

The instance diagram in Figure 5 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:

/operating_environment(ID='OE123', source_organization='UK_Defence', related_assumptions='@504', related_item='@14', related_locations='@323', related_requirements='@357')/

Figure 5 — Instantiation of operating_environment template

Characterizations

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