![]() |
OTX-Runtime for C++
|
|
Configuration class to modify OTX Runtime API global settings More...
#include <RuntimeConfig.h>
Public Member Functions | |
std::string | GetMinBinVersion () const |
Gets minimum version of the binary file that the OTX Runtime can handle. More... | |
std::string | GetOutputFolder () const |
Gets directory where all temporary files which are created by the OTX-Runtime are stored. More... | |
bool | GetProfiling () |
Gets performance profiling value (Default: false). More... | |
int | GetProfilingMaxFileSize () |
Gets the maximum file size of a profiler file in megabytes (Default: 50). More... | |
int | GetTraceFileMaxCount () const |
Gets max number of trace files. Default value: 10. More... | |
int | GetTraceFileMaxSize () const |
Gets max size of a trace file in Megabyte (MB). Default value: 100. More... | |
std::string | GetTraceFolder () const |
Gets directory where the trace files are stored. More... | |
TraceLevels | GetTraceLevel () const |
Gets OTX-Runtime Tracing Level. The Tracing is the internal logging of the API. Default value: ERROR. More... | |
std::string | GetVersion () const |
Gets API version. More... | |
bool | SetOutputFolder (const std::string &path) |
Sets directory where all temporary files which are created by the OTX-Runtime are stored. More... | |
void | SetProfiling (bool value) |
Turns profiling ON = true or OFF = false (Default: false). More... | |
void | SetProfilingMaxFileSize (int value) |
Sets the maximum file size of a profiler file in megabytes (Default: 50). More... | |
bool | SetTraceFileMaxCount (const int traceFileMaxCount) |
Sets max number of backup trace files. Default value: 10. Total number of trace files is TraceFileMaxCount + 1 More... | |
bool | SetTraceFileMaxSize (const int traceFileMaxSize) |
Sets max size of a trace file in Megabyte (MB). Default value: 100. More... | |
bool | SetTraceFolder (const std::string &path) |
Sets directory where the trace files are stored. More... | |
bool | SetTraceLevel (const TraceLevels traceLevel) |
Sets OTX-Runtime Tracing Level. The Tracing is the internal logging of the API. Default value: ERROR. More... | |
Static Public Member Functions | |
static RuntimeConfig & | GetInstance () |
Get RuntimeConfig Instance More... | |
Configuration class to modify OTX Runtime API global settings
|
static |
Get RuntimeConfig Instance
std::string OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::GetMinBinVersion | ( | ) | const |
Gets minimum version of the binary file that the OTX Runtime can handle.
See also Binary Format and Compatibility
std::string OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::GetOutputFolder | ( | ) | const |
Gets directory where all temporary files which are created by the OTX-Runtime are stored.
Default value:
"C:\User\[Current User]\AppData\Roaming\OpenTestSystem\[API Short Version]\OTX-Runtime API\"
."[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.
bool OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::GetProfiling | ( | ) |
Gets performance profiling value (Default: false).
int OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::GetProfilingMaxFileSize | ( | ) |
Gets the maximum file size of a profiler file in megabytes (Default: 50).
int OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::GetTraceFileMaxCount | ( | ) | const |
Gets max number of trace files. Default value: 10.
int OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::GetTraceFileMaxSize | ( | ) | const |
Gets max size of a trace file in Megabyte (MB). Default value: 100.
std::string OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::GetTraceFolder | ( | ) | const |
Gets directory where the trace files are stored.
Default value:
"C:\User\[Current User]\AppData\Roaming\OpenTestSystem\[API Short Version]\OTX-Runtime API\Logging\"
."[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.
TraceLevels OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::GetTraceLevel | ( | ) | const |
Gets OTX-Runtime Tracing Level. The Tracing is the internal logging of the API. Default value: ERROR.
std::string OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::GetVersion | ( | ) | const |
bool OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::SetOutputFolder | ( | const std::string & | path | ) |
Sets directory where all temporary files which are created by the OTX-Runtime are stored.
Default value:
"C:\User\[Current User]\AppData\Roaming\OpenTestSystem\[API Short Version]\OTX-Runtime API\"
."[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.
path | A directory. |
void OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::SetProfiling | ( | bool | value | ) |
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.
value | True is ON and False is OFF. |
void OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::SetProfilingMaxFileSize | ( | int | value | ) |
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"
.
value | Size in megabytes. |
bool OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::SetTraceFileMaxCount | ( | const int | traceFileMaxCount | ) |
Sets max number of backup trace files. Default value: 10. Total number of trace files is TraceFileMaxCount + 1
traceFileMaxCount | Max number of trace files. |
std::runtime_error | Throw on negative input. |
bool OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::SetTraceFileMaxSize | ( | const int | traceFileMaxSize | ) |
Sets max size of a trace file in Megabyte (MB). Default value: 100.
traceFileMaxSize | Max size of a trace file. |
runtime_error | Throw on negative input. |
bool OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::SetTraceFolder | ( | const std::string & | path | ) |
Sets directory where the trace files are stored.
Default value:
"C:\User\[Current User]\AppData\Roaming\OpenTestSystem\[API Short Version]\OTX-Runtime API\Logging\"
."[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.
path | A directory. |
bool OpenTestSystem::Otx::Runtime::Api::RuntimeConfig::SetTraceLevel | ( | const TraceLevels | traceLevel | ) |
Sets OTX-Runtime Tracing Level. The Tracing is the internal logging of the API. Default value: ERROR.
traceLevel | A TraceLevel. |