IWPOCTInOutData.h

Go to the documentation of this file.

 
#pragma once
 
struct IWPOCTInOutData
{
    enum ErrorCode
    {
        NoError = 0,
        NullPointer = 1,
        InvalidArgumentValue = 2,
        MemoryAllocationError = 3,
        MemoryDeallocationError = 4,
        MemoryCopyError = 5,
        AttemptToDeleteDLLAllocMemory = 6,
        NumErrors = 7
    };
 
    // Destructor
    virtual ~IWPOCTInOutData() { }
 
    // Getters
 
    // Determines if these arrays were allocated by the converter dll.
    // If value returned is true, then the dll allocated the array.
 
    virtual bool            IsRawAllocated      ()  const = 0;
 
    virtual bool            IsIntensityAllocated()  const = 0;
 
    virtual bool            IsPhaseAllocated    ()  const = 0;
 
    virtual bool            IsScaledAllocated   ()  const = 0;
 
    virtual bool            IsTransposedAllocated() const = 0;
 
    virtual bool            IsColorAllocated    ()  const = 0;
 
    // Get the sizes of the arrays if not supplied by the user.  If they are, returns 0.
 
    virtual int             GetRawSize      ()  const = 0;
 
    virtual int             GetIntensitySize()  const = 0;
    
    virtual int             GetPhaseSize    ()  const = 0;
 
    virtual int             GetScaledSize   ()  const = 0;
    
    virtual int             GetTransposedSize() const = 0;
 
    virtual int             GetColorSize    ()  const = 0;
 
    virtual int             GetInputWidth   ()  const = 0;
    virtual int             GetInputHeight  ()  const = 0;
    virtual int             GetOutputWidth  ()  const = 0;
    virtual int             GetOutputHeight ()  const = 0;
 
    virtual unsigned short* GetRawData      () = 0;
 
    virtual float*          GetIntensityData() = 0;
 
    virtual float*          GetPhaseData    () = 0;
 
    virtual unsigned short* GetScaledData   () = 0;
 
    virtual unsigned short* GetTransposedData() = 0;
 
    virtual unsigned char*  GetColorData    () = 0;
 
    virtual bool            GetRawData      (unsigned short* data) = 0;
 
    virtual bool            GetIntensityData(float* data) = 0;
 
    virtual bool            GetPhaseData    (float* data) = 0;
 
    virtual bool            GetScaledData   (unsigned short* data) = 0;
 
    virtual bool            GetTransposedData(unsigned short* data) = 0;
 
    virtual bool            GetColorData    (unsigned char* data) = 0;
 
    // Setters
 
    // Determines if these arrays will be allocated or they will be supplied by the user.
    // If value is true, then the dll will allocate the array.  If false, the application
    // must supply the array.
 
    virtual bool            SetAllocateRaw          (bool value) = 0;
 
    virtual bool            SetAllocateIntensity    (bool value) = 0;
 
    virtual bool            SetAllocatePhase        (bool value) = 0;
 
    virtual bool            SetAllocateScaled       (bool value) = 0;
 
    virtual bool            SetAllocateTransposed   (bool value) = 0;
 
    virtual bool            SetAllocateColor        (bool value) = 0;
 
    virtual bool            SetInputWidth       (int value) = 0;
    virtual bool            SetInputHeight      (int value) = 0;
    virtual bool            SetOutputWidth      (int value) = 0;
    virtual bool            SetOutputHeight     (int value) = 0;
 
    virtual bool            SetRawData      (unsigned short* data, int width, int height) = 0;
 
    virtual bool            SetIntensityData(float* data, int width, int height) = 0;
 
    virtual bool            SetPhaseData    (float* data) = 0;
 
    virtual bool            SetScaledData   (unsigned short* data) = 0;
 
    virtual bool            SetTransposedData(unsigned short* data) = 0;
 
    virtual bool            SetColorData    (unsigned char* data) = 0;
 
    virtual bool            Resize(int width, int height) = 0;
 
    virtual bool            Resize() = 0;
 
    // Status
 
    virtual IWPOCTInOutData::ErrorCode  GetLastError() const = 0;
 
// Include the section below when compiling with Swig.
#ifdef _RUNSWIG
    static IWPOCTInOutData* CreateOCTInOutData();
 
    static bool DestroyOCTInOutData(IWPOCTInOutData* item);
};
 
// Include the section below when compiling in Visual Studio.
#else
};
#ifdef __cplusplus
extern "C" {
#endif
 
__declspec(dllexport) IWPOCTInOutData* CreateOCTInOutData();
 
__declspec(dllexport) bool DestroyOCTInOutData(IWPOCTInOutData* item);
 
#ifdef __cplusplus
}
#endif
#endif