OpenTestSystem::Otx::Runtime::Api Namespace Reference

Namespace containing the programming interface for browsing and execution of OTX procedures in own applications, main entry for execution is IRuntimeManager More...

Namespaces
	Custom
	Namespace containing custom implementations
	DataTypes
	Namespace which contains all supported data types
	Exceptions
	Namespace containing exceptions
	License
	Namespace containing all objects related to licensing
	Otx
	Namespace for browsing at OTX data structure.
	Project
	Namespace containing main entries: IProject and IPlayerProject.

Classes
class	DiagConnectionState
	The diagnostic connection state describes conditions how a procedure can be executed. More...
class	IRuntimeContext
	Contains information of a Runner instance. More...
class	IRuntimeManager
	Main class to load and execute an OTX project More...
class	RuntimeConfig
	Configuration class to modify OTX Runtime API global settings More...
class	RuntimeManagerFactory
	Factory class for creating runtime managers, see IRuntimeManager More...

Enumerations
enum class	ClampState { NotAvailable , On , Off }
	Contains the state of a clamp More...
enum	ExecutionState {   Pending , Running , Paused , Finished ,   Stopped , Aborted , Timeout }
	Contains the execution state of the RuntimeContext. More...
enum class	ExecutionStateChangeReason { Explicit , UnexpectedDiagConnectionState }
	Reason, why a procedure execution state was changed, e.g. Paused or Running More...
enum class	ExpectedState { None , BatteryOn , IgnitionOff , IgnitionOn }
	Contains the expected state of the diagnostic connection More...
enum	TraceLevels {   All , Trace , Debug , Info ,   Warn , Error , Fatal , Off ,   Off }
	Enumeration of TraceLevels More...

Detailed Description

Namespace containing the programming interface for browsing and execution of OTX procedures in own applications, main entry for execution is IRuntimeManager

Enumeration Type Documentation

ClampState

enum OpenTestSystem::Otx::Runtime::Api::ClampState

strong

Contains the state of a clamp

Enumerator
NotAvailable	The clamp state cannot be determined (default)
On	The clamp state is ON
Off	The clamp state is OFF

ExecutionState

enum OpenTestSystem::Otx::Runtime::Api::ExecutionState

Contains the execution state of the RuntimeContext.

Enumerator
Pending	The procedure execution is waiting for the start condition.
Running	The procedure was started and is running.
Paused	The procedure was started and is paused.
Finished	The procedure was finished successfully.
Stopped	The procedure was stopped by the user.
Aborted	The procedure was stopped with an exception.
Timeout	The procedure was stopped beause a timeout expires. From the beginning of Running state, the timeout period elapsed prior to Finished, Stopped and Aborted state.

ExecutionStateChangeReason

enum OpenTestSystem::Otx::Runtime::Api::ExecutionStateChangeReason

strong

Reason, why a procedure execution state was changed, e.g. Paused or Running

Enumerator
Explicit	If the state was changed explicit, e.g. via Pause method
UnexpectedDiagConnectionState	If the state was changed implicit, because the DiagConnectionState is not the expected state

ExpectedState

enum OpenTestSystem::Otx::Runtime::Api::ExpectedState

strong

Contains the expected state of the diagnostic connection

Enumerator
None	The connection state will be ignored (default)
BatteryOn	The connection state is battery ON, which means KL30 is On AND KL15 will be ignored
IgnitionOff	The connection state is ignition OFF, which means KL30 is On AND KL15 is Off OR KL15 is NotAvailable
IgnitionOn	The connection state is ignition ON, which means KL30 is On AND KL15 is On

TraceLevels

enum OpenTestSystem::Otx::Runtime::Api::TraceLevels

Enumeration of TraceLevels

Enumerator
All	All messages will be logged. Please note that this may have a major influence on runtime performance.
Trace	Messages with severity TRACE or above will be logged. Severity level TRACE contains even more detailed information. Please note that this may have a major influence on runtime performance.
Debug	Messages with severity DEBUG or above will be logged. Severity level DEBUG contains detailed information on the flow through the sequence. Please note that this may have a major influence on runtime performance.
Info	Messages with severity INFO or above will be logged. Severity level INFO contains interesting runtime events.
Warn	Messages with severity WARN or above will be logged. Severity level WARN contains other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
Error	Messages with severity ERROR or above will be logged (this is the default setting). Severity level ERROR contains other runtime errors or unexpected conditions.
Fatal	Messages with severity FATAL will be logged. Severity level FATAL contains severe errors that cause premature termination.
Off	Nothing will be logged.
Off	The clamp state is OFF