gdal_asyncreader.h

/******************************************************************************
 *
 * Project:  GDAL Core
 * Purpose:  Declaration of GDALAsyncReader base class.
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *
 ******************************************************************************
 * Copyright (c) 2010, Frank Warmerdam
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/
 
#ifndef GDALASYNCREADER_H_INCLUDED
#define GDALASYNCREADER_H_INCLUDED
 
#include "cpl_port.h"
 
#include "gdal.h"
 
class GDALDataset;
 
/* ******************************************************************** */
/*                          GDALAsyncReader                             */
/* ******************************************************************** */

class CPL_DLL GDALAsyncReader
{
 
    CPL_DISALLOW_COPY_ASSIGN(GDALAsyncReader)
 
  protected:
    GDALDataset *poDS;
    int nXOff;
    int nYOff;
    int nXSize;
    int nYSize;
    void *pBuf;
    int nBufXSize;
    int nBufYSize;
    GDALDataType eBufType;
    int nBandCount;
    int *panBandMap;
    int nPixelSpace;
    int nLineSpace;
    int nBandSpace;
 
  public:
    GDALAsyncReader();
    virtual ~GDALAsyncReader();

    GDALDataset *GetGDALDataset()
    {
        return poDS;
    }

    int GetXOffset() const
    {
        return nXOff;
    }

    int GetYOffset() const
    {
        return nYOff;
    }

    int GetXSize() const
    {
        return nXSize;
    }

    int GetYSize() const
    {
        return nYSize;
    }

    void *GetBuffer()
    {
        return pBuf;
    }

    int GetBufferXSize() const
    {
        return nBufXSize;
    }

    int GetBufferYSize() const
    {
        return nBufYSize;
    }

    GDALDataType GetBufferType() const
    {
        return eBufType;
    }

    int GetBandCount() const
    {
        return nBandCount;
    }

    int *GetBandMap()
    {
        return panBandMap;
    }

    int GetPixelSpace() const
    {
        return nPixelSpace;
    }

    int GetLineSpace() const
    {
        return nLineSpace;
    }

    int GetBandSpace() const
    {
        return nBandSpace;
    }
 
    virtual GDALAsyncStatusType
    GetNextUpdatedRegion(double dfTimeout, int *pnBufXOff, int *pnBufYOff,
                         int *pnBufXSize, int *pnBufYSize) = 0;
    virtual int LockBuffer(double dfTimeout = -1.0);
    virtual void UnlockBuffer();
};
 
#endif