Capability (C005):— representing

Capability (C005):— representing_documents

Date: 2007/06/29 14:56:35
Revision: 1.22

Cover Contents Intro.Overview Info. model Templates Capabilities.Ref. data EXPRESS defs EXPRESS Issues

Capability EXPRESS information model

This section describes the EXPRESS information model for the capability.

From module : document_and_version_identification - using all

Document

A Document is a type of Product used to identify documentation data that is under configuration change management.

ENTITY Document SUBTYPE OF (Product); END_ENTITY;

Document_version

A Document_version is a type of Product_version. A Document_version identifies a particular version of a document.

ENTITY Document_version SUBTYPE OF (Product_version); SELF\Product_version.of_product : Document; END_ENTITY;

of_product: the Document of which the instance of this entity type is a version.

From module : document_definition - using all

TYPE document_location_select = SELECT BASED_ON external_identification_item WITH (Document_definition); END_TYPE;

Digital_document_definition

A Digital_document_definition is a type of Document_definition. It identifies a collection of files that are archived on an optical computer disc, magnetic, electronic storage, or a combination thereof. A digital document definition may consist of one or many component digital files.

ENTITY Digital_document_definition SUBTYPE OF (Document_definition); files : SET[0:?] OF Digital_file; END_ENTITY;

files: the set of instances of Digital_file that provides the content of the digital document.

Document_definition

A Document_definition is a type of Product_view_definition that is a Document_version in a particular format.

NOTE 1 A Document_version may have more than one representation.

EXAMPLE A version of a logical document, which contains a shape model, may be represented in the native formats of different CAD systems.

Each Document_definition is a Digital_document_definition or a Physical_document_definition.

NOTE 2 Aspects of the representation may not be known at the time the identification is established.

ENTITY Document_definition SUPERTYPE OF (ONEOF (Digital_document_definition, Physical_document_definition)) SUBTYPE OF (Product_view_definition); SELF\Product_view_definition.name RENAMED description : OPTIONAL STRING; SELF\Product_view_definition.defined_version RENAMED associated_document_version : Document_version; END_ENTITY;

description: the text that provides further information about the Document_definition. The value of this attribute need not be specified.

associated_document_version: the version of the logical document that is being represented.

Document_location_identification

A Document_location_identification is a type of External_source_identification that identifies the location of the components of a Document_definition in an external storage system where they can be found.

EXAMPLE 1 An HTML file that includes a picture may be represented as a Document_definition made of two components:

the HTML file;
the binary file that contains the picture.

If these files were located within the same directory or relatively to the same directory, the source_id attribute would convey the directory name.

EXAMPLE 2 Examples of source_type are:

'URL' - for a web page;
'FTP' - for an FTP address;
'ISBN' - for physical documents.

ENTITY Document_location_identification SUBTYPE OF (External_source_identification); WHERE WR1: 'DOCUMENT_DEFINITION_ARM.DOCUMENT_DEFINITION' IN TYPEOF(SELF\External_source_identification.item); END_ENTITY;

Physical_document_definition

A Physical_document_definition is a type of Document_definition. A physical document definition may consist of one or many component hardcopy files.

EXAMPLE Paper plots of technical drawings, micro fiche, or paper documents such as calculations or test reports are examples of Physical_document_definition.

ENTITY Physical_document_definition SUBTYPE OF (Document_definition); components : SET[0:?] OF Hardcopy; END_ENTITY;

components: the set of instances of Hardcopy that form the physical document.

From module : external_item_identification_assignment - using all

TYPE external_identification_item = EXTENSIBLE GENERIC_ENTITY SELECT; END_TYPE;

External_item_identification

An External_item_identification is a type of External_source_identification that provides the identifier of an item in the context of an external source where it can be found.

ENTITY External_item_identification SUBTYPE OF (External_source_identification); external_id : STRING; END_ENTITY;

external_id:

the identifier of the external item, in its external context.

EXAMPLE 1 For a digital file, the file name of a file in the directory where it is located is an example of external_id.

EXAMPLE 2 For a book, the external_id could be the ISBN number.

External_source_identification

An External_source_identification is the identification of the source where an item, or the components of an item, can be found.

ENTITY External_source_identification; source_id : STRING; source_type : STRING; item : external_identification_item; description : OPTIONAL STRING; END_ENTITY;

source_id:

the text that identifies the context in which the external_id is specified.

EXAMPLE 1 For a digital file identified by a filename and directory path, the source_id is the directory path.

source_type:

the text that identifies the identification scheme of the source_id.

EXAMPLE 2 In the case of files, examples of source_type are:

'URL' - for a web page;
'FTP' - for an FTP address;
'ISBN' - for physical documents.

item: the external_identification_item whose source is identified.

description: the text that provides further information about the external identification. The value of this attribute need not be specified.

From module : product_version_relationship - using all

Product_version_relationship

A Product_version_relationship is an association between two versions of Product.

NOTE A relationship may exist between Product_version of different Products or between different versions of the same Product.

ENTITY Product_version_relationship; relation_type : STRING; description : OPTIONAL STRING; relating_version : Product_version; related_version : Product_version; WHERE WR1: relating_version :<>: related_version; END_ENTITY;

relation_type:

the string that specifies the meaning of the Product_version_relationship.

Where applicable, the following values shall be used:

'derivation': the instance defines a deriving relationship where the related Product_version is based on the relating Product_version which is an earlier version of the same or of a different Product;
'hierarchy': the instance defines a hierarchical relationship where the related Product_version is a subordinate version of the relating Product_version;

EXAMPLE 1 'Rev. 1.1' and 'rev. 1.2' are subordinates of 'version 1'.
'sequence': the instance defines a version sequence where the relating Product_version is the preceding version of the related Product_version that is the following version. For a given Product_version, there shall be at most one Product_version_relationship of this relation_type referring to this Product_version as 'relating' and at most one Product_version_relationship of this relation_type referring as 'related'.

description: the text that provides further information about the Product_version_relationship. The value of this attribute need not be specified.

relating_version: the first instance of Product_version that is a part of the relationship.

related_version: the other instance of Product_version that is a part of the relationship. If one element of the relationship is dependent up on the other, this attribute shall be the dependent one.

Supplied_part_relationship

A Supplied_part_relationship is a type of Product_version_relationship that relates two instances of Product_version that represent the same object in different organizational contexts.

One of the organizations is the supplier of the object to the other organization.

This entity is applicable for part versions and document versions.

NOTE 1 This entity enables to represent the fact that two organizations may use distinct identifiers to identify their Products and their versions.

NOTE 2 This mechanism can only be used in an information system or in exchange files where the content of the id attribute of instances of Product is not constrained by a particular identification scheme.

NOTE 3 The module Alias identification provides a more general mechanism that can be used to track alias identifiers for any entity data type that has a id attribute.

ENTITY Supplied_part_relationship SUBTYPE OF (Product_version_relationship); WHERE WR1: SELF\Product_version_relationship.relation_type IN ['supplied item', 'supplied document']; END_ENTITY;

From module : file_identification - using all

TYPE located_select = SELECT BASED_ON external_identification_item WITH (File); END_TYPE;

Digital_file

A Digital_file is a type of File. A Digital_file contains computer interpretable data and is stored on an electronic device.

ENTITY Digital_file SUBTYPE OF (File); END_ENTITY;

File

A File is a file stored on a computer system or in a stack of non-digital documents. A File is either a Hardcopy or a Digital_file.

ENTITY File ABSTRACT SUPERTYPE OF (ONEOF (Digital_file, Hardcopy)); id : STRING; version : OPTIONAL STRING; contained_data_type : OPTIONAL STRING; END_ENTITY;

id:

the identifier for the File.

EXAMPLE This attribute may be used to convey the identification of a digital file in the directory where it is stored.

version: a string that provides a version identifier for the file. The value of this attribute need not be specified.

contained_data_type:

a string that provides information about the kind of data stored in the file. The value of this attribute need not be specified.

Where applicable, the following values shall be used:

'geometry': The file contains a shape model;
'NC data': The file contains numerical control data;
'FE data': The file contains finite element data;
'sample data': The file represents measured data;
'process plan': The document file represents process planning data;
'check plan': The document file represents quality control planning data;
'drawing': The document file represents a technical drawing.

Hardcopy

A Hardcopy is a type of File that represents a non-digital document.

EXAMPLE An actual stack of paper consisting of one or more sheets, on which some product data is written, printed or plotted.

ENTITY Hardcopy SUBTYPE OF (File); END_ENTITY;

File_location_identification

A File_location_identification is a type of External_item_identification that identifies the location of a File in an external storage system where it can be found.

EXAMPLE 1 For a computer file identified by a filename and directory path, for example 'D:\project1\specification.txt', the external_id attribute represents the filename, 'specification.txt' and the source_id attribute represents the path name, 'D:\project1\'.

EXAMPLE 2 Examples of source_type are:

'URL' - for a web page;
'FTP' - for an FTP address;
'ISBN' - for physical documents.

ENTITY File_location_identification SUBTYPE OF (External_item_identification); WHERE WR1: 'FILE_IDENTIFICATION_ARM.FILE' IN TYPEOF(SELF\External_source_identification.item); END_ENTITY;