RsaInterface.h

Go to the documentation of this file.

#pragma once
#include <misc/gen/TClassRegistration.h>
#include <misc/gen/Value.h>
#include <rsa/iface/RsaTypes.h>
#include <rsa/iface/global.h>
 
namespace sf
{
 
// Forward declaration.
class PropertySheetDialog;
 
class _RSA_CLASS RsaInterface : public RsaTypes
{
  public:
    struct Parameters
    {
        explicit Parameters(int mode)
          : _mode(mode)
        {}
 
        int _mode;
    };
 
    explicit RsaInterface(const Parameters&);
 
    virtual ~RsaInterface();
 
    bool initialize();
 
    bool uninitialize();
 
    [[nodiscard]] EAcquisitionType getType() const;
 
    bool storeSettings(bool read);
 
    [[nodiscard]] int getError() const;
 
    unsigned getChannelCount();
 
    unsigned getGateCount(unsigned channel);
 
    std::string getGateName(unsigned int gate, unsigned int channel = 0);
 
    bool setPopManual(int channel, EPopManual pm);
 
    [[nodiscard]] EPopManual getPopManual(int channel) const;
 
    bool getParamInfo(IdType id, ParamInfo& info) const;
 
    bool getParam(IdType id, Value& value) const;
 
    bool setParam(IdType id, const Value& value, bool skip_event);
 
    bool paramSetGet(IdType id, Value& value, bool skip_event);
 
    virtual bool handleParam(IdType id, ParamInfo* info, const Value* setval, Value* getval) = 0;
 
    bool setParam(EDefaultParam param, unsigned gate, unsigned ch, const Value& value, bool skip_event);
 
    bool getParam(EDefaultParam param, unsigned gate, unsigned ch, Value& value) const;
 
    virtual bool setRunMode(bool on, bool clear) = 0;
 
    virtual bool getRunMode() const = 0;
 
    virtual IdType getParamId(EDefaultParam param, unsigned gate = UINT_MAX, unsigned channel = UINT_MAX) const = 0;
 
    virtual bool enumParamIds(IdList& ids) = 0;
 
    void setParamHook(NotifyProc proc, void* data);
 
    void setResultHook(NotifyProc proc, void* data);
 
    [[nodiscard]] virtual IdType getResultId(EDefaultResult result, unsigned gate = UINT_MAX, unsigned channel = UINT_MAX) const = 0;
 
    virtual bool enumResultIds(IdList& ids) = 0;
 
    bool getResultInfo(IdType id, ResultInfo& info);
 
    virtual bool handleResult(IdType id, ResultInfo* info, BufferInfo* bufInfo) = 0;
 
    bool getResultBuffer(IdType id, BufferInfo& bufInfo);
 
    [[nodiscard]] bool isInitialized() const;
 
    [[nodiscard]] std::string getProfilePath() const;
 
    virtual void addPropertyPages(PropertySheetDialog* sheet);
 
  protected:
    virtual bool doInitialize(bool init)
    {
      return true;
    }
 
    void callParamHook(IdType id);
 
    void callResultHook(IdType id);
 
    bool setType(EAcquisitionType at);
 
  private:
    // Holds the pointer to the parameter change procedure.
    NotifyProc _paramNotifyProcedure;
    // Holds the pointer to the result change procedure.
    NotifyProc _resultNotifyProcedure;
    // Holds the data set with the hook.
    void* _paramNotifyData;
    // Holds the data set with the hook.
    void* _resultNotifyData;
    // Holds flag of implementation initialization.
    bool _initialized;
    // Holds the implementation type.
    EAcquisitionType _acquisitionType;
 
    // Declarations of static functions and data members to be able to create registered RSA implementations.
    SF_DECL_IFACE(RsaInterface, RsaInterface::Parameters, Interface)
};
 
inline bool RsaInterface::isInitialized() const
{
  return _initialized;
}
 
}// namespace sf