IWPOCTController.h

Go to the documentation of this file.

 
#pragma once
 
typedef void (*SendNoParams) (void*);
typedef void (*NotifyErrorCallback)(bool);
 
struct IWPOCTController
{
public:
 
    // Data Types
 
    enum ErrorCode
    {
        NoError                 = 0,
        PortNotOpen             = 1,
        PortFailedToOpen        = 2,
        PortFailedToClose       = 3,
        LostConnection          = 4,
        CommunicationError      = 5,
        UnrecognizedCommand     = 6,
        InvalidCommandValues    = 7,
        MissingCommandParameter = 8,
        InvalidResponse         = 9,
        NumErrors               = 10
    };
 
    enum CurrentStates
    {
        PortClosed          = 0,
        PortOpened          = 1,
        CommandProcessed    = 2,
        Busy                = 4,
        NumStates           = 8
    };
 
    // Lifecycle
 
    virtual ~IWPOCTController() { }
 
    // Getters
 
    virtual bool    IsPortOpen  () const = 0;
 
    virtual bool    IsLightOn   (int index) = 0;
 
    virtual bool    IsScanning  () const = 0;
 
    virtual int     GetBaudRate     () const = 0;
 
    virtual int     GetNumStopBits  () const = 0;
 
    virtual int     GetPortTimeout  () const = 0;
    
    virtual bool    GetMonitorPort  () const = 0;
 
    virtual bool    GetReadResponse () const = 0;
    
    virtual const char* GetVersion  () const = 0;
 
    virtual int     GetAScans       () const = 0;
 
    virtual int     GetBScans       () const = 0;
 
    virtual int     GetFoci         () const = 0;
 
    virtual int     GetDelay        () const = 0;
 
    virtual int     GetPulse        () const = 0;
 
    virtual int     GetPhase        () const = 0;
 
    virtual int     GetArmPosition  () const = 0;
 
    virtual void    GetScanArea     (int* xStart, int* xStop, int* yStart, int* yStop) const = 0;
    
    virtual void    GetMirror       (int* major, int* minor) const = 0;
 
    virtual bool    GetSwapXY       () const = 0;
 
    virtual const char* GetPortName () = 0;
 
    virtual const char* GetLastCommandSent  () const = 0;
 
    virtual const char* GetLastResponse     () const = 0;
 
    virtual int     GetXRampMinPos() const = 0;
 
    virtual int     GetXRampMaxPos() const = 0;
 
    virtual int     GetYRampMinPos() const = 0;
 
    virtual int     GetYRampMaxPos() const = 0;
 
    virtual int     GetXRampStartPos() const = 0;
 
    virtual int     GetXRampStopPos () const = 0;
 
    virtual int     GetYRampStartPos() const = 0;
 
    virtual int     GetYRampStopPos () const = 0;
 
    virtual int     GetPathMotorPosMax      () const = 0;
 
    virtual int     GetQuarterHalfWavePosMax() const = 0;
 
    // Setters
 
    virtual bool    SetAScans       (int value) = 0;
 
    virtual bool    SetBScans       (int value) = 0;
 
    virtual bool    SetFoci         (int value) = 0;
 
    virtual bool    SetDelay        (int value) = 0;
 
    virtual bool    SetPulse        (int value) = 0;
 
    virtual bool    SetPhase        (int value) = 0;
 
    virtual bool    SetArmPosition  (int position) = 0;
 
    virtual bool    SetScanArea     (int xStart, int xStop, int yStart, int yStop) = 0;
 
    virtual bool    SetScanArea     (int xStart, int xStop, int yStart, int yStop, int numPasses) = 0;
 
    virtual bool    SetMirror       (int major, int minor) = 0;
 
    virtual bool    SetSwapXY       (bool value) = 0;
 
    virtual bool    SetXRampMinPos  (int value) = 0;
 
    virtual bool    SetXRampMaxPos  (int value) = 0;
 
    virtual bool    SetYRampMinPos  (int value) = 0;
 
    virtual bool    SetYRampMaxPos  (int value) = 0;
 
    virtual bool    SetReadResponse (bool value) = 0;
 
    virtual bool    SetPathMotorPosMax      (int value) = 0;
 
    virtual bool    SetQuarterHalfWavePosMax(int value) = 0;
 
    // Serial port commands
    
    virtual bool    OpenPort    (const char* portName, int baudRate, int numStopBits,
                                 int timeout, bool monitorConnection) = 0;
 
    virtual bool    OpenPort    (int baudRate, int numStopBits, int timeout, bool monitorConnection) = 0;
 
    virtual bool    OpenPort    () = 0;
 
    virtual bool    ClosePort   () = 0;
 
    virtual bool    SendCommand (const char* command, char* response, int maxResponseSize) = 0;
 
    virtual bool    SendCommand (const char* command) = 0;
 
    // Light commands
 
    virtual bool    TurnLightOn     (int num) = 0;
 
    virtual bool    TurnLightOff    (int num) = 0;
 
    virtual bool    TurnLightsOff   () = 0;
 
    // Scanner Commands
 
    virtual bool    StartScan       () = 0;
 
    virtual bool    StopScan        () = 0;
 
    // Movement Commands
 
    virtual bool    ParkArm         () = 0;
 
    virtual bool    SendMotorsHome  () = 0;
 
    // Optical switch commands
 
    virtual int     GetActiveOpticalPort    () = 0;
 
    virtual bool    SetActiveOpticalPort    (int port) = 0;
 
    virtual bool    ToggleOpticalSwitch     () = 0;
 
    // Shutter commands
 
    virtual bool    IsShutterOpen           (int ID, bool* open) = 0;
    virtual bool    OpenShutter             (int ID) = 0;
    virtual bool    CloseShutter            (int ID) = 0;
 
    // Status Commands
    
    virtual IWPOCTController::ErrorCode     GetLastError    () const = 0;
 
    virtual IWPOCTController::CurrentStates GetCurrentStatus() const = 0;
 
    virtual void    SetSerialPortLostCallback       (NotifyErrorCallback notifyError) = 0;
 
    virtual void    SetSerialPortLostCallback2      (SendNoParams serialPortLost, void* context) = 0;
 
// Include the section below when compiling with Swig.
#ifdef _RUNSWIG
    static IWPOCTController* GetOCTController();
 
    static bool DestroyOCTController();
};
 
// Include the section below when compiling in Visual Studio.
#else
};
#ifdef __cplusplus
extern "C" {
#endif
 
__declspec(dllexport) IWPOCTController* GetOCTController();
 
__declspec(dllexport) bool DestroyOCTController();
 
#ifdef __cplusplus
}
#endif
#endif