virtual_parameter.h

Go to the documentation of this file.

#pragma once
 
#include <atomic>
#include <condition_variable>
#include <cstdint>
#include <mutex>
#include <string>
 
class VirtualParameter {
 public:
  enum class Type {
    kNotDefined = 0,
    kIghOdEntry,
    kSoemOdEntry,
    kMock,
    kEthernetOdEntry
  };
 
  enum class ValueType {
    kUnspecified = 0,
    kBoolean,
    kInteger8,
    kInteger16,
    kInteger32,
    kUnsignedInteger8,
    kUnsignedInteger16,
    kUnsignedInteger32,
    kFloat,
    kString,
    kOctetString,
    kUnicodeString,
    kEnum,
    kOther
  };
 
  enum class PdoMapping { kNotPdoMapped, kRxPdoMapped, kTxPdoMapped };
 
  virtual ~VirtualParameter() = default;

  virtual Type get_parameter_type() { return Type::kNotDefined; }

  virtual uint16_t get_index() = 0;

  virtual uint8_t get_subindex() = 0;

  virtual bool is_pdo_mapped() = 0;

  virtual uint64_t get_raw_value() = 0;

  virtual uint64_t get_raw_value(bool force_refresh) = 0;

  virtual int32_t get_int_value() = 0;

  virtual int32_t get_int_value(bool force_refresh) = 0;

  virtual float get_float_value() = 0;

  virtual float get_float_value(bool force_refresh) = 0;

  virtual std::string get_string_value() = 0;

  virtual std::string get_string_value(bool force_refresh) = 0;

  virtual bool get_value_status() = 0;

  virtual int32_t set_raw_value(uint64_t value) = 0;

  virtual int32_t set_value(int32_t value) = 0;

  virtual int32_t set_value(float value) = 0;

  virtual int32_t set_value(const std::string& value) = 0;

  virtual ValueType get_value_type() = 0;

  virtual std::string get_name() = 0;

  virtual std::string get_parent_name() = 0;

  virtual bool is_read() { return true; }

  virtual bool is_write() { return true; }

  virtual std::string get_unit() { return ""; }

  virtual int32_t get_min() { return INT32_MAX; }

  virtual int32_t get_max() { return INT32_MIN; }

  virtual bool is_value_fresh() = 0;
};