32 #ifndef GDAL_PRIV_H_INCLUDED
33 #define GDAL_PRIV_H_INCLUDED
50 class GDALProxyDataset;
51 class GDALProxyRasterBand;
61 #include "gdal_frmts.h"
66 #include "cpl_multiproc.h"
67 #include "cpl_atomic_ops.h"
83 #define GMO_VALID 0x0001
84 #define GMO_IGNORE_UNIMPLEMENTED 0x0002
85 #define GMO_SUPPORT_MD 0x0004
86 #define GMO_SUPPORT_MDMD 0x0008
87 #define GMO_MD_DIRTY 0x0010
88 #define GMO_PAM_CLASS 0x0020
96 class CPL_DLL GDALMultiDomainMetadata
99 char **papszDomainList;
103 GDALMultiDomainMetadata();
104 ~GDALMultiDomainMetadata();
106 int XMLInit(
CPLXMLNode *psMetadata,
int bMerge );
109 char **GetDomainList() {
return papszDomainList; }
111 char **GetMetadata(
const char * pszDomain =
"" );
112 CPLErr SetMetadata(
char ** papszMetadata,
113 const char * pszDomain =
"" );
114 const char *GetMetadataItem(
const char * pszName,
115 const char * pszDomain =
"" );
116 CPLErr SetMetadataItem(
const char * pszName,
117 const char * pszValue,
118 const char * pszDomain =
"" );
141 GDALMultiDomainMetadata oMDMD{};
145 char **BuildMetadataDomainList(
char** papszList,
151 int GetMOFlags()
const;
152 void SetMOFlags(
int nFlagsIn );
154 virtual const char *GetDescription()
const;
155 virtual void SetDescription(
const char * );
157 virtual char **GetMetadataDomainList();
159 virtual char **GetMetadata(
const char * pszDomain =
"" );
160 virtual CPLErr SetMetadata(
char ** papszMetadata,
161 const char * pszDomain =
"" );
162 virtual const char *GetMetadataItem(
const char * pszName,
163 const char * pszDomain =
"" );
164 virtual CPLErr SetMetadataItem(
const char * pszName,
165 const char * pszValue,
166 const char * pszDomain =
"" );
186 class CPL_DLL GDALDefaultOverviews
197 bool bCheckedForMask;
206 bool bCheckedForOverviews;
210 char **papszInitSiblingFiles;
213 GDALDefaultOverviews();
214 ~GDALDefaultOverviews();
216 void Initialize(
GDALDataset *poDSIn,
const char *pszName =
nullptr,
217 char **papszSiblingFiles =
nullptr,
218 int bNameIsOVR = FALSE );
220 void TransferSiblingFiles(
char** papszSiblingFiles );
228 int GetOverviewCount(
int nBand );
232 const char * pszResampling,
233 int nOverviews,
int * panOverviewList,
234 int nBands,
int * panBandList,
235 GDALProgressFunc pfnProgress,
236 void *pProgressData );
238 CPLErr BuildOverviewsSubDataset(
const char * pszPhysicalFile,
239 const char * pszResampling,
240 int nOverviews,
int * panOverviewList,
241 int nBands,
int * panBandList,
242 GDALProgressFunc pfnProgress,
243 void *pProgressData );
251 int GetMaskFlags(
int nBand );
253 int HaveMaskFile(
char **papszSiblings =
nullptr,
254 const char *pszBasename =
nullptr );
256 char** GetSiblingFiles() {
return papszInitSiblingFiles; }
270 bool bHasGotSiblingFiles;
271 char **papszSiblingFiles;
272 int nHeaderBytesTried;
276 const char *
const * papszSiblingFiles =
nullptr );
305 int TryToIngest(
int nBytes);
306 char **GetSiblingFiles();
307 char **StealSiblingFiles();
308 bool AreSiblingFilesLoaded()
const;
323 class swq_select_parse_options;
327 typedef struct GDALSQLParseInfo GDALSQLParseInfo;
331 #ifdef GDAL_COMPILATION
332 #define OPTIONAL_OUTSIDE_GDAL(val)
334 #define OPTIONAL_OUTSIDE_GDAL(val) = val
342 unsigned int nOpenFlags,
343 const char*
const* papszAllowedDrivers,
344 const char*
const* papszOpenOptions,
345 const char*
const* papszSiblingFiles );
349 friend class GDALDefaultOverviews;
350 friend class GDALProxyDataset;
353 CPL_INTERNAL
void AddToDatasetOpenList();
355 CPL_INTERNAL
static void ReportErrorV(
356 const char* pszDSName,
358 const char *fmt, va_list args);
365 int nRasterXSize = 512;
366 int nRasterYSize = 512;
373 bool bForceCachedIO =
false;
374 bool bShared =
false;
375 bool bIsInternal =
true;
376 bool bSuppressOnClose =
false;
378 mutable std::map<std::string, std::unique_ptr<OGRFieldDomain>> m_oMapFieldDomains{};
383 void RasterInitialize(
int,
int );
386 GDALDefaultOverviews oOvManager{};
388 virtual CPLErr IBuildOverviews(
const char *,
int,
int *,
389 int,
int *, GDALProgressFunc,
void * );
400 void BlockBasedFlushCache(
bool bAtClosing);
403 int nXOff,
int nYOff,
int nXSize,
int nYSize,
404 void * pData,
int nBufXSize,
int nBufYSize,
406 int nBandCount,
int *panBandMap,
412 int nXOff,
int nYOff,
int nXSize,
int nYSize,
413 void * pData,
int nBufXSize,
int nBufYSize,
415 int nBandCount,
int *panBandMap,
420 CPLErr ValidateRasterIOOrAdviseReadParameters(
421 const char* pszCallingFunc,
422 int* pbStopProcessingOnCENone,
423 int nXOff,
int nYOff,
int nXSize,
int nYSize,
424 int nBufXSize,
int nBufYSize,
425 int nBandCount,
int *panBandMap);
428 int nXOff,
int nYOff,
int nXSize,
int nYSize,
429 void * pData,
int nBufXSize,
int nBufYSize,
431 int nBandCount,
int *panBandMap,
437 void ShareLockWithParentDataset(
GDALDataset* poParentDataset);
440 virtual int CloseDependentDatasets();
442 int ValidateLayerCreationOptions(
const char*
const* papszLCO );
444 char **papszOpenOptions =
nullptr;
451 void LeaveReadWrite();
454 void TemporarilyDropReadWriteLock();
455 void ReacquireReadWriteLock();
457 void DisableReadWriteMutex();
466 int GetRasterXSize();
467 int GetRasterYSize();
468 int GetRasterCount();
480 class CPL_DLL Iterator
483 std::unique_ptr<Private> m_poPrivate;
486 Iterator(
const Iterator& oOther);
487 Iterator(Iterator&& oOther) noexcept;
490 Iterator& operator++();
491 bool operator!=(
const Iterator& it)
const;
496 const Iterator
begin()
const;
498 const Iterator
end()
const;
508 virtual void FlushCache(
bool bAtClosing =
false);
514 const char *GetProjectionRef(
void)
const;
515 CPLErr SetProjection(
const char * pszProjection );
517 virtual CPLErr GetGeoTransform(
double * padfTransform );
518 virtual CPLErr SetGeoTransform(
double * padfTransform );
521 char **papszOptions=
nullptr );
523 virtual void *GetInternalHandle(
const char * pszHandleName );
525 virtual char **GetFileList(
void);
527 virtual const char* GetDriverName();
530 virtual int GetGCPCount();
532 virtual CPLErr SetGCPs(
int nGCPCount,
const GDAL_GCP *pasGCPList,
536 const char *GetGCPProjection();
538 const char *pszGCPProjection );
540 virtual CPLErr AdviseRead(
int nXOff,
int nYOff,
int nXSize,
int nYSize,
541 int nBufXSize,
int nBufYSize,
543 int nBandCount,
int *panBandList,
544 char **papszOptions );
546 virtual CPLErr CreateMaskBand(
int nFlagsIn );
549 BeginAsyncReader(
int nXOff,
int nYOff,
int nXSize,
int nYSize,
550 void *pBuf,
int nBufXSize,
int nBufYSize,
552 int nBandCount,
int* panBandMap,
553 int nPixelSpace,
int nLineSpace,
int nBandSpace,
554 char **papszOptions);
558 struct RawBinaryLayout
560 enum class Interleaving
567 std::string osRawFilename{};
568 Interleaving eInterleaving = Interleaving::UNKNOWN;
570 bool bLittleEndianOrder =
false;
578 virtual bool GetRawBinaryLayout(RawBinaryLayout&);
586 OPTIONAL_OUTSIDE_GDAL(
nullptr)
599 int GetShared()
const;
610 static GDALDataset **GetOpenDatasets(
int *pnDatasetCount );
612 CPLErr BuildOverviews(
const char *,
int,
int *,
613 int,
int *, GDALProgressFunc,
void * );
618 static
void ReportError(const
char* pszDSName,
623 char ** GetMetadata(
const char * pszDomain =
"")
override;
628 const char * pszDomain )
override;
630 const char * pszValue,
631 const char * pszDomain )
override;
634 char **GetMetadataDomainList()
override;
636 virtual void ClearStatistics();
654 unsigned int nOpenFlags = 0,
655 const char*
const* papszAllowedDrivers =
nullptr,
656 const char*
const* papszOpenOptions =
nullptr,
657 const char*
const* papszSiblingFiles =
nullptr )
659 return FromHandle(
GDALOpenEx(pszFilename, nOpenFlags,
677 void SetEnableOverviews(
bool bEnable);
680 bool AreOverviewsEnabled()
const;
685 Private *m_poPrivate;
687 CPL_INTERNAL
OGRLayer* BuildLayerFromSelectInfo(swq_select* psSelectInfo,
689 const char *pszDialect,
690 swq_select_parse_options* poSelectParseOptions);
695 virtual int GetLayerCount();
696 virtual OGRLayer *GetLayer(
int iLayer);
698 virtual bool IsLayerPrivate(
int iLayer)
const;
719 std::unique_ptr<Private> m_poPrivate;
740 bool operator!=(
const Iterator& it)
const;
749 OGRLayer* operator[](
size_t iLayer);
750 OGRLayer* operator[](
const char* pszLayername);
755 virtual OGRLayer *GetLayerByName(
const char *);
756 virtual OGRErr DeleteLayer(
int iLayer);
758 virtual void ResetReading();
760 double* pdfProgressPct,
761 GDALProgressFunc pfnProgress,
762 void* pProgressData );
774 class CPL_DLL Iterator
777 std::unique_ptr<Private> m_poPrivate;
780 Iterator(
const Iterator& oOther);
781 Iterator(Iterator&& oOther) noexcept;
784 Iterator& operator++();
785 bool operator!=(
const Iterator& it)
const;
790 const Iterator
begin()
const;
792 const Iterator
end()
const;
797 virtual int TestCapability(
const char * );
799 virtual const OGRFieldDomain* GetFieldDomain(
const std::string& name)
const;
801 virtual bool AddFieldDomain(std::unique_ptr<OGRFieldDomain>&& domain,
802 std::string& failureReason);
804 virtual OGRLayer *CreateLayer(
const char *pszName,
807 char ** papszOptions =
nullptr );
809 const char *pszNewName,
810 char **papszOptions =
nullptr );
813 virtual void SetStyleTableDirectly(
OGRStyleTable *poStyleTable );
817 virtual OGRLayer * ExecuteSQL(
const char *pszStatement,
819 const char *pszDialect );
820 virtual void ReleaseResultSet(
OGRLayer * poResultsSet );
821 virtual OGRErr AbortSQL( );
823 int GetRefCount()
const;
824 int GetSummaryRefCount()
const;
827 virtual OGRErr StartTransaction(
int bForce=FALSE);
828 virtual OGRErr CommitTransaction();
829 virtual OGRErr RollbackTransaction();
831 virtual std::shared_ptr<GDALGroup> GetRootGroup()
const;
834 static int IsGenericSQLDialect(
const char* pszDialect);
837 GDALSQLParseInfo* BuildParseInfo(swq_select* psSelectInfo,
838 swq_select_parse_options* poSelectParseOptions);
839 static void DestroyParseInfo(GDALSQLParseInfo* psParseInfo );
840 OGRLayer * ExecuteSQL(
const char *pszStatement,
842 const char *pszDialect,
843 swq_select_parse_options* poSelectParseOptions);
847 virtual OGRLayer *ICreateLayer(
const char *pszName,
850 char ** papszOptions =
nullptr );
853 OGRErr ProcessSQLCreateIndex(
const char * );
854 OGRErr ProcessSQLDropIndex(
const char * );
855 OGRErr ProcessSQLDropTable(
const char * );
856 OGRErr ProcessSQLAlterTableAddColumn(
const char * );
857 OGRErr ProcessSQLAlterTableDropColumn(
const char * );
858 OGRErr ProcessSQLAlterTableAlterColumn(
const char * );
859 OGRErr ProcessSQLAlterTableRenameColumn(
const char * );
867 CPLErr OldSetGCPsFromNew(
int nGCPCount,
const GDAL_GCP *pasGCPList,
870 friend class GDALProxyPoolDataset;
871 virtual const char *_GetProjectionRef();
873 virtual const char *_GetGCPProjection();
875 virtual CPLErr _SetProjection(
const char * pszProjection );
876 virtual CPLErr _SetGCPs(
int nGCPCount,
const GDAL_GCP *pasGCPList,
877 const char *pszGCPProjection );
885 struct CPL_DLL GDALDatasetUniquePtrDeleter
909 friend class GDALAbstractBandBlockCache;
914 volatile int nLockCount;
931 CPL_INTERNAL
void Detach_unlocked(
void );
932 CPL_INTERNAL
void Touch_unlocked(
void );
934 CPL_INTERNAL
void RecycleFor(
int nXOffIn,
int nYOffIn );
941 CPLErr Internalize(
void );
943 void MarkDirty(
void );
944 void MarkClean(
void );
946 int AddLock(
void ) {
return CPLAtomicInc(&nLockCount); }
948 int DropLock(
void ) {
return CPLAtomicDec(&nLockCount); }
988 int DropLockForRemovalFromStorage();
994 static void FlushDirtyBlocks();
995 static int FlushCacheBlock(
int bDirtyBlocksOnly = FALSE);
996 static void Verify();
998 static void EnterDisableDirtyBlockFlush();
999 static void LeaveDisableDirtyBlockFlush();
1004 static void DumpAll();
1009 CPL_INTERNAL
static void DestroyRBMutex();
1026 std::vector<GDALColorEntry> aoEntries{};
1037 int GetColorEntryCount()
const;
1067 class GDALAbstractBandBlockCache
1070 CPLLock *hSpinLock =
nullptr;
1074 CPLCond *hCond =
nullptr;
1075 CPLMutex *hCondMutex =
nullptr;
1076 volatile int nKeepAliveCounter = 0;
1078 volatile int m_nDirtyBlocks = 0;
1085 int m_nInitialDirtyBlocksInFlushCache = 0;
1086 int m_nLastTick = -1;
1087 bool m_bWriteDirtyBlocks =
true;
1089 void FreeDanglingBlocks();
1090 void UnreferenceBlockBase();
1092 void StartDirtyBlockFlushingLog();
1093 void UpdateDirtyBlockFlushingLog();
1094 void EndDirtyBlockFlushingLog();
1098 virtual ~GDALAbstractBandBlockCache();
1102 void IncDirtyBlocks(
int nInc);
1103 void WaitCompletionPendingTasks();
1104 void DisableDirtyBlockWriting() { m_bWriteDirtyBlocks =
false; }
1106 virtual bool Init() = 0;
1107 virtual bool IsInitOK() = 0;
1108 virtual CPLErr FlushCache() = 0;
1111 int nYBlockYOff ) = 0;
1113 virtual CPLErr FlushBlock(
int nXBlockOff,
int nYBlockOff,
1114 int bWriteDirtyBlock ) = 0;
1117 GDALAbstractBandBlockCache* GDALArrayBandBlockCacheCreate(
GDALRasterBand* poBand);
1118 GDALAbstractBandBlockCache* GDALHashSetBandBlockCacheCreate(
GDALRasterBand* poBand);
1133 friend class GDALArrayBandBlockCache;
1134 friend class GDALHashSetBandBlockCache;
1138 CPLErr eFlushBlockErr = CE_None;
1139 GDALAbstractBandBlockCache* poBandBlockCache =
nullptr;
1141 CPL_INTERNAL
void SetFlushBlockErr(
CPLErr eErr );
1143 CPL_INTERNAL
void SetValidPercent(
GUIntBig nSampleCount,
GUIntBig nValidCount );
1144 CPL_INTERNAL
void IncDirtyBlocks(
int nInc);
1151 int nRasterXSize = 0;
1152 int nRasterYSize = 0;
1158 int nBlockXSize = -1;
1159 int nBlockYSize = -1;
1160 int nBlocksPerRow = 0;
1161 int nBlocksPerColumn = 0;
1163 int nBlockReads = 0;
1164 int bForceCachedIO = 0;
1167 bool bOwnMask =
false;
1170 void InvalidateMaskBand();
1172 friend class GDALProxyRasterBand;
1173 friend class GDALDefaultOverviews;
1180 void LeaveReadWrite();
1186 virtual CPLErr IWriteBlock(
int nBlockXOff,
int nBlockYOff,
void * pData );
1192 virtual int IGetDataCoverageStatus(
int nXOff,
int nYOff,
1193 int nXSize,
int nYSize,
1195 double* pdfDataPct);
1202 int nXOff,
int nYOff,
int nXSize,
int nYSize,
1203 void * pData,
int nBufXSize,
int nBufYSize,
1209 int InitBlockInfo();
1226 void GetBlockSize(
int *,
int * );
1227 CPLErr GetActualBlockSize (
int,
int,
int *,
int * );
1233 #ifndef DOXYGEN_SKIP
1234 OPTIONAL_OUTSIDE_GDAL(
nullptr)
1244 CPLErr FlushBlock(
int,
int,
int bWriteDirtyBlock = TRUE );
1246 unsigned char* GetIndexColorTranslationTo(
GDALRasterBand* poReferenceBand,
1247 unsigned char* pTranslationTable =
nullptr,
1248 int* pApproximateMatching =
nullptr);
1252 virtual CPLErr FlushCache(
bool bAtClosing =
false);
1253 virtual char **GetCategoryNames();
1254 virtual double GetNoDataValue(
int *pbSuccess =
nullptr );
1255 virtual double GetMinimum(
int *pbSuccess =
nullptr );
1256 virtual double GetMaximum(
int *pbSuccess =
nullptr );
1257 virtual double GetOffset(
int *pbSuccess =
nullptr );
1258 virtual double GetScale(
int *pbSuccess =
nullptr );
1259 virtual const char *GetUnitType();
1262 virtual CPLErr Fill(
double dfRealValue,
double dfImaginaryValue = 0);
1264 virtual CPLErr SetCategoryNames(
char ** papszNames );
1265 virtual CPLErr SetNoDataValue(
double dfNoData );
1266 virtual CPLErr DeleteNoDataValue();
1269 virtual CPLErr SetOffset(
double dfNewOffset );
1270 virtual CPLErr SetScale(
double dfNewScale );
1271 virtual CPLErr SetUnitType(
const char * pszNewValue );
1273 virtual CPLErr GetStatistics(
int bApproxOK,
int bForce,
1274 double *pdfMin,
double *pdfMax,
1275 double *pdfMean,
double *padfStdDev );
1276 virtual CPLErr ComputeStatistics(
int bApproxOK,
1277 double *pdfMin,
double *pdfMax,
1278 double *pdfMean,
double *pdfStdDev,
1279 GDALProgressFunc,
void *pProgressData );
1280 virtual CPLErr SetStatistics(
double dfMin,
double dfMax,
1281 double dfMean,
double dfStdDev );
1282 virtual CPLErr ComputeRasterMinMax(
int,
double* );
1287 const char * pszDomain )
override;
1289 const char * pszValue,
1290 const char * pszDomain )
override;
1293 virtual int HasArbitraryOverviews();
1294 virtual int GetOverviewCount();
1297 virtual CPLErr BuildOverviews(
const char * pszResampling,
1299 int * panOverviewList,
1300 GDALProgressFunc pfnProgress,
1301 void * pProgressData );
1303 virtual CPLErr AdviseRead(
int nXOff,
int nYOff,
int nXSize,
int nYSize,
1304 int nBufXSize,
int nBufYSize,
1307 virtual CPLErr GetHistogram(
double dfMin,
double dfMax,
1308 int nBuckets,
GUIntBig * panHistogram,
1309 int bIncludeOutOfRange,
int bApproxOK,
1310 GDALProgressFunc,
void *pProgressData );
1312 virtual CPLErr GetDefaultHistogram(
double *pdfMin,
double *pdfMax,
1313 int *pnBuckets,
GUIntBig ** ppanHistogram,
1315 GDALProgressFunc,
void *pProgressData);
1316 virtual CPLErr SetDefaultHistogram(
double dfMin,
double dfMax,
1317 int nBuckets,
GUIntBig *panHistogram );
1323 virtual int GetMaskFlags();
1324 virtual CPLErr CreateMaskBand(
int nFlagsIn );
1331 int GetDataCoverageStatus(
int nXOff,
int nYOff,
1332 int nXSize,
int nYSize,
1333 int nMaskFlagStop = 0,
1334 double* pdfDataPct =
nullptr );
1336 std::shared_ptr<GDALMDArray> AsMDArray()
const;
1366 CPLErr IReadBlock(
int,
int,
void * )
override;
1372 ~GDALAllValidMaskBand()
override;
1375 int GetMaskFlags()
override;
1377 CPLErr ComputeStatistics(
int bApproxOK,
1378 double *pdfMin,
double *pdfMax,
1379 double *pdfMean,
double *pdfStdDev,
1380 GDALProgressFunc,
void *pProgressData )
override;
1390 double dfNoDataValue;
1396 CPLErr IReadBlock(
int,
int,
void * )
override;
1403 ~GDALNoDataMaskBand()
override;
1405 static bool IsNoDataInRange(
double dfNoDataValue,
1415 double *padfNodataValues;
1420 CPLErr IReadBlock(
int,
int,
void * )
override;
1423 explicit GDALNoDataValuesMaskBand(
GDALDataset * );
1424 ~GDALNoDataValuesMaskBand()
override;
1447 ~GDALRescaledAlphaBand()
override;
1491 CPLErr SetMetadataItem(
const char * pszName,
1492 const char * pszValue,
1493 const char * pszDomain =
"" )
override;
1499 int nXSize,
int nYSize,
int nBands,
1502 GDALDataset *CreateMultiDimensional(
const char * pszName,
1506 CPLErr Delete(
const char * pszName );
1507 CPLErr Rename(
const char * pszNewName,
1508 const char * pszOldName );
1509 CPLErr CopyFiles(
const char * pszNewName,
1510 const char * pszOldName );
1514 GDALProgressFunc pfnProgress,
1526 int nXSize,
int nYSize,
int nBands,
1528 char ** papszOptions );
1531 int nXSize,
int nYSize,
int nBands,
1533 char ** papszOptions );
1535 GDALDataset *(*pfnCreateMultiDimensional)(
const char * pszName,
1539 CPLErr (*pfnDelete)(
const char * pszName );
1543 GDALProgressFunc pfnProgress,
1544 void * pProgressData );
1560 CPLErr (*pfnRename)(
const char * pszNewName,
1561 const char * pszOldName );
1562 CPLErr (*pfnCopyFiles)(
const char * pszNewName,
1563 const char * pszOldName );
1570 const char * pszName,
1571 char ** papszOptions );
1573 const char * pszName );
1582 GDALProgressFunc pfnProgress,
1585 static CPLErr DefaultCreateCopyMultiDimensional(
1590 GDALProgressFunc pfnProgress,
1591 void * pProgressData );
1600 GDALProgressFunc pfnProgress,
1601 void * pProgressData );
1603 static CPLErr QuietDelete(
const char * pszName,
1604 const char *
const *papszAllowedDrivers =
nullptr);
1607 static CPLErr DefaultRename(
const char * pszNewName,
1608 const char * pszOldName );
1609 static CPLErr DefaultCopyFiles(
const char * pszNewName,
1610 const char * pszOldName );
1623 {
return static_cast<GDALDriver*
>(hDriver); }
1644 std::map<CPLString, GDALDriver*> oMapNameToDrivers{};
1646 GDALDriver *GetDriver_unlocked(
int iDriver )
1647 {
return (iDriver >= 0 && iDriver < nDrivers) ?
1648 papoDrivers[iDriver] :
nullptr; }
1650 GDALDriver *GetDriverByName_unlocked(
const char * pszName )
1653 static char** GetSearchPaths(
const char* pszGDAL_DRIVER_PATH);
1655 static void CleanupPythonDrivers();
1663 int GetDriverCount(
void )
const;
1671 static void AutoLoadDrivers();
1672 void AutoSkipDrivers();
1674 static void AutoLoadPythonDrivers();
1776 int* pnBufXOff,
int* pnBufYOff,
1777 int* pnBufXSize,
int* pnBufYSize) = 0;
1778 virtual int LockBuffer(
double dfTimeout = -1.0 );
1779 virtual void UnlockBuffer();
1814 std::vector<std::unique_ptr<GDALEDTComponent>>&& components);
1826 const std::string&
GetName()
const {
return m_osName; }
1852 const std::vector<std::unique_ptr<GDALEDTComponent>>&
GetComponents()
const {
return m_aoComponents; }
1870 bool NeedsFreeDynamicMemory()
const;
1872 void FreeDynamicMemory(
void* pBuffer)
const;
1883 std::vector<std::unique_ptr<GDALEDTComponent>>&& components);
1885 std::string m_osName{};
1889 std::vector<std::unique_ptr<GDALEDTComponent>> m_aoComponents{};
1891 size_t m_nMaxStringLength = 0;
1916 const std::string&
GetName()
const {
return m_osName; }
1931 std::string m_osName;
1948 std::shared_ptr<GDALAttribute> GetAttributeFromAttributes(
const std::string& osName)
const;
1953 virtual std::shared_ptr<GDALAttribute> GetAttribute(
const std::string& osName)
const;
1955 virtual std::vector<std::shared_ptr<GDALAttribute>> GetAttributes(
CSLConstList papszOptions =
nullptr)
const;
1957 virtual std::shared_ptr<GDALAttribute> CreateAttribute(
1958 const std::string& osName,
1959 const std::vector<GUInt64>& anDimensions,
1980 std::string m_osName{};
1981 std::string m_osFullName{};
1983 GDALGroup(
const std::string& osParentName,
const std::string& osName);
1985 const GDALGroup* GetInnerMostGroup(
const std::string& osPathOrArrayOrDim,
1986 std::shared_ptr<GDALGroup>& curGroupHolder,
1987 std::string& osLastPart)
const;
1997 const std::string&
GetName()
const {
return m_osName; }
2005 virtual std::vector<std::string> GetMDArrayNames(
CSLConstList papszOptions =
nullptr)
const;
2006 virtual std::shared_ptr<GDALMDArray> OpenMDArray(
const std::string& osName,
2009 virtual std::vector<std::string> GetGroupNames(
CSLConstList papszOptions =
nullptr)
const;
2010 virtual std::shared_ptr<GDALGroup> OpenGroup(
const std::string& osName,
2013 virtual std::vector<std::string> GetVectorLayerNames(
CSLConstList papszOptions =
nullptr)
const;
2014 virtual OGRLayer* OpenVectorLayer(
const std::string& osName,
2017 virtual std::vector<std::shared_ptr<GDALDimension>> GetDimensions(
CSLConstList papszOptions =
nullptr)
const;
2019 virtual std::shared_ptr<GDALGroup> CreateGroup(
const std::string& osName,
2022 virtual std::shared_ptr<GDALDimension> CreateDimension(
const std::string& osName,
2023 const std::string& osType,
2024 const std::string& osDirection,
2028 virtual std::shared_ptr<GDALMDArray> CreateMDArray(
const std::string& osName,
2029 const std::vector<std::shared_ptr<GDALDimension>>& aoDimensions,
2033 GUInt64 GetTotalCopyCost()
const;
2035 virtual bool CopyFrom(
const std::shared_ptr<GDALGroup>& poDstRootGroup,
2037 const std::shared_ptr<GDALGroup>& poSrcGroup,
2041 GDALProgressFunc pfnProgress,
2042 void * pProgressData,
2047 std::shared_ptr<GDALMDArray> OpenMDArrayFromFullname(
2048 const std::string& osFullName,
2051 std::shared_ptr<GDALMDArray> ResolveMDArray(
const std::string& osName,
2052 const std::string& osStartingPath,
2055 std::shared_ptr<GDALGroup> OpenGroupFromFullname(
2056 const std::string& osFullName,
2059 std::shared_ptr<GDALDimension> OpenDimensionFromFullname(
2060 const std::string& osFullName)
const;
2062 virtual void ClearStatistics();
2065 static constexpr
GUInt64 COPY_COST = 1000;
2082 std::string m_osName{};
2083 std::string m_osFullName{};
2084 std::weak_ptr<GDALAbstractMDArray> m_pSelf{};
2088 void SetSelf(std::weak_ptr<GDALAbstractMDArray>
self) { m_pSelf =
self; }
2090 bool CheckReadWriteParams(
const GUInt64* arrayStartIdx,
2091 const size_t* count,
2092 const GInt64*& arrayStep,
2096 const void* buffer_alloc_start,
2097 size_t buffer_alloc_size,
2098 std::vector<GInt64>& tmp_arrayStep,
2099 std::vector<GPtrDiff_t>& tmp_bufferStride)
const;
2101 virtual bool IRead(
const GUInt64* arrayStartIdx,
2102 const size_t* count,
2106 void* pDstBuffer)
const = 0;
2108 virtual bool IWrite(
const GUInt64* arrayStartIdx,
2109 const size_t* count,
2113 const void* pSrcBuffer);
2123 const std::string&
GetName()
const{
return m_osName; }
2131 GUInt64 GetTotalElementsCount()
const;
2133 virtual size_t GetDimensionCount()
const;
2135 virtual const std::vector<std::shared_ptr<GDALDimension>>&
GetDimensions()
const = 0;
2139 virtual std::vector<GUInt64> GetBlockSize()
const;
2141 virtual std::vector<size_t> GetProcessingChunkSize(
size_t nMaxChunkMemory)
const;
2158 typedef bool (*FuncProcessPerChunkType)(
2160 const GUInt64* chunkArrayStartIdx,
2161 const size_t* chunkCount,
2166 virtual bool ProcessPerChunk(
const GUInt64* arrayStartIdx,
2168 const size_t* chunkSize,
2169 FuncProcessPerChunkType pfnFunc,
2172 virtual bool Read(
const GUInt64* arrayStartIdx,
2173 const size_t* count,
2178 const void* pDstBufferAllocStart =
nullptr,
2179 size_t nDstBufferAllocSize = 0)
const;
2181 bool Write(
const GUInt64* arrayStartIdx,
2182 const size_t* count,
2186 const void* pSrcBuffer,
2187 const void* pSrcBufferAllocStart =
nullptr,
2188 size_t nSrcBufferAllocSize = 0);
2232 size_t size()
const {
return m_nSize; }
2256 mutable std::string m_osCachedVal{};
2260 GDALAttribute(
const std::string& osParentName,
const std::string& osName);
2265 std::vector<GUInt64> GetDimensionsSize()
const;
2268 const char* ReadAsString()
const;
2269 int ReadAsInt()
const;
2270 double ReadAsDouble()
const;
2272 std::vector<int> ReadAsIntArray()
const;
2273 std::vector<double> ReadAsDoubleArray()
const;
2276 bool Write(
const void* pabyValue,
size_t nLen);
2277 bool Write(
const char*);
2281 bool Write(
const double*,
size_t);
2284 static constexpr
GUInt64 COPY_COST = 100;
2294 class CPL_DLL GDALAttributeString final:
public GDALAttribute
2296 std::vector<std::shared_ptr<GDALDimension>> m_dims{};
2298 std::string m_osValue;
2307 void* pDstBuffer)
const override;
2310 GDALAttributeString(
const std::string& osParentName,
2311 const std::string& osName,
2312 const std::string& osValue,
2315 const std::vector<std::shared_ptr<GDALDimension>>& GetDimensions()
const override;
2326 class CPL_DLL GDALAttributeNumeric final:
public GDALAttribute
2328 std::vector<std::shared_ptr<GDALDimension>> m_dims{};
2331 double m_dfValue = 0;
2332 std::vector<GUInt32> m_anValuesUInt32{};
2341 void* pDstBuffer)
const override;
2344 GDALAttributeNumeric(
const std::string& osParentName,
2345 const std::string& osName,
2347 GDALAttributeNumeric(
const std::string& osParentName,
2348 const std::string& osName,
2350 GDALAttributeNumeric(
const std::string& osParentName,
2351 const std::string& osName,
2352 const std::vector<GUInt32>& anValues);
2354 const std::vector<std::shared_ptr<GDALDimension>>& GetDimensions()
const override;
2374 friend class GDALMDArrayResampled;
2375 std::shared_ptr<GDALMDArray> GetView(
const std::vector<GUInt64>& indices)
const;
2377 inline std::shared_ptr<GDALMDArray> atInternal(std::vector<GUInt64>& indices)
const
2379 return GetView(indices);
2382 template<
typename... GUInt64VarArg>
2384 inline std::shared_ptr<GDALMDArray> atInternal(std::vector<GUInt64>& indices,
2385 GUInt64 idx, GUInt64VarArg... tail)
const
2387 indices.push_back(idx);
2388 return atInternal(indices, tail...);
2391 mutable bool m_bHasTriedCachedArray =
false;
2392 mutable std::shared_ptr<GDALMDArray> m_poCachedArray{};
2396 GDALMDArray(
const std::string& osParentName,
const std::string& osName);
2398 virtual bool IAdviseRead(
const GUInt64* arrayStartIdx,
2399 const size_t* count,
2402 virtual bool IsCacheable()
const {
return true; }
2404 virtual bool SetStatistics(
bool bApproxStats,
2405 double dfMin,
double dfMax,
2406 double dfMean,
double dfStdDev,
2409 static std::string MassageName(
const std::string& inputName);
2411 std::shared_ptr<GDALGroup> GetCacheRootGroup(
bool bCanCreate,
2412 std::string& osCacheFilenameOut)
const;
2417 GUInt64 GetTotalCopyCost()
const;
2424 GDALProgressFunc pfnProgress,
2425 void * pProgressData);
2442 virtual const std::string& GetUnit()
const;
2444 virtual bool SetUnit(
const std::string& osUnit);
2448 virtual std::shared_ptr<OGRSpatialReference> GetSpatialRef()
const;
2450 virtual const void* GetRawNoDataValue()
const;
2452 double GetNoDataValueAsDouble(
bool* pbHasNoData =
nullptr)
const;
2454 virtual bool SetRawNoDataValue(
const void* pRawNoData);
2456 bool SetNoDataValue(
double dfNoData);
2458 virtual double GetOffset(
bool* pbHasOffset =
nullptr,
GDALDataType* peStorageType =
nullptr)
const;
2460 virtual double GetScale(
bool* pbHasScale =
nullptr,
GDALDataType* peStorageType =
nullptr)
const;
2466 std::shared_ptr<GDALMDArray> GetView(
const std::string& viewExpr)
const;
2468 std::shared_ptr<GDALMDArray> operator[](
const std::string& fieldName)
const;
2481 template<
typename... GUInt64VarArg>
2484 std::shared_ptr<GDALMDArray>
at(
GUInt64 idx, GUInt64VarArg... tail)
const
2486 std::vector<GUInt64> indices;
2487 indices.push_back(idx);
2488 return atInternal(indices, tail...);
2491 virtual std::shared_ptr<GDALMDArray> Transpose(
const std::vector<int>& anMapNewAxisToOldAxis)
const;
2493 std::shared_ptr<GDALMDArray> GetUnscaled()
const;
2495 virtual std::shared_ptr<GDALMDArray> GetMask(
CSLConstList papszOptions)
const;
2497 std::shared_ptr<GDALMDArray>
2498 GetResampled(
const std::vector<std::shared_ptr<GDALDimension>>& apoNewDims,
2503 virtual GDALDataset* AsClassicDataset(
size_t iXDim,
size_t iYDim)
const;
2505 virtual CPLErr GetStatistics(
bool bApproxOK,
bool bForce,
2506 double *pdfMin,
double *pdfMax,
2507 double *pdfMean,
double *padfStdDev,
2509 GDALProgressFunc pfnProgress,
void *pProgressData );
2511 virtual bool ComputeStatistics(
bool bApproxOK,
2512 double *pdfMin,
double *pdfMax,
2513 double *pdfMean,
double *pdfStdDev,
2515 GDALProgressFunc,
void *pProgressData );
2517 virtual void ClearStatistics();
2519 virtual std::vector<std::shared_ptr<GDALMDArray>> GetCoordinateVariables()
const;
2521 bool AdviseRead(
const GUInt64* arrayStartIdx,
2522 const size_t* count,
2525 bool IsRegularlySpaced(
double& dfStart,
double& dfIncrement)
const;
2527 bool GuessGeoTransform(
size_t nDimX,
size_t nDimY,
bool bPixelIsPoint,
2528 double adfGeoTransform[6])
const;
2530 bool Cache(
CSLConstList papszOptions =
nullptr )
const;
2532 bool Read(
const GUInt64* arrayStartIdx,
2533 const size_t* count,
2538 const void* pDstBufferAllocStart =
nullptr,
2539 size_t nDstBufferAllocSize = 0) const override final;
2542 static constexpr
GUInt64 COPY_COST = 1000;
2544 bool CopyFromAllExceptValues(const
GDALMDArray* poSrcArray,
2548 GDALProgressFunc pfnProgress,
2549 void * pProgressData);
2555 m_nStartIdx(nStartIdx), m_nIncr(nIncr) {}
2560 std::string m_osFieldName{};
2564 std::vector<size_t> m_mapDimIdxToParentDimIdx{};
2565 std::vector<Range> m_parentRanges{} ;
2568 virtual std::shared_ptr<GDALMDArray> GetView(
const std::string& viewExpr,
2569 bool bRenameDimensions,
2570 std::vector<ViewSpec>& viewSpecs)
const;
2580 const size_t* count,
2592 class CPL_DLL GDALMDArrayRegularlySpaced:
public GDALMDArray
2595 double m_dfIncrement;
2596 double m_dfOffsetInIncrement;
2598 std::vector<std::shared_ptr<GDALDimension>> m_dims;
2599 std::vector<std::shared_ptr<GDALAttribute>> m_attributes{};
2600 std::string m_osEmptyFilename{};
2609 void* pDstBuffer)
const override;
2612 GDALMDArrayRegularlySpaced(
2613 const std::string& osParentName,
2614 const std::string& osName,
2615 const std::shared_ptr<GDALDimension>& poDim,
2616 double dfStart,
double dfIncrement,
2617 double dfOffsetInIncrement);
2619 bool IsWritable()
const override {
return false; }
2621 const std::string& GetFilename()
const override {
return m_osEmptyFilename; }
2623 const std::vector<std::shared_ptr<GDALDimension>>& GetDimensions()
const override;
2627 std::vector<std::shared_ptr<GDALAttribute>> GetAttributes(
CSLConstList)
const override;
2629 void AddAttribute(
const std::shared_ptr<GDALAttribute>& poAttr);
2653 const std::string& osName,
2654 const std::string& osType,
2655 const std::string& osDirection,
2665 const std::string&
GetName()
const {
return m_osName; }
2681 const std::string&
GetType()
const {
return m_osType; }
2699 virtual std::shared_ptr<GDALMDArray> GetIndexingVariable()
const;
2701 virtual bool SetIndexingVariable(std::shared_ptr<GDALMDArray> poIndexingVariable);
2705 std::string m_osName;
2706 std::string m_osFullName;
2707 std::string m_osType;
2708 std::string m_osDirection;
2719 class CPL_DLL GDALDimensionWeakIndexingVar:
public GDALDimension
2721 std::weak_ptr<GDALMDArray> m_poIndexingVariable{};
2724 GDALDimensionWeakIndexingVar(
const std::string& osParentName,
2725 const std::string& osName,
2726 const std::string& osType,
2727 const std::string& osDirection,
2730 std::shared_ptr<GDALMDArray> GetIndexingVariable()
const override;
2732 bool SetIndexingVariable(std::shared_ptr<GDALMDArray> poIndexingVariable)
override;
2741 struct GDALAntiRecursionStruct;
2742 class GDALAntiRecursionGuard
2744 GDALAntiRecursionStruct* m_psAntiRecursionStruct;
2745 std::string m_osIdentifier;
2748 GDALAntiRecursionGuard(
const GDALAntiRecursionGuard&) =
delete;
2749 GDALAntiRecursionGuard& operator= (
const GDALAntiRecursionGuard&) =
delete;
2752 explicit GDALAntiRecursionGuard(
const std::string& osIdentifier);
2753 GDALAntiRecursionGuard(
const GDALAntiRecursionGuard& other,
const std::string& osIdentifier);
2754 ~GDALAntiRecursionGuard();
2755 int GetCallDepth()
const {
return m_nDepth; }
2767 GDALRegenerateOverviewsMultiBand(
int nBands,
GDALRasterBand** papoSrcBands,
2770 const char * pszResampling,
2771 GDALProgressFunc pfnProgress,
void * pProgressData );
2773 typedef CPLErr (*GDALResampleFunction)
2774 (
double dfXRatioDstToSrc,
2775 double dfYRatioDstToSrc,
2779 const void * pChunk,
2780 const GByte * pabyChunkNodataMask,
2781 int nChunkXOff,
int nChunkXSize,
2782 int nChunkYOff,
int nChunkYSize,
2783 int nDstXOff,
int nDstXOff2,
2784 int nDstYOff,
int nDstYOff2,
2788 const char * pszResampling,
2789 int bHasNoData,
float fNoDataValue,
2792 bool bPropagateNoData );
2794 GDALResampleFunction GDALGetResampleFunction(
const char* pszResampling,
2797 GDALDataType GDALGetOvrWorkDataType(
const char* pszResampling,
2803 HFAAuxBuildOverviews(
const char *pszOvrFilename,
GDALDataset *poParentDS,
2805 int nBands,
int *panBandList,
2806 int nNewOverviews,
int *panNewOverviewList,
2807 const char *pszResampling,
2808 GDALProgressFunc pfnProgress,
2809 void *pProgressData );
2812 GTIFFBuildOverviews(
const char * pszFilename,
2814 int nOverviews,
int * panOverviewList,
2815 const char * pszResampling,
2816 GDALProgressFunc pfnProgress,
void * pProgressData );
2819 int &nXOff,
int &nYOff,
2820 int &nXSize,
int &nYSize,
2821 int nBufXSize,
int nBufYSize) CPL_WARN_DEPRECATED(
"Use GDALBandGetBestOverviewLevel2 instead");
2822 int CPL_DLL GDALBandGetBestOverviewLevel2(
GDALRasterBand* poBand,
2823 int &nXOff,
int &nYOff,
2824 int &nXSize,
int &nYSize,
2825 int nBufXSize,
int nBufYSize,
2828 int CPL_DLL GDALOvLevelAdjust(
int nOvLevel,
int nXSize ) CPL_WARN_DEPRECATED(
"Use GDALOvLevelAdjust2 instead");
2829 int CPL_DLL GDALOvLevelAdjust2(
int nOvLevel,
int nXSize,
int nYSize );
2830 int CPL_DLL GDALComputeOvFactor(
int nOvrXSize,
int nRasterXSize,
2831 int nOvrYSize,
int nRasterYSize );
2834 GDALFindAssociatedAuxFile(
const char *pszBasefile,
GDALAccess eAccess,
2841 int CPL_DLL GDALCheckDatasetDimensions(
int nXSize,
int nYSize );
2842 int CPL_DLL GDALCheckBandCount(
int nBands,
int bIsZeroAllowed );
2847 int CPL_DLL GDALReadWorldFile2(
const char *pszBaseFilename,
const char *pszExtension,
2848 double *padfGeoTransform,
char** papszSiblingFiles,
2849 char** ppszWorldFileNameOut);
2850 int GDALReadTabFile2(
const char * pszBaseFilename,
2851 double *padfGeoTransform,
char **ppszWKT,
2852 int *pnGCPCount,
GDAL_GCP **ppasGCPs,
2853 char** papszSiblingFiles,
char** ppszTabFileNameOut );
2860 void GDALNullifyOpenDatasetsList();
2861 CPLMutex** GDALGetphDMMutex();
2862 CPLMutex** GDALGetphDLMutex();
2863 void GDALNullifyProxyPoolSingleton();
2864 void GDALSetResponsiblePIDForCurrentThread(
GIntBig responsiblePID);
2865 GIntBig GDALGetResponsiblePIDForCurrentThread();
2867 CPLString GDALFindAssociatedFile(
const char *pszBasename,
const char *pszExt,
2870 CPLErr CPL_DLL EXIFExtractMetadata(
char**& papszMetadata,
2871 void *fpL,
int nOffset,
2872 int bSwabflag,
int nTIFFHEADER,
2873 int& nExifOffset,
int& nInterOffset,
int& nGPSOffset);
2876 const char*
const* papszOptionOptions);
2877 int GDALValidateOptions(
const char* pszOptionList,
2878 const char*
const* papszOptionsToValidate,
2879 const char* pszErrorMessageOptionType,
2880 const char* pszErrorMessageContainerName);
2886 int nXSize,
int nYSize,
2887 int nBufXSize,
int nBufYSize);
2891 int bThisLevelOnly);
2896 template<
class T>
inline bool ARE_REAL_EQUAL(T fVal1, T fVal2,
int ulp = 2)
2898 return fVal1 == fVal2 ||
2899 std::abs(fVal1 - fVal2) < std::numeric_limits<float>::epsilon() * std::abs(fVal1+fVal2) * ulp;
2902 double GDALAdjustNoDataCloseToFloatMax(
double dfVal);
2904 #define DIV_ROUND_UP(a, b) ( ((a) % (b)) == 0 ? ((a) / (b)) : (((a) / (b)) + 1) )
2908 #define GDALSTAT_APPROX_NUMSAMPLES 2500
2910 void GDALSerializeGCPListToXML(
CPLXMLNode* psParentNode,
2914 void GDALDeserializeGCPListFromXML(
CPLXMLNode* psGCPList,
2919 void GDALSerializeOpenOptionsToXML(
CPLXMLNode* psParentNode,
char** papszOpenOptions);
2920 char** GDALDeserializeOpenOptionsFromXML(
CPLXMLNode* psParentNode );
2922 int GDALCanFileAcceptSidecarFile(
const char* pszFilename);
2924 bool GDALCanReliablyUseSiblingFileList(
const char* pszFilename);
2926 bool CPL_DLL GDALIsDriverDeprecatedForGDAL35StillEnabled(
const char* pszDriverName,
const char* pszExtraMsg =
"");
2933 } GDALBufferSampleFormat;
2935 bool CPL_DLL GDALBufferHasOnlyNoData(
const void* pBuffer,
2936 double dfNoDataValue,
2937 size_t nWidth,
size_t nHeight,
2941 GDALBufferSampleFormat nSampleFormat);
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:442
Convenient string class based on std::string.
Definition: cpl_string.h:333
CPLString & toupper(void)
Convert to upper case in place.
Definition: cplstring.cpp:316
Abstract class, implemented by GDALAttribute and GDALMDArray.
Definition: gdal_priv.h:2079
virtual const std::vector< std::shared_ptr< GDALDimension > > & GetDimensions() const =0
Return the dimensions of an attribute/array.
virtual const GDALExtendedDataType & GetDataType() const =0
Return the data type of an attribute/array.
const std::string & GetFullName() const
Return the name of an array or attribute.
Definition: gdal_priv.h:2129
const std::string & GetName() const
Return the name of an array or attribute.
Definition: gdal_priv.h:2123
bool Write(const GUInt64 *arrayStartIdx, const size_t *count, const GInt64 *arrayStep, const GPtrDiff_t *bufferStride, const GDALExtendedDataType &bufferDataType, const void *pSrcBuffer, const void *pSrcBufferAllocStart=nullptr, size_t nSrcBufferAllocSize=0)
Write part or totality of a multidimensional array or attribute.
Definition: gdalmultidim.cpp:1841
Class used as a session object for asynchronous requests.
Definition: gdal_priv.h:1691
void * GetBuffer()
Return buffer.
Definition: gdal_priv.h:1740
int GetXOffset() const
Return x offset.
Definition: gdal_priv.h:1724
int GetYOffset() const
Return y offset.
Definition: gdal_priv.h:1728
int GetYSize() const
Return height.
Definition: gdal_priv.h:1736
int GetBandCount() const
Return band count.
Definition: gdal_priv.h:1756
GDALDataType GetBufferType() const
Return buffer data type.
Definition: gdal_priv.h:1752
int GetBandSpace() const
Return band spacing.
Definition: gdal_priv.h:1772
int GetBufferYSize() const
Return buffer height.
Definition: gdal_priv.h:1748
int GetXSize() const
Return width.
Definition: gdal_priv.h:1732
GDALDataset * GetGDALDataset()
Return dataset.
Definition: gdal_priv.h:1720
virtual GDALAsyncStatusType GetNextUpdatedRegion(double dfTimeout, int *pnBufXOff, int *pnBufYOff, int *pnBufXSize, int *pnBufYSize)=0
Get async IO update.
int GetPixelSpace() const
Return pixel spacing.
Definition: gdal_priv.h:1764
int * GetBandMap()
Return band map.
Definition: gdal_priv.h:1760
int GetLineSpace() const
Return line spacing.
Definition: gdal_priv.h:1768
int GetBufferXSize() const
Return buffer width.
Definition: gdal_priv.h:1744
Class modeling an attribute that has a name, a value and a type, and is typically used to describe a ...
Definition: gdal_priv.h:2255
A color table / palette.
Definition: gdal_priv.h:1023
static GDALColorTableH ToHandle(GDALColorTable *poCT)
Convert a GDALColorTable* to a GDALRasterBandH.
Definition: gdal_priv.h:1047
static GDALColorTable * FromHandle(GDALColorTableH hCT)
Convert a GDALColorTableH to a GDALColorTable*.
Definition: gdal_priv.h:1053
~GDALColorTable()
Destructor.
Class returned by GetBands() that act as a container for raster bands.
Definition: gdal_priv.h:473
Class returned by GetFeatures() that act as a container for vector features.
Definition: gdal_priv.h:767
Layer iterator.
Definition: gdal_priv.h:717
void pointer
pointer
Definition: gdal_priv.h:725
void difference_type
difference_type
Definition: gdal_priv.h:724
std::input_iterator_tag iterator_category
iterator_category
Definition: gdal_priv.h:726
Class returned by GetLayers() that acts as a range of layers.
Definition: gdal_priv.h:704
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:340
virtual int CloseDependentDatasets()
Drop references to any other datasets referenced by this dataset.
Definition: gdaldataset.cpp:4114
static GDALDataset * FromHandle(GDALDatasetH hDS)
Convert a GDALDatasetH to a GDALDataset*.
Definition: gdal_priv.h:647
CPLErr BuildOverviews(const char *, int, int *, int, int *, GDALProgressFunc, void *)
Build raster overview(s)
Definition: gdaldataset.cpp:1950
virtual CPLErr CreateMaskBand(int nFlagsIn)
Adds a mask band to the dataset.
Definition: gdaldataset.cpp:3117
void MarkSuppressOnClose()
Set that the dataset must be deleted on close.
Definition: gdal_priv.h:603
static GDALDataset * Open(const char *pszFilename, unsigned int nOpenFlags=0, const char *const *papszAllowedDrivers=nullptr, const char *const *papszOpenOptions=nullptr, const char *const *papszSiblingFiles=nullptr)
Definition: gdal_priv.h:653
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
char ** GetOpenOptions()
Return open options.
Definition: gdal_priv.h:608
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
static GDALDatasetH ToHandle(GDALDataset *poDS)
Convert a GDALDataset* to a GDALDatasetH.
Definition: gdal_priv.h:641
GDALAccess GetAccess() const
Return access mode.
Definition: gdal_priv.h:597
Class modeling a a dimension / axis used to index multidimensional arrays.
Definition: gdal_priv.h:2649
const std::string & GetName() const
Return the name.
Definition: gdal_priv.h:2665
const std::string & GetType() const
Return the axis type.
Definition: gdal_priv.h:2681
const std::string & GetDirection() const
Return the axis direction.
Definition: gdal_priv.h:2691
GUInt64 GetSize() const
Return the size, that is the number of values along the dimension.
Definition: gdal_priv.h:2697
const std::string & GetFullName() const
Return the full name.
Definition: gdal_priv.h:2671
Class for managing the registration of file format drivers.
Definition: gdal_priv.h:1641
Format specific driver.
Definition: gdal_priv.h:1486
static GDALDriver * FromHandle(GDALDriverH hDriver)
Convert a GDALDriverH to a GDALDriver*.
Definition: gdal_priv.h:1622
static GDALDriverH ToHandle(GDALDriver *poDriver)
Convert a GDALDriver* to a GDALDriverH.
Definition: gdal_priv.h:1616
Class for a component of a compound extended data type.
Definition: gdal_priv.h:1904
const std::string & GetName() const
Return the name.
Definition: gdal_priv.h:1916
size_t GetOffset() const
Return the offset (in bytes) of the component in the compound data type.
Definition: gdal_priv.h:1922
const GDALExtendedDataType & GetType() const
Return the data type of the component.
Definition: gdal_priv.h:1928
GDALEDTComponent(const GDALEDTComponent &)
Copy constructor.
Class used to represent potentially complex data types.
Definition: gdal_priv.h:1803
GDALExtendedDataTypeSubType GetSubType() const
Return subtype.
Definition: gdal_priv.h:1846
size_t GetSize() const
Return data type size in bytes.
Definition: gdal_priv.h:1860
size_t GetMaxStringLength() const
Return the maximum length of a string in bytes.
Definition: gdal_priv.h:1866
static GDALExtendedDataType Create(GDALDataType eType)
Return a new GDALExtendedDataType of class GEDTC_NUMERIC.
Definition: gdalmultidim.cpp:7716
const std::vector< std::unique_ptr< GDALEDTComponent > > & GetComponents() const
Return the components of the data type (only valid when GetClass() == GEDTC_COMPOUND)
Definition: gdal_priv.h:1852
static GDALExtendedDataType CreateString(size_t nMaxStringLength=0, GDALExtendedDataTypeSubType eSubType=GEDTST_NONE)
Return a new GDALExtendedDataType of class GEDTC_STRING.
Definition: gdalmultidim.cpp:7780
GDALDataType GetNumericDataType() const
Return numeric data type (only valid when GetClass() == GEDTC_NUMERIC)
Definition: gdal_priv.h:1838
GDALExtendedDataTypeClass GetClass() const
Return type class.
Definition: gdal_priv.h:1832
const std::string & GetName() const
Return type name.
Definition: gdal_priv.h:1826
Class modeling a named container of GDALAttribute, GDALMDArray, OGRLayer or other GDALGroup.
Definition: gdal_priv.h:1977
const std::string & GetName() const
Return the name of the group.
Definition: gdal_priv.h:1997
const std::string & GetFullName() const
Return the full name of the group.
Definition: gdal_priv.h:2003
Interface used to get a single GDALAttribute or a set of GDALAttribute.
Definition: gdal_priv.h:1946
Class modeling a multi-dimensional array.
Definition: gdal_priv.h:2373
virtual bool IsWritable() const =0
Return whether an array is writable.
virtual const std::string & GetFilename() const =0
Return the filename that contains that array.
std::shared_ptr< GDALMDArray > at(GUInt64 idx, GUInt64VarArg... tail) const
Return a view of the array using integer indexing.
Definition: gdal_priv.h:2484
Object with metadata.
Definition: gdal_priv.h:136
static GDALMajorObjectH ToHandle(GDALMajorObject *poMajorObject)
Convert a GDALMajorObject* to a GDALMajorObjectH.
Definition: gdal_priv.h:171
static GDALMajorObject * FromHandle(GDALMajorObjectH hMajorObject)
Convert a GDALMajorObjectH to a GDALMajorObject*.
Definition: gdal_priv.h:177
Class for dataset open functions.
Definition: gdal_priv.h:269
int bStatOK
Whether stat()'ing the file was successful.
Definition: gdal_priv.h:290
GByte * pabyHeader
Buffer with first bytes of the file.
Definition: gdal_priv.h:300
int bIsDirectory
Whether the file is a directory.
Definition: gdal_priv.h:292
char ** papszOpenOptions
Open options.
Definition: gdal_priv.h:282
GDALAccess eAccess
Access flag.
Definition: gdal_priv.h:285
int nOpenFlags
Open flags.
Definition: gdal_priv.h:287
VSILFILE * fpL
Pointer to the file.
Definition: gdal_priv.h:295
char * pszFilename
Filename.
Definition: gdal_priv.h:280
int nHeaderBytes
Number of bytes in pabyHeader.
Definition: gdal_priv.h:298
const char *const * papszAllowedDrivers
Allowed drivers (NULL for all)
Definition: gdal_priv.h:303
The GDALRasterAttributeTable (or RAT) class is used to encapsulate a table used to provide attribute ...
Definition: gdal_rat.h:48
A single raster band (or channel).
Definition: gdal_priv.h:1131
void static GDALRasterBandH ToHandle(GDALRasterBand *poBand)
Convert a GDALRasterBand* to a GDALRasterBandH.
Definition: gdal_priv.h:1345
virtual CPLErr IRasterIO(GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, GSpacing, GSpacing, GDALRasterIOExtraArg *psExtraArg)
Read/write a region of image data for this band.
Definition: rasterio.cpp:209
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
virtual CPLErr IReadBlock(int nBlockXOff, int nBlockYOff, void *pData)=0
Read a block of data.
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
static GDALRasterBand * FromHandle(GDALRasterBandH hBand)
Convert a GDALRasterBandH to a GDALRasterBand*.
Definition: gdal_priv.h:1351
A single raster block in the block cache.
Definition: gdal_priv.h:908
int GetDirty() const
Return the dirty flag.
Definition: gdal_priv.h:976
int GetXSize() const
Return the width of the block.
Definition: gdal_priv.h:968
GPtrDiff_t GetBlockSize() const
Return the block size in bytes.
Definition: gdal_priv.h:984
int GetYSize() const
Return the height of the block.
Definition: gdal_priv.h:972
GDALDataType GetDataType() const
Return the data type.
Definition: gdal_priv.h:956
int GetXOff() const
Return the x offset of the top-left corner of the block.
Definition: gdal_priv.h:960
int AddLock(void)
Increment the lock count.
Definition: gdal_priv.h:946
GDALRasterBand * GetBand()
Accessor to source GDALRasterBand object.
Definition: gdal_priv.h:992
int GetYOff() const
Return the y offset of the top-left corner of the block.
Definition: gdal_priv.h:964
int DropLock(void)
Decrement the lock count.
Definition: gdal_priv.h:948
void * GetDataRef(void)
Return the data buffer.
Definition: gdal_priv.h:980
Store the raw result of an attribute value, which might contain dynamically allocated structures (lik...
Definition: gdal_priv.h:2202
size_t size() const
Return the size in bytes of the raw result.
Definition: gdal_priv.h:2232
const GByte * data() const
Return pointer to the start of data.
Definition: gdal_priv.h:2230
const GByte & operator[](size_t idx) const
Return byte at specified index.
Definition: gdal_priv.h:2228
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:371
Definition of a field domain.
Definition: ogr_feature.h:836
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:327
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:71
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:158
This class represents a style table.
Definition: ogr_featurestyle.h:85
Various convenience functions for CPL.
CPLErr
Error category.
Definition: cpl_error.h:53
int CPLErrorNum
Error number.
Definition: cpl_error.h:94
Definitions for CPL mini XML Parser/Serializer.
#define CPL_NULL_TERMINATED
Null terminated variadic.
Definition: cpl_port.h:859
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:247
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:331
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:329
GIntBig GInt64
Signed 64 bit integer type.
Definition: cpl_port.h:263
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:869
GIntBig GPtrDiff_t
Integer type large enough to hold the difference between 2 addresses.
Definition: cpl_port.h:282
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:955
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1169
GUIntBig GUInt64
Unsigned 64 bit integer type.
Definition: cpl_port.h:265
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:894
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:244
Various convenience functions for working with strings and string lists.
struct CPLVirtualMem CPLVirtualMem
Opaque type that represents a virtual memory mapping.
Definition: cpl_virtualmem.h:62
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:156
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:140
Public (C callable) GDAL entry points.
GIntBig GSpacing
Type to express pixel, line or band spacing.
Definition: gdal.h:286
GDALAccess
Definition: gdal.h:115
@ GA_ReadOnly
Definition: gdal.h:116
void GDALClose(GDALDatasetH)
Close GDAL dataset.
Definition: gdaldataset.cpp:3727
GDALPaletteInterp
Definition: gdal.h:230
@ GPI_RGB
Definition: gdal.h:232
GDALDataType
Definition: gdal.h:62
@ GDT_Byte
Definition: gdal.h:64
@ GDT_Float64
Definition: gdal.h:72
@ GDT_Unknown
Definition: gdal.h:63
void * GDALDatasetH
Opaque type used for the C bindings of the C++ GDALDataset class.
Definition: gdal.h:268
GDALExtendedDataTypeClass
Enumeration giving the class of a GDALExtendedDataType.
Definition: gdal.h:291
@ GEDTC_NUMERIC
Numeric value.
Definition: gdal.h:293
GDALRIOResampleAlg
RasterIO() resampling method.
Definition: gdal.h:131
int GDALGetDataTypeSizeBytes(GDALDataType)
Get data type size in bytes.
Definition: gdal_misc.cpp:308
GDALDatasetH GDALOpenEx(const char *pszFilename, unsigned int nOpenFlags, const char *const *papszAllowedDrivers, const char *const *papszOpenOptions, const char *const *papszSiblingFiles)
Open a raster or vector file as a GDALDataset.
Definition: gdaldataset.cpp:3308
GDALExtendedDataTypeSubType
Enumeration giving the subtype of a GDALExtendedDataType.
Definition: gdal.h:303
@ GEDTST_NONE
None.
Definition: gdal.h:305
void * GDALMajorObjectH
Opaque type used for the C bindings of the C++ GDALMajorObject class.
Definition: gdal.h:265
GDALColorInterp
Definition: gdal.h:204
GDALAsyncStatusType
status of the asynchronous stream
Definition: gdal.h:103
void * GDALDriverH
Opaque type used for the C bindings of the C++ GDALDriver class.
Definition: gdal.h:274
GDALRWFlag
Definition: gdal.h:121
void * GDALRasterBandH
Opaque type used for the C bindings of the C++ GDALRasterBand class.
Definition: gdal.h:271
void * GDALColorTableH
Opaque type used for the C bindings of the C++ GDALColorTable class.
Definition: gdal.h:277
std::unique_ptr< GDALDataset, GDALDatasetUniquePtrDeleter > GDALDatasetUniquePtr
Unique pointer type for GDALDataset.
Definition: gdal_priv.h:897
GDALDriverManager * GetGDALDriverManager(void)
Fetch the global GDAL driver manager.
Definition: gdaldrivermanager.cpp:99
GDALIdentifyEnum
Enumeration used by GDALDriver::pfnIdentify().
Definition: gdal_priv.h:1461
@ GDAL_IDENTIFY_TRUE
Identify determined the file is recognized by the probed driver.
Definition: gdal_priv.h:1467
@ GDAL_IDENTIFY_FALSE
Identify determined the file is not recognized by the probed driver.
Definition: gdal_priv.h:1465
@ GDAL_IDENTIFY_UNKNOWN
Identify could not determine if the file is recognized or not by the probed driver.
Definition: gdal_priv.h:1463
Core portability services for cross-platform OGR code.
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:346
@ wkbUnknown
unknown type, non-standard
Definition: ogr_core.h:347
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:318
std::unique_ptr< OGRFeature, OGRFeatureUniquePtrDeleter > OGRFeatureUniquePtr
Unique pointer type for OGRFeature.
Definition: ogr_feature.h:796
OGRLayer::FeatureIterator begin(OGRLayer *poLayer)
Return begin of feature iterator.
Definition: ogrsf_frmts.h:287
OGRLayer::FeatureIterator end(OGRLayer *poLayer)
Return end of feature iterator.
Definition: ogrsf_frmts.h:292
Document node structure.
Definition: cpl_minixml.h:70
Color tuple.
Definition: gdal.h:1287
Object returned by GetFeatures() iterators.
Definition: gdal_priv.h:667
Ground Control Point.
Definition: gdal.h:711