Sdk.h

Go to the documentation of this file.

// Copyright (c) 2008-2026 Optris GmbH & Co. KG

 
#pragma once
 
#include <array>
#include <cstdint>
#include <string>
#include <vector>
 
#include "otcsdk/Api.h"
#include "otcsdk/common/VersionInfo.h"
 

namespace optris
{

enum class Verbosity 
{ 
  Off     = 1,  
  Error   = 2,  
  Warning = 3,  
  Info    = 4,  
  Debug   = 5,  
};

enum class CalibrationFileSource
{
  Device,      
  Filesystem,  
  Internet,    
  Empty,       
};
 

class Sdk
{
public:
  Sdk() = delete;
 

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

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

  using LogCallback = void(OTC_SDK_C_CALL*)(int verbosityLevel, const char* message);

  OTC_SDK_API static void setLogCallback(LogCallback callback, bool exclusive = false);
 

  OTC_SDK_API static void setCustomDataDirectory(const std::string& customDataDirectory);

  OTC_SDK_API static void clearCustomDataDirectory();

  OTC_SDK_API static bool setCalibrationFileSources(CalibrationFileSource first, CalibrationFileSource second, CalibrationFileSource third);

  OTC_SDK_API static void setCalibrationFileSourceDirectory(const std::string& sourceDirectory);

  OTC_SDK_API static void clearCalibrationFileSourceDirectory();

  OTC_SDK_API static VersionInfo getVersionInfo();
 

  OTC_SDK_API static void loadPalettes();

  OTC_SDK_API static void loadPalettes(const std::string& directory);

  OTC_SDK_API static std::vector<std::string> getPaletteNames();

  OTC_SDK_API static std::vector<std::array<uint8_t, 3>> getPaletteColors(const std::string& name);

  OTC_SDK_API static void registerPalette(const std::string&                          name,
                                          const std::vector<std::array<uint8_t, 3>>& colors);

  OTC_SDK_API static void savePalette(const std::string& name);
};
 
} // namespace optris