IWPOCTCamera.h

Go to the documentation of this file.

 
#pragma once
 
struct IWPOCTCamera
{
public:
    enum ErrorCode
    {
        NoError = 0,
        InitializeLibraryError = 1,
        ShutdownLibraryError = 2,
        UpdateCameraListError = 3,
        GetCameraInfoError = 4,
        OpenCameraError = 5,
        CloseCameraError = 6,
        MemoryAllocationError = 7,
        ProcessingError = 8,
        ReadParameterError = 9,
        SetParameterError = 10,
        StartAcquiringError = 11,
        StopAcquiringError = 12,
        GetBufferError = 13,
        BufferCompletedWithZeros = 14,
        AbortGetBufferError = 15,
        RequeueBufferError = 16,
        FlushBufferError = 17,
        TimeoutError = 18,
        CameraFileError = 19,
        DongleNotFound = 20,
        NumErrors = 21,
        DLLExpired = 22
    };
 
    enum CameraType
    {
        NoCamera    = 0,
        USB3        = 1,
        CameraLink  = 2,
        NI1433      = 3,
        NumCameras  = 4
    };
 
    enum CurrentStates
    {
        Idle                = 0, 
        LibraryInitialized  = 1,
        CameraOpened        = 2,
        ParametersSet       = 4,
        CameraAcquiring     = 8
    };
 
    virtual ~IWPOCTCamera() { }
 
    // Getters
 
    virtual bool    IsInitialized       () const = 0;
 
    virtual bool    IsOpened            () const = 0;
 
    virtual bool    AreParametersSet    () const = 0;
 
    virtual bool    IsAcquiring         () const = 0;
 
    virtual int     GetScanWidth        () const = 0;
 
    virtual int     GetScanHeight       () const = 0;
 
    virtual bool    GetScanWidthAndHeight(int* width, int* height) const = 0;
 
    virtual int     GetCameraWidth      () const = 0;
 
    virtual int     GetNumCameras       () const = 0;
 
    virtual const char* GetCameraID     (int index) = 0;
 
    virtual int     GetNumBuffers       () const = 0;
 
    virtual int     GetLinesLost        () const = 0;
 
    virtual int     GetTriggersMissed   () const = 0;
 
    virtual float   GetLinePeriod       () const = 0;
 
    virtual float   GetExposureTime     () const = 0;
 
    virtual int     GetTriggerMode      () const = 0;
 
    virtual int     GetCameraType       () const = 0;
 
    virtual int     GetNumBitsInPixel   () const = 0;
 
    virtual int     GetNumBytesInPixel  () const = 0;
 
    virtual int     GetAcquisitionTimeout   () const = 0;
 
    virtual int     GetResourceIndex    () const = 0;
 
    virtual const char*     GetCameraFileName   () const = 0;
 
    // Setters
 
    virtual bool    SetScanHeight       (int value) = 0;
 
    virtual bool    SetNumBuffers       (int value) = 0;
 
    virtual bool    SetLinePeriod       (float value) = 0;
 
    virtual bool    SetExposureTime     (float value) = 0;
 
    virtual bool    SetTriggerMode      (int value) = 0;
 
    virtual bool    SetCameraFileName   (const char* name) = 0;
 
    virtual bool    SetAcquisitionTimeout   (int value) = 0;
 
    virtual bool    SetResourceIndex    (int value) = 0;
 
    // Methods
 
    virtual bool    InitializeLibrary   () = 0;
 
    virtual bool    ShutDownLibrary     () = 0;
 
    // -------------------------------------------------------------------------
    // Open the camera
    // -------------------------------------------------------------------------
 
    virtual bool    Open                (const char* id) = 0;
 
    virtual bool    Open                (int id) = 0;
 
    virtual bool    Close               () = 0;
 
    // -------------------------------------------------------------------------
    // Parameters
    // -------------------------------------------------------------------------
 
    virtual bool    ReadParameter       (unsigned int address, unsigned int* value) const = 0;
 
    virtual bool    WriteParameter      (unsigned int address, unsigned int value) = 0;
 
    virtual bool    SetParameters       () = 0;
 
    virtual bool    SetParameters       (int height, int numBuffers) = 0;
 
    virtual bool    StartAcquiring      () = 0;
 
    virtual bool    StopAcquiring       (bool flushBuffers) = 0;
 
    virtual bool    ResetDevice         () = 0;
 
    // -------------------------------------------------------------------------
    // Buffer and queue commands
    // -------------------------------------------------------------------------
 
    virtual bool    GetBuffer           (void** buffer) = 0;
 
    virtual bool    GetBuffer2          (unsigned short** buffer) = 0;
 
    virtual bool    GetBufferCopy       (unsigned short* buffer) = 0;
 
    virtual bool    GetBufferAndIndex   (void** buffer, int** index, unsigned long* frameNumber) = 0;
 
    virtual bool    GetBufferAndIndex2  (unsigned short** buffer, int** index, unsigned long* frameNumber) = 0;
 
    virtual bool    AbortGetBuffer      () = 0;
 
    virtual bool    RequeueBuffer       () = 0;
 
    virtual bool    RequeueBuffer       (int* bufferHandle) = 0;
 
    virtual bool    FlushBuffers        () = 0;
 
    // -------------------------------------------------------------------------
    // Series Capture
    // -------------------------------------------------------------------------
 
    virtual bool    AcquireFramesWriteToDisk    (const char* baseFilePath, int numFrames, 
                                                 bool keepMemoryAllocated) = 0;
 
    virtual bool    AcquireWriteFramesToMemory  (unsigned short** data, int numFrames) = 0;
 
    virtual bool    AcquireWriteFramesToMemory  (unsigned short* data, int numFrames) = 0;
 
    // -------------------------------------------------------------------------
    // Status
    // -------------------------------------------------------------------------
 
    virtual IWPOCTCamera::ErrorCode         GetLastError    () const = 0;
 
    virtual IWPOCTCamera::CurrentStates     GetCurrentState () const = 0;
 
// Include the section below when compiling with Swig.
#ifdef _RUNSWIG
    static IWPOCTCamera* GetOCTCamera(IWPOCTCamera::CameraType cameraType);
 
    static bool DestroyOCTCamera(IWPOCTCamera* camera = NULL);
 
    static IWPOCTCamera::ErrorCode  GetLastAttemptError();
};
 
// Include the section below when compiling in Visual Studio.
#else
};
#ifdef __cplusplus
extern "C" {
#endif
 
__declspec(dllexport) IWPOCTCamera* GetOCTCamera    (IWPOCTCamera::CameraType cameraType);
 
__declspec(dllexport) IWPOCTCamera::ErrorCode GetLastAttemptError();
 
__declspec(dllexport) bool DestroyOCTCamera         (IWPOCTCamera* camera = NULL);
 
#ifdef __cplusplus
}
#endif
#endif