OTX Reference  
OpenTestSystem.Otx.Core.UniversalTypes.NamedAndSpecified Class Reference

Identifiable element More...

Inheritance diagram for OpenTestSystem.Otx.Core.UniversalTypes.NamedAndSpecified:
Inheritance graph

Classes

class  ExtensibleData
 Declares general data for NamedAndSpecified which can be extented by new general data defined in new OTX extensions using the standardised extension mechanism. More...
 

Public Attributes

ExtensibleData[] extendedData
 Declares general data for NamedAndSpecified which can be extented by new general data defined in new OTX extensions using the standardised extension mechanism. For example it can be used to specify specification relevant content in a better structured way. More...
 
OtxId id
 Unique identifier of an element More...
 
MetaData metaData
 Additional tool-specific data More...
 
OtxName name
 Name of an element More...
 
NamedAndSpecifiedSpecification[] specification
 Descriptive specification More...
 

Detailed Description

Identifiable element

The abstract type NamedAndSpecified is used by every type that shall be identifiable, nameable, carry a specification text and/or supply meta-data. Types using this are e.g. all node types, declarations, procedures and signatures or the Otx root node itself.

Checker rules
Core.CheckerRule.Core_Chk010 – Unique node names
Core.CheckerRule.Core_Chk058 - unique OtxIds

Member Data Documentation

◆ extendedData

ExtensibleData [] OpenTestSystem.Otx.Core.UniversalTypes.NamedAndSpecified.extendedData

Declares general data for NamedAndSpecified which can be extented by new general data defined in new OTX extensions using the standardised extension mechanism. For example it can be used to specify specification relevant content in a better structured way.

Note
IMPORTANT - The extension mechanism described here only defines the syntactic rules to which extension implementers shall obey in order to conform to ISO 13209-2. It shall be ensured that no OTX requirements are violated.

◆ id

OtxId OpenTestSystem.Otx.Core.UniversalTypes.NamedAndSpecified.id

Unique identifier of an element

The attribute value represents the unique identifier of a NamedAndSpecified element. The id uses the Universally Unique Identifiers (UUID) as specified by URN Namespace. It is global unique among all other ids. The OtxId type is a pattern-restriction of the string simple type. The value space of the attribute is restricted by the regular expression "[a-zA-Z0-9\\\-\.\|:_#/]+", which allows the basic letters, numbers as well as a set of delimiters.

The id attribute is useful concerning versioning, differencing or concurrent editing of OTX documents. It facilitates traceability of changes that occurred in between different versions of an OTX document because an element can still be identified even after having been moved or changed thoroughly.

Concerning id value allocation, OTX authoring applications will provide the following: When a new NamedAndSpecified element is created, the application will generate and assign a unique id-value to the element's id attribute. After creation, applications will not alter id values anymore. An id will stay with its element as an inherent part as long as the element exists – it will not be changed even if the element is moved or the contents of the element are changed. For each copy of an element, a new unique id value will be generated and assigned to the copy. The allocation and handling of id values will happen automatically in the background. No user action is required. Id values cannot be edited by the user.

Checker rules
CheckerRule.Core_Chk058 - Unique OtxIds

◆ metaData

MetaData OpenTestSystem.Otx.Core.UniversalTypes.NamedAndSpecified.metaData

Additional tool-specific data

If tool-specific data should be added, this element can be used.

◆ name

OtxName OpenTestSystem.Otx.Core.UniversalTypes.NamedAndSpecified.name

Name of an element

Optional name of an element. The name serves to distinguish the activities in the designer and should be unique.

Checker rules
Core.CheckerRule.Core_Chk010 – Unique node names

◆ specification

NamedAndSpecifiedSpecification [] OpenTestSystem.Otx.Core.UniversalTypes.NamedAndSpecified.specification

Descriptive specification

Optional descriptive specification of a NamedAndSpecified element.