spectracq3.h

Go to the documentation of this file.

#ifndef SPECTRAC3_H
#define SPECTRAC3_H
 
#include <horiba_cpp_sdk/communication/communicator.h>
#include <horiba_cpp_sdk/devices/single_devices/device.h>
 
#include <chrono>
#include <memory>
#include <nlohmann/json.hpp>
#include <string>
#include <vector>
 
namespace horiba::devices::single_devices {

class AcquisitionSetParameters final {
 public:
  explicit AcquisitionSetParameters(int scan_count,
                                    std::chrono::seconds time_step,
                                    std::chrono::seconds integration_time,
                                    int external_param)
      : _scan_count(scan_count),
        _time_step(time_step),
        _integration_time(integration_time),
        _external_param(external_param) {}

  [[nodiscard]] int scan_count() const { return _scan_count; }

  [[nodiscard]] std::chrono::seconds time_step() const { return _time_step; }

  [[nodiscard]] std::chrono::seconds integration_time() const {
    return _integration_time;
  }

  [[nodiscard]] int external_param() const { return _external_param; }
 
 private:
  int _scan_count;
  std::chrono::seconds _time_step;
  std::chrono::seconds _integration_time;
  int _external_param;
};

class SpectrAcq3 final : public Device {
 public:
  enum class TriggerMode : int {
    START_AND_INTERVAL = 1,
    TRIGGER_AND_INTERVAL = 2,
    WAIT_FOR_TRIGGER = 3,
  };

  enum class HardwareTriggerPinMode : int {
    TTL_INPUT = 0,
    EVENT_MARKER_INPUT = 1,
    HARDWARE_TRIGGER_INPUT = 2,
  };

  enum class TriggerInPolarity : int {
    ACTIVE_LOW = 0,
    ACTIVE_HIGH = 1,
  };
 
  SpectrAcq3(int id, std::shared_ptr<communication::Communicator> communicator);
  ~SpectrAcq3() override = default;

  void open() noexcept(false) override;

  void close() noexcept(false) override;

  bool is_open() noexcept(false);

  bool is_busy() noexcept(false);

  std::string get_firmware_version() noexcept(false);

  std::string get_fpga_version() noexcept(false);

  std::string get_board_revision() noexcept(false);

  std::string get_serial_number() noexcept(false);

  void set_hv_bias_voltage(int bias_voltage) noexcept(false);

  int get_hv_bias_voltage() noexcept(false);

  int get_max_hv_voltage_allowed() noexcept(false);

  void set_acquisition_set(int scan_count, int time_step, int integration_time,
                           int external_param) noexcept(false);

  AcquisitionSetParameters get_acquisition_set() noexcept(false);

  void acquisition_start(SpectrAcq3::TriggerMode trigger) noexcept(false);

  void acquisition_stop() noexcept(false);

  void acquisition_pause() noexcept(false);

  void acquisition_continue() noexcept(false);

  bool is_data_available() noexcept(false);

  nlohmann::json get_acquisition_data() noexcept(false);

  void force_trigger() noexcept(false);

  void set_in_trigger_mode(SpectrAcq3::HardwareTriggerPinMode mode) noexcept(
      false);

  std::pair<SpectrAcq3::TriggerMode, SpectrAcq3::HardwareTriggerPinMode>
  get_in_trigger_mode() noexcept(false);

  void set_trigger_in_polarity(SpectrAcq3::TriggerInPolarity polarity) noexcept(
      false);

  SpectrAcq3::TriggerInPolarity get_trigger_in_polarity() noexcept(false);
 
  std::string get_last_error() noexcept(false);
  std::string get_error_log() noexcept(false);
  void clear_error_log() noexcept(false);
};
}  // namespace horiba::devices::single_devices
#endif /* ifndef SPECTRAC3_H */