ScanMethod.h

Go to the documentation of this file.

#pragma once
#include "ProjectScriptObject.h"
#include <gii/gen/InformationServer.h>
#include <gii/gen/ResultData.h>
#include <gii/gen/Variable.h>
#include <gmi/iface/AxesCoord.h>
#include <gmi/iface/Controller.h>
#include <ipj/iface/Namespace.h>
#include <ipj/iface/ScanBinder.h>
#include <math/Types.h>
#include <misc/qt/ConfigStore.h>
 
namespace sf
{
 
// Forward definitions.
class ProjectData;
class CalibrationSet;
class ProjectAnalysisPropertyPage;
class ParamMappingPropertyPage;
class ScanMethodPositionPropertyPage;
class ScanMethodCalibrationPropertyPage;
class ScanMethodAcquisitionPropertyPage;
class ScanDirectivePropertyPage;
class ClusterList;
 
class _IPJ_CLASS ScanMethod : public ProjectScriptObject
{
  public:
    struct Parameters
    {
        Parameters(ProjectData* prj_data, const QString& method, const QString& area)
          : _projectData(prj_data)
          , _methodName(method)
          , _areaName(area)
        {}
 
        ProjectData* _projectData;
        QString _methodName;
        QString _areaName;
    };
 
    explicit ScanMethod(const Parameters&);
 
    ~ScanMethod() override;
 
    enum EDefaultParamIndex
    {
      dpiINDEXCOUNT = 0,
      dpiINDEXDENS = 1,
      dpiSCANDENS = 2,
      dpiSCANLEN = 3,
      dpiDENSMODE = 4,
      dpiANGLE_A = 5,
      dpiANGLE_B = 6,
      dpiSURFACEANGLE_A = 7,
      dpiSURFACEANGLE_B = 8,
      dpiGATEMODE = 10,
      dpiDEPTH = 23,
      dpiDEPTHFACTOR = 24,
      dpiLAST = 0x100,
    };
 
    void SetAreaName(const QString& name);
 
    QString GetAreaName() const;
 
    bool DoInitialize();
 
    // Function called before a scan method is deleted.
    virtual void DestroyFrame();
 
    // Returns a stream to print error or no error information to std::cout.
    virtual std::ostream& Cout();
 
    enum ECommand
    {
      smcINIT,
      smcACTIVATE,
      smcDEACTIVATE,
      smcCHECK,
      smcSCAN,
      smcEVALUATE,
      smcSTOP,
      smcOFFSETCHANGE,
    };
 
    bool Execute(ECommand cmd);
 
    ECommand GetCommand();
 
    void DoAddPropertyPages(PropertySheetDialog* sheet);
 
    void SetIndexFracRange(double start, double stop);
 
    int GetIndexCount() const;
 
    int GetIndexStart() const;
 
    int GetIndexStop() const;
 
    int GetScanListIndex() const;
 
    bool Reinitialize();
 
    void DoRead(IniEnvelope ini);
 
    void DoWrite(IniEnvelope ini);
 
    void LoadSystemSettings();
 
    bool SaveSystemSettings();
 
    bool IsActivated() const;
 
    bool DoSustain(const timespec&);
 
    bool DoCreateFrame();
 
    bool DoConvertPosition(gmi::AxesCoord& dest, const gmi::AxesCoord& src, bool to_focus) const;
 
    bool DoGetIndexPos(gmi::AxesCoord& pos, int index, double frac, bool rect) const;
 
    bool DoGetFocusPos(gmi::AxesCoord& dest, int index, double frac) const;
 
    bool DoGetIndexVel(gmi::AxesCoord& dest, int index) const;
 
    bool DoGetMeasureOffset(Vector3D& vector, int index, double frac, bool rect) const;
 
    bool DoSetAcqParams(int index, double frac);
 
    bool DoGetTriggerValue(gmi::AxisValue& value) const;
 
    gmi::EAxisLocation DoGetScanAxis() const;
 
    bool GetScanStart(gmi::AxesCoord& ac) const;
 
    bool GetScanStop(gmi::AxesCoord& ac) const;
 
    const gmi::AxesCoord& GetScanVelocity() const;
 
    const gmi::AxesCoord& GetScanAcceleration() const;
 
    const ScanBinder::InfoBase* GetScanInfo() const;
 
    const Vector3D& GetScanOffset() const;
 
    Vector3D GetOffset() const;
 
    const Variable& GetMediumVelocity() const;
 
    const Variable& GetMaterialVelocity() const;
 
    bool GetRefractionAngle(double& dest, double src, bool to_medium = true);
 
    TDataFilterLinks& GetFilterLinks();
 
    bool ExecuteFilters(TDataFilterEntry::EAction action = TDataFilterEntry::feaSTART);
 
    const std::vector<int>& GetUsedDevices() const;
 
    bool IsCalibReady();
 
    void SetAcqState(InformationServer::EState sel_state, InformationServer::EState unsel_state = InformationServer::issOff);
 
    enum EState
    {
      smsCFGERR = -2,
      smsERROR = -1,
      smsNOINIT = 0,
      smsREADY,
      smsACTIVE,
      smsCHECKING,
      smsSCANNING,
      smsEVALUATING,
      smsLASTENTRY
    };
 
    EState GetState() const;
 
    virtual void HandleCursorEvent(bool btn_down, Qt::KeyboardModifiers shift, int index, double frac) {}
 
    static const char* GetStateName(EState);
 
    static const char* GetCommandName(ECommand);
 
    ProjectData* GetProjectData();
 
    QString GetMethodName() const;
 
    QString GetDirectiveText() const;
 
    bool GetDirectiveEnabled() const;
 
    ESystemPosition GetDirectivePosition();
 
    QString GetElementName();
 
    QString GetToolName();
 
    QString GetMaterialName();
 
    QString GetSettingsName() const;
 
    std::string GetNamePrefix() const;
 
    ECalibrationType GetCalibrationType();
 
    QString GetCalibrationSetName() const;
 
    InformationTypes::IdVector& GetCalibrationIds();
 
    std::string GetFilterConfigs();
    //
    Variable::PtrVector& GetLocalVars();
 
    QWidget* GetFrame();
 
  protected:
    ConfigStore& GetSaveState();
 
    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 bool CreateFrame();
 
    virtual bool ConvertPosition(gmi::AxesCoord& dest, const gmi::AxesCoord& src, bool to_focus) const = 0;
 
    virtual ScriptLink* GetScriptLink();
 
    virtual void StateChange(EState prev, EState cur) = 0;
 
    virtual bool Initialize() = 0;
 
    virtual void Read(IniProfile* inifile) = 0;
 
    virtual void Write(IniProfile* inifile) = 0;
 
    virtual bool GetGenericInfoList(StringList&) = 0;
 
    virtual bool Sustain(const timespec& ts);
 
    virtual bool HandleCommand(ECommand cmd) = 0;
 
    virtual bool GetIndexPos(gmi::AxesCoord& pos, int index, double frac, bool rect) = 0;
 
    virtual bool GetFocusPos(gmi::AxesCoord& dest, int index, double frac) = 0;
 
    virtual bool GetIndexVel(gmi::AxesCoord& dest, int index) = 0;
 
    virtual bool GetTriggerValue(gmi::AxisValue& value) = 0;
 
    virtual gmi::EAxisLocation GetScanAxis() = 0;
 
    virtual bool SetAcqParams(int index, double frac) = 0;
 
    virtual void AddPropertyPages(PropertySheetDialog* sheet);
 
    virtual bool GetMeasureOffset(Vector3D& vector, int index, double frac, bool rect);
 
    bool FilterHandler(TDataFilterLink*, EFilterNotifyCode fnc);
 
    // Refills the positions result.
    bool UpdatePositionsData();
 
    // Returns true if the state was successfully set.
    bool SetState(EState state);
    // This function is called by a derived class to set its frame pointer.
    void SetFrame(QWidget* frame);
    // Returns the allocated controller.
    gmi::Controller* GetController();
    // Clips a trigger value to a value which is allowed by the controller.
    // Is to be used by property pages to fill in the correct values.
    bool ClipTriggerValue(gmi::AxisValue& trigger_value);
    // A derived classes uses this function to set the index count for the scan method initialization.
    void SetIndexCount(int idx_count);
    // Returns Offset used to create the local ID's with for exporting.
    InformationTypes::id_type GetIdOffset();
 
  private:
    void localVarEvent(Variable::EEvent event, const Variable& caller, Variable& link, bool same_inst);
 
    bool LoadVariableSettingsHandler(long vid, Value& value);
    // Handles an apply of ID mapping changes.
    void HandleParamMappingApply(QObject*);
 
    void ReadWriteConfig(bool rd);
 
    void SetStatePriv(EState state);
 
    ConfigStore FSaveState;
    gmi::AxesCoord FScanStart;
    gmi::AxesCoord FScanStop;
    Vector3D FScanOffset;
    const EState FState;
    ECommand FCommand;
    ProjectData* FProjectData;
    QWidget* FFrame;
    QString FMethodName;
    std::string FNamePrefix;
    int FScanIndexCount;
    bool FActive;
    bool FSustainSentry;
    QString FElement;
    QString FTool;
    QString FSettings;
    QString FDirectiveText;
    bool FDirectiveEnabled;
    ESystemPosition FDirectivePosition;
    TDataFilterLinks FFilterLinks;
    std::string FFilterConfigs;
    ClusterList* FClusterList;
    ResultData RPositions;
    LocalVariable VPart;
    LocalVariable VToolName;
    LocalVariable VToolSerial;
    LocalVariable VElementName;
    LocalVariable VElementSerial;
    LocalVariable VMaterialName;
    LocalVariable VMaterialVelocity;
    LocalVariable VVelocityMode;
    LocalVariable VSettings;
    LocalVariable VArea;
    LocalVariable VMethod;
    LocalVariable VCalibType;
    LocalVariable VCalibSet;
    LocalVariable VState;
    LocalVariable VIndexCount;
    LocalVariable VFracStart;
    LocalVariable VFracStop;
    LocalVariable VScanIndex;
    Variable::PtrVector FLocalVars;
    InformationTypes::IdVector FCalibrationIds;
    const CalibrationSet* FCalibSet;
    TVector<int> FUsedDevices;
    TVariableHandler<ScanMethod> _varHandler;
 
    friend ScanMethodPositionPropertyPage;
    friend ParamMappingPropertyPage;
    friend ProjectAnalysisPropertyPage;
    friend ScanMethodCalibrationPropertyPage;
    friend ScanMethodAcquisitionPropertyPage;
    friend ScanDirectivePropertyPage;
 
    // Declarations of static functions and data members to be able to create registered implementations.
    SF_DECL_IFACE(ScanMethod, ScanMethod::Parameters, Interface)
};
 
inline const Vector3D& ScanMethod::GetScanOffset() const
{
  return FScanOffset;
}
 
inline Variable::PtrVector& ScanMethod::GetLocalVars()
{
  return FLocalVars;
}
 
inline TDataFilterLinks& ScanMethod::GetFilterLinks()
{
  return FFilterLinks;
}
 
inline const std::vector<int>& ScanMethod::GetUsedDevices() const
{
  return FUsedDevices;
}
 
inline InformationTypes::IdVector& ScanMethod::GetCalibrationIds()
{
  return FCalibrationIds;
}
 
inline std::string ScanMethod::GetFilterConfigs()
{
  return FFilterConfigs;
}
 
inline bool ScanMethod::GetMeasureOffset(Vector3D& vector, int index, double frac, bool rect)
{
  return false;
}
 
}// namespace sf