optris::Sdk Class Reference

Static class granting access to SDK wide configuration and utility functions. More...

#include <Sdk.h>

Collaboration diagram for optris::Sdk:

Public Member Functions
	Sdk ()=delete
	No constructor.

Static Public Member Functions
static OTC_SDK_API void	init (Verbosity logScreen, Verbosity logFile, std::string logFilenamePrefix="")
	Initializes the SDK.
static OTC_SDK_API void	configureLogger (Verbosity logScreen, Verbosity logFile, std::string logFilenamePrefix="")
	Configures the SDK internal logger.
static OTC_SDK_API bool	setCalibrationFileSources (CalibrationFileSource first, CalibrationFileSource second, CalibrationFileSource third)
	Sets the priority of the calibration file sources.
static OTC_SDK_API bool	setCalibrationFileSourceDirectory (const std::string &sourceDirectoryPath)
	Sets the source directory from which calibration files can be copied.
static OTC_SDK_API VersionInfo	getVersionInfo ()
	Returns an object holding version and build information about the SDK.

Detailed Description

Static class granting access to SDK wide configuration and utility functions.

Member Function Documentation

configureLogger()

static OTC_SDK_API void optris::Sdk::configureLogger ( Verbosity logScreen, Verbosity logFile, std::string logFilenamePrefix = "" )

static

Configures the SDK internal logger.

If you change the logFilenamePrefix from the one used in Sdk::init() or in a previous call to Sdk::configure(), the current log file will be closed and new one will be created.

Parameters

[in]	logScreen	defines the minimum verbosity level of log messages displayed on the standard output and error.
[in]	logFile	defines the minimum verbosity level of log messages out to the logfile.
[in]	logFilenamePrefix	for the log file (logFilenamePrefix_YYYY_MM_DD-hh-mm-ss.log). If empty, it defaults to "OtcSDK".

getVersionInfo()

static OTC_SDK_API VersionInfo optris::Sdk::getVersionInfo ( )

static

Returns an object holding version and build information about the SDK.

Returns

object holding version and build information about the SDK.

init()

static OTC_SDK_API void optris::Sdk::init ( Verbosity logScreen, Verbosity logFile, std::string logFilenamePrefix = "" )

static

Initializes the SDK.

It sets the verbosity levels of the internal logger of the SDK and starts the EnumerationManager in a dedicated thread to monitor the availability of devices.

Parameters

[in]	logScreen	defines the minimum verbosity level of log messages displayed on the standard output and error.
[in]	logFile	defines the minimum verbosity level of log messages out to the logfile.
[in]	logFilenamePrefix	for the log file (logFilenamePrefix_YYYY_MM_DD-hh-mm-ss.log). If empty, it defaults to "OtcSDK".

setCalibrationFileSourceDirectory()

static OTC_SDK_API bool optris::Sdk::setCalibrationFileSourceDirectory ( const std::string & sourceDirectoryPath )

static

Sets the source directory from which calibration files can be copied.

If set to an empty string, the SDK will skip this option of acquiring calibration files.

Parameters

[in]

sourceDirectoryPath

from which calibration files can be copied.

Returns

true, if the source directory was set successfully. False, otherwise.

setCalibrationFileSources()

static OTC_SDK_API bool optris::Sdk::setCalibrationFileSources ( CalibrationFileSource first, CalibrationFileSource second, CalibrationFileSource third )

static

Sets the priority of the calibration file sources.

The priority of the sources needs to be set prior to connecting to a device. If you want to use less than three potential calibration file source, set the one you do not require to Empty. The different sources have individual requirements for them to work:

• Device. Not all types of Optris cameras have their calibration files stored on-device.
• Filesystem. The source directory should be accessible and the SDK should have the rights to copy the calibration files from it to their target destination. The source directory needs to be specified via the Sdk::setCalibrationFileSourceDirectory() method.
• Internet. Access to the internet is required.

Note

The SDK does not yet feature the ability to download the calibration from the device.

Parameters

[in]	first	source with the highest priority.
[in]	second	source with a medium priority.
[in]	third	source with the lowest priority.

Returns

true, if priority was successfully set. False, otherwise.

---

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

• Sdk.h