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_SCANBINDERNAME("<default>");
constexpr std::string_view SEC_BINDER_GENERAL("Scan Binder");
constexpr std::string_view KEY_IGNOREOFFSET("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;
    };
 
    // Constructor for passing general structure for derived classes.
    explicit ScanBinder(const Parameters& parameters);
    // Destructor.
    ~ScanBinder() override;
    //
    // Functions for the project to control the additional data.
    //
    // Reads and writes system configuration data.
    void ReadWriteConfig(bool rd);
    // For reading and write the current state of this instance and derived classes.
    ConfigStore& GetSaveState();
    // Adds the scan binder property pages of the base class.
    // May be overloaded by derived class.
    virtual void AddPropertyPages(PropertySheetDialog* sheet);
    // Called by the project to make the binder create the additional information.
    void NewScanEntry(ScanEntry* se);
    // Called by the project to make the binder delete the additional information.
    void DeleteScanEntry(const ScanEntry* se);
    // Adds property pages for derived classes by calling virtual method AddPropertyPages.
    // When scan is true it gets the property pages which are scan related when false it gets the project selected property pages.
    void DoAddPropertyPages(PropertySheetDialog* sheet, bool scan);
    // Creates a scan binder frame if possible.
    QWidget* DoGetFrame();
    // Reads the settings from the passed inifile.
    void DoReadProfile(IniProfile& inifile);
    // Writes the settings to the passed inifile.
    void DoWriteProfile(IniProfile& inifile);
    // Do some initialization which must be done before scan initializations.
    bool DoPreInitialize();
    // Initializes the scan method. Is each time a project changes.
    bool DoInitialize();
    // Called from the project and rooted to the virtual Sustain function.
    void DoSustain(timespec clk);
    // Clears any settings of the scan binder to their initial state.
    void DoClear();
    // Suspends action at a convenient position or immediate.
    bool DoSuspend(bool immediate);
    // Resumes a suspended action.
    bool DoResume();
    // Stops activity immediately.
    bool DoStop();
    // Abort immediately stop all movement.
    bool DoAbort();
    // Moves the manipulator to a specific position.
    bool DoMoveTo(int scan, int index = -1, double frac = 0.0, bool rect = false);
    // Queries for a surface position of the user.
    bool DoMoveToQuery(int scan);
    // Moves to one of the system positions.
    bool DoMoveToSysPos(ESystemPosition sp);
    // Starts position checking mode and a scan method in checking mode.
    // This means the angle on the surface is always zero degree to get
    // a better signal from the surface.
    bool DoCheck(int scan);
    // Starts scan movements and a scan method for data recording.
    bool DoScan(int scan);
    // Start in evaluation mode and a scan method in evaluation mode.
    // This means the angle on the surface is the same as when evaluating but
    // movements are initiated by the DoMoveTo function.
    bool DoEvaluate(int scan);
    // Activates possible added links and parameters in a derived instance.
    bool DoActivate(int scan);
    // Starts rotating the scan axis if one is available for rotation using
    // the scan rotation speed at the passed index or when index is -1 it uses
    // the last index position. When scan is -1 the rotation stops.
    bool DoRotate(int scan, int index = -1);
    // Returns true if the passed scan is able to rotate regardless the current state.
    bool CanRotate(int scan) const;
    // Returns true if the rotating is active.
    bool IsRotating() const;
    // Returns the current scanning index. Is for progress purposes.
    int DoGetIndex() const;
    // Returns the sum of offsets generated by the derived scan binder.
    // When not this function returns the same value as the fixture offset.
    Vector3D DoGetOffset() const;
 
    // States
    enum EState
    {
      sbsCFGERR = -2,
      sbsERROR = -1,
      sbsNOINIT = 0,
      sbsABORTED,
      /*
       * Controller is freed for usage by other modules.
       */
      sbsREADY,
      sbsWAITING,
      sbsSUSPENDED,
      sbsACTIVE,
      sbsCHECKING,
      sbsSCANNING,
      sbsEVALUATING
    };
 
    // Gets the state name string.
    static const char* GetStateName(EState state);
    // Gets the current state name.
    const char* GetStateName() const;
    // Gets the state of the instance
    EState GetState() const;
    // Gets the velocity used to manipulate.
    const gmi::AxesCoord& GetVelocity() const;
    // Gets the acceleration used to manipulate.
    const gmi::AxesCoord& GetAcceleration() const;
    // Gets the project park position.
    const gmi::AxesCoord& GetParkPosition() const;
    // Gets the project park position.
    const gmi::AxesCoord& GetToolPosition() const;
    // Gets the fixture offset for the project applied on each scan.
    const Vector3D& GetFixtureOffset() const;
    // Gets the medium sound velocity variable.
    const Variable& GetMediumVelocity() const;
    // Gets the active scan index when the state is active or higher an -1 when not active.
    int GetActiveScanIndex() const;
    // Gets the scan progress when scanning otherwise it returns -1.
    double GetScanProgress() const;
    // Gets true if the controller can be allocated.
    bool CanAllocateController() const;
    // Gets true is the controller is allocated.
    bool IsControllerAllocated() const;
    // Allocates or frees the controller for this project.
    bool AllocateController(bool alloc);
    // Gets the allocated controller for this project if not allocated it throws an exception and should be regarded as a design error.
    gmi::Controller* GetController();
    const gmi::Controller* GetController() const;
    // Sets the pop to manual state on the acquisition device.
    void SetAcqPopManual(RsaTypes::EPopManual pop_manual);
    // Gets true if the pop manual process is completed.
    bool IsAcqPopManualReady() const;
    // Enables or disables programming velocity.
    void SetProgVelocityEnable(bool enabled);
    bool GetProgVelocityEnable() const;
    // Gets the local variables of the scan binder.
    const Variable::PtrVector& GetVars() const;
 
  protected:
    // Gets the scan position at the passed scan index.
    bool GetScanPos(
      gmi::AxesCoord& pos,// Returned axes coordinated.
      int scan,// Scan list index.
      int index,// Measurement index.
      double frac,// Scan line fraction.
      bool rect// When true the rectangular position if possible is returned.
    ) const;
    // Gets the current project active scan index and -1 one if not active.
    int GetScanIndex();
    // Gets the scan method of the project.
    ScanMethod* GetScan(int scan) const;
    // Gets true if the state was successfully set.
    bool SetState(EState state);
    // Gets the scan information of the passed project scan list index.
    InfoBase* GetScanInfo(int scan);
    const InfoBase* GetScanInfo(int scan) const;
    // Gets the scan information of the passed scan method pointer.
    InfoBase* GetScanInfo(const ScanMethod* sm);
    const InfoBase* GetScanInfo(const ScanMethod* sm) const;
    // Must be overridden in a derived class.
    // Returns a InfoBase derived structure.
    virtual InfoBase* NewScanInfo() = 0;
    // Is called when the current state changes.
    virtual void StateChange(EState prev, EState cur) = 0;
    // Must be overloaded in a derived class.
    // Adds property pages to the passed sheet. See DoAddPropertyPages.
    virtual void AddPropertyPages(PropertySheetDialog* sheet, bool scan) = 0;
    // Reads the settings from the passed inifile.
    virtual void ReadProfile(IniProfile& inifile) = 0;
    // Writes the settings to the passed inifile.
    virtual void WriteProfile(IniProfile& inifile) = 0;
    // Returns the current scanned index.
    virtual int GetIndex() = 0;
    // Clears the settings of the derived instance initial state.
    virtual void Clear() = 0;
    // Can be overloaded to do background processing.
    virtual void Sustain(timespec) = 0;
    // Initializes the instance for action.
    virtual bool Initialize() = 0;
    // Suspends action at a convenient position.
    virtual bool Suspend(bool immediate) = 0;
    // Resumes a suspended action.
    virtual bool Resume() = 0;
    // Stops activity immediately.
    virtual bool Stop() = 0;
    // Abort immediately stop all movement.
    virtual bool Abort() = 0;
    // Must be overloaded in a derived class.
    // When scan negative the index is considered to be a system position index.
    // When scan has a valid value and index is negative the part is approached.
    // When frac is negative am input query is started for a surface position.
    virtual bool MoveTo(int scan, int index, double frac, bool rect) = 0;
    // Starts checking .
    virtual bool Check(int scan) = 0;
    // Starts scan movements and a scan method for acquisition.
    virtual bool Scan(int scan) = 0;
    // Starts evaluation on the passed scan.
    virtual bool Evaluate(int scan) = 0;
    // Starts activates the parameters or links for the passed scan on the derived class.
    virtual bool Activate(int scan) = 0;
    // Starts rotation on the passed scan and index position for velocity calculations.
    // When the passed index is -1 the current or last index position or center index is to be used.
    virtual bool Rotate(int scan, int index) = 0;
    // Creates the scan binder control frame.
    virtual QWidget* GetFrame() = 0;
    // Returns the sum of offsets generated by a derived class if overloaded.
    virtual Vector3D GetOffset() const;
    // Must be overloaded to do retrieve the list of linked variables or results.
    // The name contains the description and the object the GII object pointer.
    virtual bool GetGenericInfoList(StringList&) = 0;
    // Property handler.
    ProjectData* GetProjectData();
    // Overloaded from base class.
    const IdInfo* getInfo(const std::string& name) const override;
    // Overloaded from base class.
    bool getSetValue(const ScriptObject::IdInfo* info, Value* value, Value::vector_type* params, bool flag_set) override;
 
    // Can be overloaded to read and write additional configuration settings.
    virtual void DoReadWriteConfig(IniEnvelope& ini, bool rd) {}
 
  private:
    // Holds the controller allocation status.
    bool FControllerAllocated;
    // Holds the rotating flag.
    bool FRotating;
    // Holds the flag which decides which velocity is used.
    bool FProgrammingVelocity;
    // Sets the state for this base class without any checks.
    void SetStatePrivate(EState state);
    // Pointer to the project this instance is part of.
    ProjectData* FProjectData;
    // Holds the name prefix for binder parameters.
    std::string FNamePrefix;
    // Holds the current state.
    const EState FState;
    // For returning in references when a request fails.
    gmi::AxesCoord FFailCoord;
    // Holds the velocity values for manipulation.
    gmi::AxesCoord FVelocity;
    // Holds the velocity values for manipulation at scan project design time.
    gmi::AxesCoord FProgVelocity;
    // Holds the acceleration values for manipulation.
    gmi::AxesCoord FAcceleration;
    // Holds the project dependent park position.
    gmi::AxesCoord FParkPosition;
    // Holds the project dependent tool position.
    gmi::AxesCoord FToolPosition;
    // Holds the fixture offset.
    Vector3D FFixtureOffset;
    // Holds the active scan index when the instance was activated
    // using a command where the index was passed.
    int FActiveScanIndex;
    // Handles parameters.
    void VarEvent(Variable::EEvent event, const Variable&, Variable& link, bool same_inst);
    // Holds the local variable pointers that hold the parameters.
    Variable::PtrVector FLocalVars;
    // For reporting the scanning progress.
    LocalVariable VProgress;
    // Holds the medium velocity of the name specified in the project.
    LocalVariable VMediumVelocity;
    // Handles applies from system property pages.
    void HandleParamMappingApply(QWidget*);
    // For storing current information.
    ConfigStore FSaveState;
 
    TVariableHandler<ScanBinder> _variableHandler;
 
    friend ScanMethod;
    friend ScanMethodPositionPropertyPage;
    friend ProjectDataPropertyPage;
    friend CheckPositionsPropertyPage;
 
    // Declarations of static functions and data members to be able to create registered implementations.
    SF_DECL_IFACE(ScanBinder, ScanBinder::Parameters, Interface)
};
 
inline ConfigStore& ScanBinder::GetSaveState()
{
  return FSaveState;
}
 
inline ScanBinder::EState ScanBinder::GetState() const
{
  return FState;
}
 
inline bool ScanBinder::CanAllocateController() const
{
  // When already allocated byu this instance it is not problem.
  if (FControllerAllocated)
    return true;
  // Return true when the controller is not allocated.
  return !getProjectModule()->IsControllerAllocated();
}
 
inline bool ScanBinder::IsControllerAllocated() const
{
  return FControllerAllocated;
}
 
inline bool ScanBinder::IsRotating() const
{
  return FRotating;
}
 
inline const char* ScanBinder::GetStateName() const
{
  return GetStateName(GetState());
}
 
inline const gmi::AxesCoord& ScanBinder::GetAcceleration() const
{
  return FAcceleration;
}
 
inline const gmi::AxesCoord& ScanBinder::GetParkPosition() const
{
  return FParkPosition;
}
 
inline const gmi::AxesCoord& ScanBinder::GetToolPosition() const
{
  return FToolPosition;
}
 
inline const Variable& ScanBinder::GetMediumVelocity() const
{
  return VMediumVelocity;
}
 
inline ProjectData* ScanBinder::GetProjectData()
{
  return FProjectData;
}
 
inline const gmi::Controller* ScanBinder::GetController() const
{
  return const_cast<ScanBinder*>(this)->GetController();
}
 
inline void ScanBinder::SetProgVelocityEnable(bool enabled)
{
  FProgrammingVelocity = enabled;
}
 
inline bool ScanBinder::GetProgVelocityEnable() const
{
  return FProgrammingVelocity;
}
 
inline const Variable::PtrVector& ScanBinder::GetVars() const
{
  return FLocalVars;
}
 
inline const ScanBinder::InfoBase* ScanBinder::GetScanInfo(int scan) const
{
  return const_cast<ScanBinder*>(this)->GetScanInfo(scan);
}
 
inline const ScanBinder::InfoBase* ScanBinder::GetScanInfo(const ScanMethod* sm) const
{
  return const_cast<ScanBinder*>(this)->GetScanInfo(sm);
}
 
}// namespace sf