ScanBinder.h

Go to the documentation of this file.

#pragma once
#include "Namespace.h"
#include <gii/gen/Variable.h>
#include <gmi/iface/AxesCoord.h>
#include <ipj/iface/ProjectModule.h>
#include <ipj/iface/ProjectScriptObject.h>
#include <math/Types.h>
#include <misc/gen/IniProfile.h>
#include <rsa/iface/RsaTypes.h>
#include <string_view>
 
namespace sf
{
// Forward declarations.
class ProjectData;
class ScanEntry;
class ScanMethod;
class ProjectDataPropertyPage;
class CheckPositionsPropertyPage;
class ScanMethodPositionPropertyPage;
 
constexpr std::string_view DEFAULT_SCAN_BINDER_NAME("<default>");
constexpr std::string_view SEC_BINDER_GENERAL("Scan Binder");
constexpr std::string_view KEY_IGNORE_OFFSET("Ignore Project Offset");
 
class _IPJ_CLASS ScanBinder : public ProjectScriptObject
{
  public:
    struct _IPJ_CLASS InfoBase
    {
        InfoBase() = default;
 
        virtual ~InfoBase() = default;
 
        virtual void ReadWrite(IniProfile* ini, bool rd);
 
        bool IgnoreFixtureOffset{false};
    };
 
    struct Parameters
    {
        ProjectData* _project_data;
    };
 
    explicit ScanBinder(const Parameters& parameters);
 
    ~ScanBinder() override;
 
    /*
     * Functions for the project to control the additional data.
     */
 
    void storeConfig(bool rd);
 
    ConfigStore& getConfigStore();
 
    virtual void addPropertyPages(PropertySheetDialog* sheet);
 
    void createScanEntry(ScanEntry* se);
 
    void destroyScanEntry(const ScanEntry* se);
 
    void doAddPropertyPages(PropertySheetDialog* sheet, bool scan);
 
    QWidget* doGetFrame();
 
    void doReadProfile(IniProfile& inifile);
 
    void doWriteProfile(IniProfile& inifile);
 
    bool doPreInitialize();
 
    bool doInitialize();
 
    void doSustain(const timespec& ts);
 
    void doClear();
 
    bool doSuspend(bool immediate);
 
    bool doResume();
 
    bool doStop();
 
    bool doAbort();
 
    bool doMoveTo(int scan, int index = -1, double frac = 0.0, bool perp = false);
 
    bool doMoveToQuery(int scan);
 
    bool doMoveToSysPos(ESystemPosition sp);
 
    bool doCheck(int scan);
 
    bool doStartScan(int scan);
 
    bool doEvaluate(int scan);
 
    bool doActivate(int scan);
 
    bool doRotate(int scan, int index = -1);
 
    bool canRotate(int scan) const;
 
    bool isRotating() const;
 
    int doGetIndex() const;
 
    Vector3D doGetOffset() const;
 
    enum EState
    {
      sbsCFG_ERR = -2,
      sbsERROR = -1,
      sbsNO_INIT = 0,
      sbsABORTED,
      /*
       * Controller is freed for usage by other modules.
       */
      sbsREADY,
      sbsWAITING,
      sbsSUSPENDED,
      sbsACTIVE,
      sbsCHECKING,
      sbsSCANNING,
      sbsEVALUATING
    };
 
    static std::string_view getStateName(EState state);
    std::string_view getStateName() const;
    EState getState() const;
    const gmi::AxesCoord& getVelocity() const;
    const gmi::AxesCoord& getAcceleration() const;
    const gmi::AxesCoord& getParkPosition() const;
    const gmi::AxesCoord& getToolPosition() const;
    const Vector3D& getFixtureOffset() const;
    const Variable& getMediumVelocity() const;
    int getActiveScanIndex() const;
    double getScanProgress() const;
    bool canAllocateController() const;
    bool isControllerAllocated() const;
    bool allocateController(bool alloc);
    gmi::Controller* getController();
    const gmi::Controller* getController() const;
    void setAcqPopManual(RsaTypes::EPopManual pop_manual);
    bool isAcqPopManualReady() const;
    void setProgVelocityEnable(bool enabled);
    bool isProgVelocityEnable() const;
    const Variable::PtrVector& getVars() const;
 
  protected:
    bool getScanPos(gmi::AxesCoord& pos, int scan, int index, double frac, bool perp) const;
 
    int getScanIndex();
 
    ScanMethod* getScan(int scan) const;
 
    bool setState(EState state);
 
    InfoBase* getScanInfoBase(int scan);
 
    const InfoBase* getScanInfoBase(int scan) const;
 
    InfoBase* getScanInfoBase(const ScanMethod* sm);
 
    const InfoBase* getScanInfoBase(const ScanMethod* sm) const;
 
    virtual InfoBase* createScanInfo() = 0;
 
    virtual void stateChange(EState prev, EState cur) = 0;
 
    virtual void addPropertyPages(PropertySheetDialog* sheet, bool scan) = 0;
 
    virtual void readProfile(IniProfile& inifile) = 0;
 
    virtual void writeProfile(IniProfile& inifile) = 0;
 
    virtual int getIndex() = 0;
 
    virtual void clear() = 0;
 
    virtual void sustain(const timespec& ts) = 0;
 
    virtual bool initialize() = 0;
 
    virtual bool suspend(bool immediate) = 0;
 
    virtual bool resume() = 0;
 
    virtual bool stop() = 0;
 
    virtual bool abort() = 0;
 
    virtual bool moveTo(int scan, int index, double frac, bool perp) = 0;
 
    virtual bool check(int scan) = 0;
 
    virtual bool startScan(int scan) = 0;
 
    virtual bool evaluate(int scan) = 0;
 
    virtual bool activate(int scan) = 0;
 
    virtual bool rotate(int scan, int index) = 0;
 
    virtual QWidget* GetFrame() = 0;
 
    virtual Vector3D getOffset() const;
 
    virtual bool getGenericInfoList(StringList&) = 0;
 
    ProjectData* getProjectData();
 
    const IdInfo* getInfo(const std::string& name) const override;
 
    bool getSetValue(const IdInfo* info, Value* value, Value::vector_type* params, bool flag_set) override;
 
    virtual void doStoreConfig(IniEnvelope& ini, bool rd) {}
 
  private:
    void SetStatePrivate(EState state);
 
    void VarEvent(Variable::EEvent event, const Variable&, Variable& link, bool same_inst);
 
    void HandleParamMappingApply(QWidget*);
 
    bool _controllerAllocated;
    bool _rotating;
    bool _programmingVelocity;
    ProjectData* _projectData;
    std::string _namePrefix;
    const EState _state;
    gmi::AxesCoord _failCoord;
    gmi::AxesCoord _velocity;
    gmi::AxesCoord _progVelocity;
    gmi::AxesCoord _acceleration;
    gmi::AxesCoord _parkPosition;
    gmi::AxesCoord _toolPosition;
    Vector3D _fixtureOffset;
    int _activeScanIndex;
    Variable::PtrVector _localVars;
    ConfigStore _configStore;
    LocalVariable vProgress;
    LocalVariable vMediumVelocity;
    TVariableHandler<ScanBinder> _variableHandler;
 
    friend ScanMethod;
    friend ScanMethodPositionPropertyPage;
    friend ProjectDataPropertyPage;
    friend CheckPositionsPropertyPage;
 
    SF_DECL_IFACE(ScanBinder, ScanBinder::Parameters, Interface)
};
 
}// namespace sf