OpenTestSystem.Otx.Runtime.Api.RuntimeConfig Class Reference

Configuration class to modify OTX Runtime API global settings More...

Properties
static RuntimeConfig	Instance = new RuntimeConfig() [get]
	Get RuntimeConfig Instance More...
string	MinBinVersion [get]
	Gets minimum version of the binary file that the OTX Runtime can handle. More...
string	OutputFolder = ApiConstants.OTX_RUNTIME_API_FOLDER [get, set]
	Gets directory where all temporary files which are created by the OTX-Runtime are stored. More...
int	TraceFileMaxCount [get, set]
	Gets max number of trace files. Default value: 10. More...
int	TraceFileMaxSize [get, set]
	Gets max size of a trace file in Megabyte (MB). Default value: 100. More...
string	TraceFolder [get, set]
	Gets directory where the trace files are stored. More...
TraceLevels	TraceLevel [get, set]
	Gets OTX-Runtime Tracing Level. The Tracing is the internal logging of the API. Default value: ERROR. More...
string	Version [get]
	Gets API version. More...

Detailed Description

Configuration class to modify OTX Runtime API global settings

Property Documentation

Instance

RuntimeConfig OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.Instance = new RuntimeConfig()

staticget

Get RuntimeConfig Instance

MinBinVersion

string OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.MinBinVersion

get

Gets minimum version of the binary file that the OTX Runtime can handle.

OutputFolder

string OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.OutputFolder = ApiConstants.OTX_RUNTIME_API_FOLDER

getset

Gets directory where all temporary files which are created by the OTX-Runtime are stored.

Default value:
Window : "C:\User\[Current User]\AppData\Roaming\OpenTestSystem\OTX-Runtime API\".
Linux : "[home]/OpenTestSystem/OTX-Runtime API/".

Returns

A directory.

Sets directory where all temporary files which are created by the OTX-Runtime are stored.

Default value:
Window : "C:\User\[Current User]\AppData\Roaming\OpenTestSystem\[API Short Version]\OTX-Runtime API\".
Linux : "[home]/OpenTestSystem/[API Short Version]/OTX-Runtime API/".

Parameters

path	A directory.

TraceFileMaxCount

int OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.TraceFileMaxCount

getset

Gets max number of trace files. Default value: 10.

Returns

Trace file max count.

Sets max number of backup trace files. Default value: 10. Total number of trace files is TraceFileMaxCount + 1

Parameters

traceFileMaxCount

Max number of trace files.

Exceptions

Exceptions.Exception

Throw on negative input.

TraceFileMaxSize

int OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.TraceFileMaxSize

getset

Gets max size of a trace file in Megabyte (MB). Default value: 100.

Returns

Trace file max size.

Sets max size of a trace file in Megabyte (MB). Default value: 100.

Parameters

traceFileMaxSize

Max size of a trace file.

Exceptions

Exceptions.Exception

Throw on negative input.

TraceFolder

string OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.TraceFolder

getset

Gets directory where the trace files are stored.

Default value:
Window : "C:\User\[Current User]\AppData\Roaming\OpenTestSystem\[API Short Version]\OTX-Runtime API\Logging\".
Linux : "[home]/OpenTestSystem/[API Short Version]/OTX-Runtime API/Logging/".

Returns

A directory.

Sets directory where the trace files are stored.

Default value:
Window : "C:\User\[Current User]\AppData\Roaming\OpenTestSystem\[API Short Version]\OTX-Runtime API\Logging\".
Linux : "[home]/OpenTestSystem/[API Short Version]/OTX-Runtime API/Logging/".

Parameters

path	A directory.

TraceLevel

TraceLevels OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.TraceLevel

getset

Gets OTX-Runtime Tracing Level. The Tracing is the internal logging of the API. Default value: ERROR.

Returns

A TraceLevel.

Sets OTX-Runtime Tracing Level. The Tracing is the internal logging of the API. Default value: ERROR.

Parameters

traceLevel

A TraceLevel.

Version

string OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.Version

get

Gets API version.

---

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

• RuntimeConfig.cs