InscoperAPI/API/Base/Status/StatusParam.h

Namespaces

Name
Core
Inscoper Inscoper namespace.

Classes

	Name
class	Inscoper::StatusParam StatusParam class pairs a sub-device with a value.

Source code

#ifndef STATUSPARAM_H
#define STATUSPARAM_H

#include <Base/Device/EParamType.h>
#include <Base/Device/SubDeviceId.h>
#include <Global.h>

#include <memory>
#include <string>
#include <vector>

namespace Core {
class InternalStatusParam;
}

namespace Inscoper {

class INSCOPER_EXPORT StatusParam {
public:
  StatusParam(const StatusParam &other);

  StatusParam(StatusParam &&other) noexcept;

  StatusParam &operator=(const StatusParam &other);

  StatusParam &operator=(StatusParam &&other) noexcept;

  StatusParam(const Inscoper::SubDeviceId &subDeviceId);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, const std::string &value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, unsigned char value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, char value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, unsigned short value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, short value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, unsigned int value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, int value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, unsigned long long int value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, long long int value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, float value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, double value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, bool value);

  StatusParam(const Inscoper::SubDeviceId &subDeviceId, const char *value);

  ~StatusParam();

  const Inscoper::SubDeviceId getSubDeviceId() const;

  void setSubDeviceId(const Inscoper::SubDeviceId &subDeviceId);

  bool hasValue();

  std::string getStringValue() INSCOPER_EXCEPTION;

  unsigned char getUnsignedCharValue() INSCOPER_EXCEPTION;

  char getCharValue() INSCOPER_EXCEPTION;

  unsigned short getUnsignedShortValue() INSCOPER_EXCEPTION;

  short getShortValue() INSCOPER_EXCEPTION;

  unsigned int getUnsignedIntValue() INSCOPER_EXCEPTION;

  int getIntValue() INSCOPER_EXCEPTION;

  unsigned long long int getUnsignedLongValue() INSCOPER_EXCEPTION;

  long long int getLongValue() INSCOPER_EXCEPTION;

  float getFloatValue() INSCOPER_EXCEPTION;

  double getDoubleValue() INSCOPER_EXCEPTION;

  void setValue(const std::string &value);

  void setValue(unsigned char value);

  void setValue(char value);

  void setValue(unsigned short value);

  void setValue(short value);

  void setValue(unsigned int value);

  void setValue(int value);

  void setValue(unsigned long long int value);

  void setValue(long long int value);

  void setValue(float value);

  void setValue(double value);

  void setValue(bool value);

  void setValue(const char *value);

  void addValue(unsigned short tag, const std::string &value);

  void addValue(unsigned short tag, unsigned char value);

  void addValue(unsigned short tag, char value);

  void addValue(unsigned short tag, unsigned short value);

  void addValue(unsigned short tag, short value);

  void addValue(unsigned short tag, unsigned int value);

  void addValue(unsigned short tag, int value);

  void addValue(unsigned short tag, unsigned long long int value);

  void addValue(unsigned short tag, long long int value);

  void addValue(unsigned short tag, float value);

  void addValue(unsigned short tag, double value);

  void addValue(unsigned short tag, bool value);

  void addValue(unsigned short tag, const char *value);

  void addValue(unsigned short index, unsigned short tag, const std::string &value);

  void addValue(unsigned short index, unsigned short tag, unsigned char value);

  void addValue(unsigned short index, unsigned short tag, char value);

  void addValue(unsigned short index, unsigned short tag, unsigned short value);

  void addValue(unsigned short index, unsigned short tag, short value);

  void addValue(unsigned short index, unsigned short tag, unsigned int value);

  void addValue(unsigned short index, unsigned short tag, int value);

  void addValue(unsigned short index, unsigned short tag, unsigned long long int value);

  void addValue(unsigned short index, unsigned short tag, long long int value);

  void addValue(unsigned short index, unsigned short tag, float value);

  void addValue(unsigned short index, unsigned short tag, double value);

  void addValue(unsigned short index, unsigned short tag, bool value);

  void addValue(unsigned short index, unsigned short tag, const char *value);

  INSCOPER_DEPRECATED("use 'print' instead")
  virtual std::string getType() INSCOPER_EXCEPTION;

  virtual std::string print();

  Inscoper::EParamType getValueType() INSCOPER_EXCEPTION;

  virtual std::shared_ptr<StatusParam> clone();

  virtual bool equals(const std::shared_ptr<StatusParam> &other);

  virtual std::shared_ptr<Core::InternalStatusParam> getInternal();

protected:
  std::shared_ptr<Core::InternalStatusParam> _internal;
};

typedef std::shared_ptr<StatusParam> StatusParamPtr;

} // namespace Inscoper

#endif // STATUSPARAM_H

---

Updated on 2026-09-03 at 12:14:17 +0200