MeanderScanMethod.h

Go to the documentation of this file.

#pragma once
#include "MeanderScanMethodScript.h"
#include <ipj/iface/ScanMethod.h>
#include <misc/gen/IntervalTimer.h>
 
namespace sf::ipj
{
 
// Forward definition.
class MeanderScanMethodFrame;
 
class MeanderScanMethod final : public ScanMethod
{
  public:
    // Constructor.
    explicit MeanderScanMethod(const Parameters&);
 
    // Destructor.
    ~MeanderScanMethod() override;
 
    // Overloaded from base class.
    bool Initialize() override;
 
    // Overloaded from base class.
    void AddPropertyPages(PropertySheetDialog* sheet) override;
 
    // Overloaded from base class.
    bool HandleCommand(ECommand cmd) override;
 
    // Overloaded from base class.
    void Read(IniProfile* ini) override;
 
    // Overloaded from base class.
    void Write(IniProfile* ini) override;
 
    // Overloaded from base class.
    bool CreateFrame() override;
 
    // Overloaded from base class.
    bool GetIndexPos(gmi::AxesCoord& pos, int index, double frac, bool rect) override;
 
    // Overloaded from base class.
    bool Sustain(const timespec& ts) override;
 
    // Overloaded from base class.
    bool ConvertPosition(
      gmi::AxesCoord& dest,// Returned focus coordinate.
      const gmi::AxesCoord& src,// Source physical coordinate.
      bool to_focus// Direction focus or physical.
    ) const override
    {
      return false;
    }
 
    bool GetIndexVel(gmi::AxesCoord& vel, int index) override
    {
      return false;
    }
 
    bool SetAcqParams(int index, double scan_factor) override
    {
      return false;
    }
 
    // Exportable variable parameters.
    LocalVariable _vTravStart;
    LocalVariable _vTravStop;
    LocalVariable _vTravVel;
    LocalVariable _vTravAxis;
    LocalVariable _vMeasCount;
    LocalVariable _vDensity;
    LocalVariable _vStepMode;
    LocalVariable _vStepCount;
    LocalVariable _vStepStop;
    LocalVariable _vStepStart;
    LocalVariable _vStepSize;
    LocalVariable _vStepAxis;
    // Holds the local variable pointers that hold the parameters.
    Variable::PtrVector _vars;
 
    // Event handler for local variables.
    void variableEvent(Variable::EEvent event, const Variable& caller, Variable& link, bool same_inst);
    void variableAxisEvent(Variable::EEvent event, const Variable& caller, Variable& link, bool same_inst);
    //
    TVariableHandler<MeanderScanMethod> _variableEventHandler{this, &MeanderScanMethod::variableEvent};
    TVariableHandler<MeanderScanMethod> _variableAxisEventHandler{this, &MeanderScanMethod::variableAxisEvent};
 
    //
    //   PreStart              ScanStep(s)          PostStop
    //       +----->-----+-------->-------+------>-----+
    //                   |                |
    //                   |                |
    //                   +--------<-------+
    //               ScanStart         ScanStop
    //
 
    enum EScanCycleStage
    {
      scsIDLE = 0,
      scsMOVING,
      scsACQUIRE,
      scsPRESTART,
      scsSCANSTART,
      scsSCANSTEP,
      scsSCANSTOP,
      scsPOSTSTOP,
    };
 
    // Holds the current stage when the scan method is active.
    const EScanCycleStage _stage;
    // Holds the previous stage.
    const EScanCycleStage _prevStage;
    // Holds the next stage when moving.
    const EScanCycleStage _moveStage;
 
    // Returns the positon for the given stage at given index in the passed axes coordinate reference.
    // Returns true on succes of retrieving.
    bool GetStagePos(EScanCycleStage stage, int index, int step, gmi::AxesCoord& stage_pos);
    // Returns true on successful starting the controller to move.
    bool MoveToStage(EScanCycleStage stage, int index = -1, int step = -1);
    // Returns true is the current controller position is equals the
    // stage position.
    bool CheckStagePos(EScanCycleStage stage, int index, int step);
    // Sets the next stage and assigns the current to the previous member.
    void SetStage(EScanCycleStage stage);
    // Returns the name of the stage.
    const char* GetStageName(int stage);
    // Returns the normally the output stream of the scan method frame but if the frame is not created. The global output stream 'cout' is returned.
    std::ostream& Cout();
    int GetIndex();
    // Get the frame pointer.
    MeanderScanMethodFrame* GetMeanderFrame();
    // Holds the current command being executed.
    ECommand _command;
    // Holds the current index for step axis.
    int _curIndex;
    // Holds the index for step and go measurements.
    int _curStep;
    // Timer for debugging.
    IntervalTimer _debugDelayTimer;
    // Flag indicating that the sustain must wait for the script to finish.
    bool _waitForScript;
    // Special script which does the storing of a single scan line.
    AcquireScript _acquireScript;
    // Overloaded from base class.
    ScriptLink* GetScriptLink() override;
 
  protected:
    void StateChange(EState prev, EState cur) override;
    bool GetGenericInfoList(StringList&) override;
    bool GetFocusPos(gmi::AxesCoord& dest, int index, double frac) override;
    bool GetTriggerValue(gmi::AxisValue& trigger_value) override;
    gmi::EAxisLocation GetScanAxis() override;
 
    friend class MeanderScanMethodFrame;
};
 
inline MeanderScanMethodFrame* MeanderScanMethod::GetMeanderFrame()
{
  return reinterpret_cast<MeanderScanMethodFrame*>(GetFrame());
}
 
}// namespace sf::ipj