OTX-Runtime for DotNet  
Properties | List of all members
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 or sets the directory where all temporary files which are created by the OTX-Runtime are stored. More...
 
bool Profiling = false [get, set]
 Turns profiling ON = true or OFF = false (Default: false). More...
 
int ProfilingMaxFileSize [get, set]
 Sets or gets the maximum file size of a profiler file in megabytes (Default: 50). More...
 
int TraceFileMaxCount [get, set]
 Gets or sets the maximum number of trace files. Default value: 10. More...
 
int TraceFileMaxSize [get, set]
 Gets or sets the maximum size of a trace file in Megabyte (MB). Default value: 100. More...
 
string TraceFolder [get, set]
 Gets or sets the directory where the trace files are stored. More...
 
TraceLevels TraceLevel [get, set]
 Gets or sets the 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.

See also Binary Format and Compatibility

◆ OutputFolder

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

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

Default values

  • Windows : "C:\User\[Current User]\AppData\Roaming\OpenTestSystem\OTX-Runtime API\".

Note : The folder is used to unpack and cache the loaded PTX and PPX files. This means that the loading process is significantly faster after the first time.

Note : The folder can be deleted at any time. After deletion, the OTX-Runtime should be restarted.

Important : Since each version of a PTX or PPX file is cached in the folder, the folder will grow in size. If storage space is an issue, the folder should be deleted periodically. Deletion must be done by the user.

◆ Profiling

bool OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.Profiling = false
getset

Turns profiling ON = true or OFF = false (Default: false).

If profiling is turned ON, information about the runtime execution is collected and stored in such a way that it has as little impact on the execution time as possible. The collected information is stored in the TraceFolder as profiler files in the format: "ProjectName_YYYYMMDD_hhmmss_fff[_counter].prf". The size of the profiler files can be limited via ProfilingMaxFileSize.

Note: Profiler files (*.prf) can be analysed inside the OTX development environment.

◆ ProfilingMaxFileSize

int OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.ProfilingMaxFileSize
getset

Sets or gets the maximum file size of a profiler file in megabytes (Default: 50).

This property limits the file size of the profiler files. Since the content of the files is collected in the main memory, this also limits the main memory usage. If the content exceeds the size set here, a file is written to the TraceFolder. If there are several files for the same measurement, a counter is appended to the end of the file name. Format of the file name: "ProjectName_YYYYMMDD_hhmmss_fff[_counter].prf".

◆ TraceFileMaxCount

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

Gets or sets the maximum number of trace files. Default value: 10.

Total number of trace files is TraceFileMaxCount + 1

Exceptions
Exceptions.ExceptionThrow on negative input.

◆ TraceFileMaxSize

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

Gets or sets the maximum size of a trace file in Megabyte (MB). Default value: 100.

Exceptions
Exceptions.ExceptionThrow on negative input.

◆ TraceFolder

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

Gets or sets the directory where the trace files are stored.

Default value:

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

Note : The folder is used to store all trace files. The folder can be deleted at any time. After deletion, the OTX-Runtime should be restarted.

Important : Since each execution of the OTX-Runtime can create trace files, the folder will grow in size. If storage space is an issue, the folder should be deleted periodically. Deletion must be done by the user.

◆ TraceLevel

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

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

◆ Version

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

Gets API version.

See also Binary Format and Compatibility

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