Contains information of a Runner instance. More...

Inherited by OpenTestSystem.Otx.Runtime.Api.RuntimeContextBase.

Public Member Functions
void	Continue ()
	An explicit paused runtime context (not implicit) continues its execution with the next activity. More...

void	Pause ()
	The runtime context pause its execution. This means that all executing procedures will execute their current atomic node and then pause the execution until it is continued or stopped. More...

void	Stop ()
	Stops current execution. More...

Properties
ExecutionState	ExecutionState `[get]`
	Gets the execution state of the runtime context. More...

long	ExecutionTime `[get]`
	Get the total time of procedure execution in milliseconds. The value is the time where the procedure execution is inside @ ExecutionState.Running . The time inside other states e.g. @ ExecutionState.Paused @ shall not be counted. Getting the value shall deliver the current value. More...

bool	HasOtxException `[get]`
	Checks if the execution was terminated by an OTX Exception More...

bool	HasRuntimeException `[get]`
	Checks if the execution was terminated by an runtime Exception. The Exception can be an OTX Exception or an Exception thrown by a bug. More...

string	Name `[get]`
	Gets name of RuntimeContext. More...

Exceptions.OtxException	OtxException `[get]`
	Gets an OTX exception which is not handled inside OTX execution. More...

IProcedure	Procedure `[get]`
	Gets Procedure which created this RuntimeContext by starting an execution. More...

long	ProcessId `[get]`
	Get the process Id of the runner process. The PID will only delivered if the @ ExecutionState @ is @ Running @ or @ Paused . In all other @ ExecutionState @ s -1 is returned. More...

long	ProcessMemory `[get]`
	Get the number of private bytes of the runner process. The value will be calculated inside the runner at the time the property is read. After the procedure execution is finished the value contains the number of private bytes direct before the ProcedureFinished event. More...

Exception	RuntimeException `[get]`
	Gets an runtime exception which was thrown by OTX-Runtime due to a bug. More...

long	RuntimeId `[get]`
	Gets an unique id of the procedure execution context. More...

Detailed Description

Contains information of a Runner instance.

For each executed procedure a new Runner instance will be started and after finishing the execution the Runner instance will be deleted. A Runner can be executed inside an own process or inside the process of the application, see RuntimeManagerFactory. A RuntimeContext represents a Runner instance. It is unique and will be created at procedure execution, see Execute.

The RuntimeContext represents a project, see Project. The project can get via Procedure, Document and Package. Please note, that a player project can contain more than one project, see PlayerProject and each of this projects can have different project settings, see ProjectSettings.

Member Function Documentation

◆ Continue()

void OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.Continue ( )

An explicit paused runtime context (not implicit) continues its execution with the next activity.

Exceptions

Exceptions.RuntimeException Throws a RuntimeException if the runtime context cannot be continued.

◆ Pause()

void OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.Pause ( )

The runtime context pause its execution. This means that all executing procedures will execute their current atomic node and then pause the execution until it is continued or stopped.

Exceptions

Exceptions.RuntimeException Throws a RuntimeException if the runtime context cannot be paused.

◆ Stop()

void OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.Stop ( )

Stops current execution.

Property Documentation

◆ ExecutionState

ExecutionState OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.ExecutionState

get

Gets the execution state of the runtime context.

◆ ExecutionTime

long OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.ExecutionTime

get

Get the total time of procedure execution in milliseconds. The value is the time where the procedure execution is inside @ ExecutionState.Running . The time inside other states e.g. @ ExecutionState.Paused @ shall not be counted. Getting the value shall deliver the current value.

◆ HasOtxException

bool OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.HasOtxException

get

Checks if the execution was terminated by an OTX Exception

◆ HasRuntimeException

bool OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.HasRuntimeException

get

Checks if the execution was terminated by an runtime Exception. The Exception can be an OTX Exception or an Exception thrown by a bug.

◆ Name

string OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.Name

get

Gets name of RuntimeContext.

The name can be used to better distinguish the different OTX runners and/or clients of DiagManager inside the trace files. It can be set via the Execute method.

◆ OtxException

Exceptions.OtxException OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.OtxException

get

Gets an OTX exception which is not handled inside OTX execution.

◆ Procedure

IProcedure OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.Procedure

get

Gets Procedure which created this RuntimeContext by starting an execution.

◆ ProcessId

long OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.ProcessId

get

Get the process Id of the runner process. The PID will only delivered if the @ ExecutionState @ is @ Running @ or @ Paused . In all other @ ExecutionState @ s -1 is returned.

◆ ProcessMemory

long OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.ProcessMemory

get

Get the number of private bytes of the runner process. The value will be calculated inside the runner at the time the property is read. After the procedure execution is finished the value contains the number of private bytes direct before the ProcedureFinished event.

◆ RuntimeException

Exception OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.RuntimeException

get

Gets an runtime exception which was thrown by OTX-Runtime due to a bug.

◆ RuntimeId

long OpenTestSystem.Otx.Runtime.Api.IRuntimeContext.RuntimeId

get

Gets an unique id of the procedure execution context.

The documentation for this interface was generated from the following file:

IRuntimeContext.cs

Public Member Functions

Properties