Skip to content

InscoperAPI/API/Base/Description/ParamDescription.h

Namespaces

Name
Inscoper
Inscoper namespace.

Classes

Name
class Inscoper::ParamDescription
ParamDescription class provides parameter information coming from drivers.

Source code

#ifndef PARAMDESCRIPTION_H
#define PARAMDESCRIPTION_H

#include <Base/Device/EParamType.h>
#include <Base/Diag/Constraint.h>
#include <Global.h>

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

namespace Inscoper {

class INSCOPER_EXPORT ParamDescription {
public:
#ifndef SWIG
  ParamDescription(ParamDescription const &) = delete;
  ParamDescription(ParamDescription &&) = delete;
  ParamDescription &operator=(ParamDescription const &) = delete;
  ParamDescription &operator=(ParamDescription &&) = delete;
#endif

  ParamDescription() = default;

  virtual ~ParamDescription() = default;

  virtual unsigned short getTag() const = 0;

  virtual const std::string &getName() const = 0;

  virtual const std::string &getDescription() const = 0;

  virtual Inscoper::EParamType getType() const = 0;

  virtual Inscoper::ConstraintPtr getConstraint() = 0;
};

typedef std::shared_ptr<ParamDescription> ParamDescriptionPtr;

} // namespace Inscoper

#endif // PARAMDESCRIPTION_H

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