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

Public Member Functions
String	GetMinBinVersion ()
	Gets minimum version of the binary file that the OTX Runtime can handle. More...

String	GetOutputFolder ()
	Gets directory where all temporary files which are created by the OTX-Runtime are stored. More...

boolean	GetProfiling ()
	Gets profiling value (Default: false). More...

int	GetProfilingMaxFileSize ()
	Gets the maximum file size of a profiler file in megabytes (Default: 50). More...

int	GetTraceFileMaxCount ()
	Gets max number of trace files. More...

int	GetTraceFileMaxSize ()
	Gets max size of a trace file in Megabyte (MB). More...

String	GetTraceFolder ()
	Gets directory where the trace files are stored. More...

TraceLevels	GetTraceLevel ()
	Gets OTX-Runtime Tracing Level. More...

String	GetVersion ()
	Gets API version. More...

boolean	SetOutputFolder (final String outputFolder)
	Sets directory where all temporary files which are created by the OTX-Runtime are stored. More...

void	SetProfiling (final boolean value)
	Turns profiling ON = true or OFF = false (Default: false). More...

void	SetProfilingMaxFileSize (final int value)
	Sets the maximum file size of a profiler file in megabytes (Default: 50). More...

boolean	SetTraceFileMaxCount (final int traceFileMaxCount)
	Sets max number of backup trace files. More...

boolean	SetTraceFileMaxSize (final int traceFileMaxSize)
	Sets max size of a trace file in Megabyte (MB). More...

boolean	SetTraceFolder (String traceFolder)
	Sets directory where the trace files are stored. More...

boolean	SetTraceLevel (TraceLevels traceLevel)
	Sets OTX-Runtime Tracing Level. More...

Static Public Member Functions
static RuntimeConfig	GetInstance ()
	Get RuntimeConfig Instance. More...

Detailed Description

Configuration class to modify OTX Runtime API global settings.

Member Function Documentation

◆ GetInstance()

static RuntimeConfig OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.GetInstance ( )

inlinestatic

Get RuntimeConfig Instance.

Returns: RuntimeConfig instance

◆ GetMinBinVersion()

String OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.GetMinBinVersion ( )

inline

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

Returns: Version.

◆ GetOutputFolder()

String OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.GetOutputFolder ( )

inline

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

Default value:

Windows : "C:\User\[Current User]\AppData\Roaming\OpenTestSystem\[API Short Version]\OTX-Runtime API\".
Linux : "[home]/OpenTestSystem/[API Short Version]/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.

Returns: A directory.

◆ GetProfiling()

boolean OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.GetProfiling ( )

inline

Gets profiling value (Default: false).

Returns: profiling value.

◆ GetProfilingMaxFileSize()

int OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.GetProfilingMaxFileSize ( )

inline

Gets the maximum file size of a profiler file in megabytes (Default: 50).

Returns: Size in megabytes.

◆ GetTraceFileMaxCount()

int OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.GetTraceFileMaxCount ( )

inline

Gets max number of trace files.

Default value: 10.

Returns: Trace file max count

◆ GetTraceFileMaxSize()

int OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.GetTraceFileMaxSize ( )

inline

Gets max size of a trace file in Megabyte (MB).

Default value: 100.

Returns: Trace file max size.

◆ GetTraceFolder()

String OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.GetTraceFolder ( )

inline

Gets 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.

Returns: A directory.

◆ GetTraceLevel()

TraceLevels OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.GetTraceLevel ( )

inline

Gets OTX-Runtime Tracing Level.

The Tracing is the internal logging of the API. Default value: ERROR.

Returns: A TraceLevel.

◆ GetVersion()

String OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.GetVersion ( )

inline

Gets API version.

Returns: Version.

◆ SetOutputFolder()

boolean OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.SetOutputFolder ( final String outputFolder )

inline

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/".

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.

Parameters

outputFolder A directory.

Returns: true.

◆ SetProfiling()

void OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.SetProfiling ( final boolean value )

inline

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.

Parameters

value True is ON. False is OFF.

◆ SetProfilingMaxFileSize()

void OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.SetProfilingMaxFileSize ( final int value )

inline

Sets 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".

Parameters

value Size in megabytes.

◆ SetTraceFileMaxCount()

boolean OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.SetTraceFileMaxCount ( final int traceFileMaxCount )

inline

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.

Returns: true

Exceptions

java.lang.RuntimeException Throw on negative input.

◆ SetTraceFileMaxSize()

boolean OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.SetTraceFileMaxSize ( final int traceFileMaxSize )

inline

Sets max size of a trace file in Megabyte (MB).

Default value: 100.

Parameters

traceFileMaxSize Max size of a trace file.

Returns: true

Exceptions

java.lang.RuntimeException Throw on negative input.

◆ SetTraceFolder()

boolean OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.SetTraceFolder ( String traceFolder )

inline

Sets 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.

Parameters

traceFolder A directory.

Returns: true

◆ SetTraceLevel()

boolean OpenTestSystem.Otx.Runtime.Api.RuntimeConfig.SetTraceLevel ( TraceLevels traceLevel )

inline

Sets OTX-Runtime Tracing Level.

The Tracing is the internal logging of the API. Default value: ERROR.

Parameters

traceLevel A TraceLevel.

Returns: true

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

RuntimeConfig.java

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetInstance()

◆ GetMinBinVersion()

◆ GetOutputFolder()

◆ GetProfiling()

◆ GetProfilingMaxFileSize()

◆ GetTraceFileMaxCount()

◆ GetTraceFileMaxSize()

◆ GetTraceFolder()

◆ GetTraceLevel()

◆ GetVersion()

◆ SetOutputFolder()

◆ SetProfiling()

◆ SetProfilingMaxFileSize()

◆ SetTraceFileMaxCount()

◆ SetTraceFileMaxSize()

◆ SetTraceFolder()

◆ SetTraceLevel()