Capability (C086):— representing_slots Date: 2007/11/21 20:53:20
Revision: 1.10

Business overview

This section provides a business level overview of this capability.

This capability is used in conjunction with a product as a structure of components that are sub-assemblies, parts or slots. A slot represents the position in which a part is or can be attached to an assembly, when it is necessary to record the history of usage of that slot. It defines the concepts required to build the relationships which provide the structure for representing slots. A part is a type of product which represents a design.

The purpose of this capability is to provide;

EXAMPLE    A ship has four engines each attached at a mounting point in an engine room. These mounting points each has an associated slot, which are identified as slot 1, slot 2, slot 3, and slot 4. In normal usage only two main engines are are operating, the remaining two provide an operating enhancement if all four operate or a backup for the two main engines. The attached engines are tracked against their respective slots. If the ship does not have all of its engines installed, one or more slots are empty. An empty slot is subject to a different maintenance regime than an installed engine.

EXAMPLE    The pylon mounting on an aircraft wing is used to carry a radar, or fuel tank. The mounting has an associated slot. The fatigue life of the mounting will be determined differently depending on what is fitted at the slot and the duration of operating in that configuration which could be based on flying hours, landings, the calendar or some other measure.

EXAMPLE    A fast jet aircraft has two engines. These engines are removable and interchangeable between individual aircraft. A slot represents each installation position for an engine so as to ensure that an accurate record is maintained of which engines fly in which pairing on which aircraft for how many hours.

Information model overview

This section provides an overview of the information model that supports this capability.

A Attachment_slot may have one or more versions (Attachment_slot_version), and each may have one or more applicable view definitions (Attachment_slot_definition). Each of these are subject to identification as described within capability C001: assigning_identifiers. In this respect, the model closely resembles that of Part described within capability C002: representing_parts.



Figure 1 —  Overview of Basic Slot Representation

Figure 1 —  Overview of Basic Slot Representation

A Attachment_slot_version may exist in the form of a designed slot (Attachment_slot_design), a planned slot (Attachment_slot_as_planned) or a realized slot (Attachment_slot_as_realized).

As each is a version, the original Attachment_slot can be identified through the Attachment_slot_version's of_product attribute.

These versions correspond to the same PLCS approach to lifecycle management that are afforded to Parts, Product_as_planned and Product_as_realized described earlier in the busines section. The distinction between design, planned and realized products is also provided in capability C045: representing_product_as_individual (shortly to become representing_product_as_individual).

The relationships Attachment_slot_on_product and Product_in_attachment_slot identify the slot attached to a product and which part has been fitted to the slot, respectively.

The Attachment_slot_on_product relates a attachment_slot on one hand to a product on the other. The former links to the Attachment_slot_definition described below, while the other should link to a type of Product_view_definition (or a subtype such as Part_view_definition).

A Attachment_slot_definition is attached to a product through the relationship entity Attachment_slot_on_product. The Attachment_slot_definition has a defined_version attribute linking the Attachment_slot_version. This, in turn, has an attribute of_product which links to the Attachment_slot.

Since an assembly is built from relationships between Product_view_definitions and a Attachment_slot_definition is a subtype of this, there is a mechanism to include Attachment_slots within an assembly.

For the case of

In some cases there may be a requirement to mix these lifecycle definitions as some parts may be treated as products in their own right. For example, a pre-fabricated slot may already exist which can be planned for during the design stage.

The relationship Product_in_attachment_slot relates a Attachment_slot_definition to the Product_view_definition of the product occupying the Attachment_slot. The product attached may or may not be at the same stage of lifecycle as the the rest of the assembly (see notes above on consistency).



Figure 2 —  Overview of Slot_versions

Figure 2 —  Overview of Slot_versions

The relationships between;

- identifies the path through the lifecycle taken by a version (Attachment_slot_version of_product) of a slot ( Attachment_slot).

NOTE    There are rules in the model to ensure that the same instance of Attachment_slot is used when relating Attachment_slot_design, Attachment_slot_as_planned and Attachment_slot_as_realized together using Attachment_slot_design_to_planned, Attachment_slot_design_to_realized or Attachment_slot_planned_to_realized.

A Attachment_slot may be identified whenever there two parts that are physically interfaced. If the details of this interface are required then the Attachment_slot may be associated with applicable instances of the Interface_connector and Interface_specification entity data types.

This capability covers both the representation of slots and the relationships between versions of slots. The process for generating these are described in the following sections.

Representation of Slots

The three steps to the PLCS approach are shown in the figure below.



Figure 3 —  Example of Basic Slot Identification

Figure 3 —  Example of Basic Slot Identification

Step 1; The representation of a Slot is achieved through a number of related subtype entities, namely, Attachment_slot, Attachment_slot_version and Attachment_slot_definition. These entities are the subject of the identification described in step 2.



Figure 4 —  Example Instantiation of Basic Slots.

Figure 4 —  Example Instantiation of Basic Slots.

Step 2; The identification of the Slot is represented through the use of the Identification_assignment entity which is applied to each of the entities involved in representing the Slot. This only shows part of the identification method since this is described in the dependent capability, C001: assigning_identifiers.



Figure 5 —  Example Instantiation of Slot Identification.

Figure 5 —  Example Instantiation of Slot Identification.

Step 3; The context of a Slot is represented through the use of the entity View_definition_context. These are necessary for the unambiguous referencing a Slot which further complements the identification in step 2.



Figure 6 —  Example Instantiation of Slot Contextualization.

Figure 6 —  Example Instantiation of Slot Contextualization.

The classification representation which uses instances of external _class has a source, which is for PLCS purposes going to be provided in a reference data library (RDL). This is shown below.



Figure 7 —  Example Instantiation of Slot Classification and Reference Data Library

Figure 7 —  Example Instantiation of Slot Classification and Reference Data Library

Representing Versions of Slots

A Attachment_slot_version may exist in the form of a designed slot (Attachment_slot_design), a planned slot (Attachment_slot_as_planned) or a realized slot (Attachment_slot_as_realized).

These versions correspond to the same PLCS approach to lifecycle management that are afforded to Parts, Product_as_planned and Product_as_realized described earlier in the busines section. The distinction between design, planned and realized products is also provided in capability C045: representing_product_as_individual (shortly to become representing_product_as_individual).

Versions are identified through a version code (usually a number) while the original Attachment_slot can be identified through the Attachment_slot_version's of_product attribute.

The following figures show the representation of these three types of versions.



Figure 6 —  Representing a design slot

Figure 6 —  Representing a design slot

NOTE    Both slot and slot design are shown having the same date/time for the assignments. It is likely the the slot is defined at the time of representing the design.



Figure 7 —  Representing a planned slot

Figure 7 —  Representing a planned slot

NOTE    Both slot and slot as planned are shown having different date/time for the assignments. It is likely that the date of design is earlier than that of the process plan.



Figure 8 —  Representing a realized slot

Figure 8 —  Representing a realized slot

NOTE    Both slot and slot as realized are shown having different date/time for the assignments. It is likely that the date of design and planned versions is earlier than that of the realized/as-built.

The relationships Attachment_slot_on_product and Product_in_attachment_slot identify the slot attached to a product and which part has been fitted to the slot, respectively.

The Attachment_slot_on_product relates a attachment_slot on one hand to a product on the other. The former links to the Attachment_slot_definition described below, while the other should link to a type of Product_view_definition (or a subtype such as Part_view_definition).

A Attachment_slot_definition is attached to a product through the relationship entity Attachment_slot_on_product. The Attachment_slot_definition has a defined_version attribute linking the Attachment_slot_version. This, in turn, has an attribute of_product which links to the Attachment_slot.



Figure 9 —  Representing the elements of a slot as planned

Figure 9 —  Representing the elements of a slot as planned

NOTE    The same structure of elements are employed to represent both slot_design and slot_as_realized. These are not shown here. See capabiliity representing_slots for more details.

Since an assembly is built from relationships between Product_view_definitions and a Attachment_slot_definition is a subtype of this, there is a mechanism to include Attachment_slots within an assembly.



Figure 10 —  Representing a slot as planned in an assembly containing instances of product as planned.

Figure 10 —  Representing a slot as planned in an assembly containing instances of product as planned.

NOTE    A complete assembly is not shown here - only the use of one contruct (promissory_usage) typically used in the representation of an assembly. Next_assembly_usage is another popular building block.

NOTE    The slot in this case forms part of a simple assembly (through promissory_usage) and at the same time identifies the parent in the assembly as the product upon which the slot sits. A slot may be defined at any level in the assembly - not just the top level as shown here.

Representing a Part in a Slot

Representing a part or product that occupies a slot makes use of the Product_in_attachment_slot relationship which links a Attachment_slot_definition with a Product. The following figure shows the representation of a Soundblaster PC card occupying the slot defined which is part of the PC assembly. It also shows the use of the Attachment_slot_on_product which identifies the top-level product on which the Attachment_slot sits.



Figure 11 —  Representing a Part in a Slot

Figure 11 —  Representing a Part in a Slot

Management of a Slot through life

If the Attachment_slot_as_planned has been produced from a specific Attachment_slot_design, then the Attachment_slot_design maybe related to the Attachment_slot_as_planned by the relation entity Attachment_slot_design_to_planned.




[warning:]Error I1; The image filename: ../\img\Relationship between a Design Slot and a Planned Slot.jpg contains whitespace
Figure 12 —  Relationship between a Design Slot and a Planned Slot.

Figure 12 —  Relationship between a Design Slot and a Planned Slot.

If the Attachment_slot_as_realized has been produced from a specific Attachment_slot_as_planned, then the they maybe related by the relation entity Attachment_slot_planned_to_realized.

If the Attachment_slot_as_realized has been made from a Attachment_slot_design then it may also be related to that version of the design by the relation entity Attachment_slot_design_to_realized.




[warning:]Error I1; The image filename: ../\img\Relationships between Slot Design, Slot as Planned and Slot as Realized.jpg contains whitespace
Figure 13 —  Relationships between Slot Design, Slot as Planned and Slot as Realized

Figure 13 —  Relationships between Slot Design, Slot as Planned and Slot as Realized

In cases where it is necessary to identify specific versions, the identification assignment of each should be specified. The figure below shows this.




[warning:]Error I1; The image filename: ../\img\Identifying the Versions of the related Slot Design, Slot as Planned and Slot as Realized.jpg contains whitespace
Figure 14 —  Identifying the Versions of the related Slot Design, Slot as Planned and Slot as Realized

Figure 14 —  Identifying the Versions of the related Slot Design, Slot as Planned and Slot as Realized

The Referencing of Individual Slots

Referencing slots for the design was provided in an earlier section. The mechanism to refer to Attachment_slot_as_planned and Attachment_slot_as_realized is the same and is not repeated here.

Characterization of model

The representation of a Slot is achieved through a number of related subtype entities, namely, Attachment_slot, Attachment_slot_version and Attachment_slot_definition. These entities are the subject of the identification described below.

The identification of the Slot is represented through the use of the Identification_assignment entity which is applied to each of the entities involved in representing the Slot. The identification assignment is subsequently classified through the Classification_assignment entity. For a Slot, the classification assigned should be a "slot_identification_code". For a Attachment_slot_version the classification assigned should be a "Version_code". For a Attachment_slot_definition, the classification assigned should be a "Identification_code". The class assigned through this mechanism is normally represented as an external_class as defined within an external_class_library. This is described more fully in the capability C010: assigning_reference_data. The identification assignment also has a responsible organization or person assigned to indicate the relevant owner using the entity Organization_or_person_in_organization_assignment. This is explained in greater depth in the capability referencing_person_organization
[warning:]Error C1: Capability referencing_person_organization not in dex_index.xml
. Additionally, a date and / or date and time may optionally also be assigned to the identification assignment using the entity Date_or_date_time_assignment. This is described in greater depth in the capability C036: assigning_date_time. This process of identification is described in the dependent capability, C001: assigning_identifiers.

The context of a Slot is represented through the use of the View_definition_context entity which is described in greater detail in capability C002: representing_parts.

Capability templates

The following sections define a set of templates for the capability, where a template is a specification of a set of entities that need to be instantiated to represent a given set of information.

Template: referencing_slot (Short name: ref_slot)

This section specifies the template referencing_slot.

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 @@@@

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

[warning:]Error model_diag_1: Either delete A DESCRIPTION OF THE DIAGRAM or provide a description
A DESCRIPTION OF THE DIAGRAM


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

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

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

[warning:]Error model_diag_1: Either delete A DESCRIPTION OF THE DIAGRAM or provide a description
A DESCRIPTION OF THE DIAGRAM


Figure 2 —  The graphical representation of the referencing_slot template

Figure 2 —  The graphical representation of the referencing_slot template

Input parameters
The following input parameters are defined for this template:
class_name (Type='CLASS')
THE DESCRIPTION OF THE INPUT PARAMETER
The following classes and their sub-classes can be used:
classifications: "PLCS-ARM-LF-THING" (urn:plcs:rdl:std:PLCS-ARM-LF-THING)
Reference parameters
The following reference parameters are defined for this template:
ext_class(Type='ENTITY (External_class)')
Allow the External_class entity instantiated in this path to be referenced when this template is used.
Note: The External_class entity can be referenced in a template path by:
%^target = $referencing_slot.ext_class%
where target is the parameter to which the External_class 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 Reading Capability Templates help section.
Identification_assignment

-- Mark the Identification_assignment entity as
-- referable when this template is used by binding it to the reference
-- parameter id_assgn
%^id_assgn = Identification_assignment%

[warning:]Error P8: the template referencing_slot does not have a parameter name [id].
Identification_assignment.identifier = @id
Identification_assignment.role = '/IGNORE'
Identification_assignment.description = '/NULL'

[warning:]Error P4: the template referencing_slot does not have a parameter name [items].
Identification_assignment.items -> @items

-- provide the role of the identification by classifying the Identification_assignment
/assigning_reference_data(
    items=^id_assgn,
    class_name=@id_class_name,
    ecl_id=@id_ecl_id)/

[warning:]Error t3: the template referencing_slot does not have a parameter name [id_class_name]. Parameters are: class_name items class_name ecl_id

[warning:]Error t3: the template referencing_slot does not have a parameter name [id_ecl_id]. Parameters are: class_name items class_name ecl_id

-- assign an organization to the identifier and classify it as 'Owner_of'
/assigning_organization(
    items=^id_assgn,
    org_id=@org_id,
    org_id_class_name=@org_id_class_name,
    org_id_ecl_id=@org_id_ecl_id,
    org_assgn_class_name='Owner_of',
    org_assgn_ecl_id='http://www.plcsinc.org/plcs-proposed')/

[warning:]Error t3: the template referencing_slot does not have a parameter name [org_id]. Parameters are: class_name items class_name ecl_id

[warning:]Error t3: the template referencing_slot does not have a parameter name [org_id_class_name]. Parameters are: class_name items class_name ecl_id

[warning:]Error t3: the template referencing_slot does not have a parameter name [org_id_ecl_id]. Parameters are: class_name items class_name ecl_id
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Identification_assignment.identifier @id
Identification_assignment.role '/IGNORE'
Identification_assignment.description '/NULL'
Instance diagrams
The instance diagram in Figure  3 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/referencing_slot(items='#1', class_name='Safety_critical', ecl_id='urn:plcs:rdl:std')/
(an illustration of the consolidated referencing_slot template is shown in Figure 4 below.)


Figure 3 —  Entities instantiated by referencing_slot template

Figure 3 —  Entities instantiated by referencing_slot template

The instance model in STEP ASCII exchange file format (ISO 10303 Part 21 syntax) is:
#1 = TASK_METHOD($,$,$,$,()); #2 = EXTERNAL_CLASS('/IGNORE','Safety_critical',$,#3); #3 = EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std',$); #4 = CLASSIFICATION_ASSIGNMENT(#2,(#1),'/IGNORE');
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_slot(items='#1', class_name='Safety_critical', ecl_id='urn:plcs:rdl:std')/


Figure 4 —  Instantiation of referencing_slot template

Figure 4 —  Instantiation of referencing_slot template

Characterizations
The following section details how the referencing_slot 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 date

NOTE   this characterization is optional.

The date when the Work_order and the Directed_activity was issued can be represented by assigning a date (using the relationship Date_or_date_time_assignment) to the Work_order and the Directed_activity using the assigning_calendar_date template with the Date_time being classified as a type of "Date actual release" (urn:plcs:rdl:std:Date actual release).

NOTE    The assignment of dates is described the capability C036: assigning_date_time.

Related capabilities

This capability "representing slots" is related to the following capabilities:

Dependent capabilities

This capability "representing slots" is dependent on the following capabilities:

Model reference data

The following classes of reference data are required for this capability:

[Slot_identification_code]
[warning:]Error RDL1: The class Slot_identification_code does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
[Version_code]
[warning:]Error RDL1: The class Version_code does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
Identification_code(urn:plcs:rdl:std:Identification_code)
An Identification_code is an Identifier_type where the associated identifier is structured according to a given convention, and whose value is unique within a given context. NOTE: Values can be singular, or they can be a concatenation of parts each with a meaning. EXAMPLE: Tag number, serial number, package number and document number.
[Id_owner]
[warning:]Error RDL1: The class Id_owner does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml

© OASIS 2010 — All rights reserved