OTX Reference  
OpenTestSystem.Otx.Core.Procedure Class Reference

Executable part of an OTX document More...

Inheritance diagram for OpenTestSystem.Otx.Core.Procedure:
Inheritance graph

Classes

class  Comment
 Floating Comment More...
 
class  CommentLink
 Links the comment to a commented entity by its targetId attribute More...
 
class  CommentLinks
 The comment links block More...
 
class  Comments
 This optional element is a container for an arbitrary-length list of floating comments. They can be used for commenting parts of the procedure flow implementation for the human reader. More...
 
class  ExtensibleProcedureRealisation
 Declares a procedure which can be extented by additional realisations defined in new OTX extensions using the standardised extension mechanism, example: flow chart procedure. This procedure can be called by the ProcedureCall. More...
 
class  ProcedureRealisation
 Specifies the procedure implementation. More...
 

Public Attributes

ExtensibleProcedureRealisation extendedRealisation
 Declares a procedure which can be extented by additional realisations defined in new OTX extensions using the standardised extension mechanism, example: flow chart procedure. This procedure can be called by the ProcedureCall. More...
 
OtxLink implements
 This optional attribute supports the signature concept. It contains the qualified name of the signature that a procedure implements. More...
 
ProcedureRealisation realisation
 Specifies the procedure realisation. More...
 
OtxLink validFor
 Validity of procedure realisations. More...
 
Visibility visibility
 Procedure visibility More...
 
- Public Attributes inherited from OpenTestSystem.Otx.Core.UniversalTypes.NamedAndSpecified
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...
 
System.String specification
 Descriptive specification More...
 

Detailed Description

Executable part of an OTX document

A procedure element represents an executable part in an OTX document. It can be used as the entry point for the OTX runtime when a test sequence must be executed, but it can also be the target of a ProcedureCall from another OTX procedure.

Note
A procedure without realisation represents a NOP (No Operation) at runtime. The same applies procedure signatures without realisation.
Special semantic for main-procedures: If the name attribute of a procedure has the value main, then this procedure will be treated as a top-level procedure which represents the entry point for test sequence execution in an OTX application. Main-procedures are always public. They can be called by other OTX test sequences also like normal procedures.
Checker rules
CheckerRule.Core_Chk007 – Have specification if no realisation exists
CheckerRule.Core_Chk008 – Public main procedure

Member Data Documentation

◆ extendedRealisation

ExtensibleProcedureRealisation OpenTestSystem.Otx.Core.Procedure.extendedRealisation

Declares a procedure which can be extented by additional realisations defined in new OTX extensions using the standardised extension mechanism, example: flow chart procedure. This procedure can be called by the ProcedureCall.

◆ implements

OtxLink OpenTestSystem.Otx.Core.Procedure.implements

This optional attribute supports the signature concept. It contains the qualified name of the signature that a procedure implements.

Checker rules
CheckerRule.Core_Chk026 – No duplicate validities for procedures implementing the same signature
CheckerRule.Core_Chk027Procedure parameters match signature parameters
CheckerRule.Core_Chk053 – No dangling OtxLink associations

◆ realisation

ProcedureRealisation OpenTestSystem.Otx.Core.Procedure.realisation

Specifies the procedure realisation.

◆ validFor

OtxLink OpenTestSystem.Otx.Core.Procedure.validFor

Validity of procedure realisations.

This optional procedure attribute supports the signature concept which is based on the validities concept. It can be connected to a Boolean context variable, a global Boolean constant or a Validity term. At runtime, the truth value of the associated context variable, constant or the validity term determines whether a procedure shall be executed (validity value is true) or not (validity value is false). This allows context-based disabling/enabling of procedures. Refer to the ProcedureCall action.

Checker rules
Core.CheckerRule.Core_Chk013 – Correct referencing of validities
Core.CheckerRule.Core_Chk053 – No dangling OtxLink associations

◆ visibility

Visibility OpenTestSystem.Otx.Core.Procedure.visibility

Procedure visibility

The visibility levels are described by the Visibility enumeration.

Note
Special semantic for main-procedures: Main-procedures are always PUBLIC.