Go to the documentation of this file.
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"
81 #define GMO_VALID 0x0001
82 #define GMO_IGNORE_UNIMPLEMENTED 0x0002
83 #define GMO_SUPPORT_MD 0x0004
84 #define GMO_SUPPORT_MDMD 0x0008
85 #define GMO_MD_DIRTY 0x0010
86 #define GMO_PAM_CLASS 0x0020
94 class CPL_DLL GDALMultiDomainMetadata
97 char **papszDomainList;
101 GDALMultiDomainMetadata();
102 ~GDALMultiDomainMetadata();
104 int XMLInit(
CPLXMLNode *psMetadata,
int bMerge );
107 char **GetDomainList() {
return papszDomainList; }
109 char **GetMetadata(
const char * pszDomain =
"" );
110 CPLErr SetMetadata(
char ** papszMetadata,
111 const char * pszDomain =
"" );
112 const char *GetMetadataItem(
const char * pszName,
113 const char * pszDomain =
"" );
114 CPLErr SetMetadataItem(
const char * pszName,
115 const char * pszValue,
116 const char * pszDomain =
"" );
139 GDALMultiDomainMetadata oMDMD{};
143 char **BuildMetadataDomainList(
char** papszList,
149 int GetMOFlags()
const;
150 void SetMOFlags(
int nFlagsIn );
152 virtual const char *GetDescription()
const;
153 virtual void SetDescription(
const char * );
155 virtual char **GetMetadataDomainList();
157 virtual char **GetMetadata(
const char * pszDomain =
"" );
158 virtual CPLErr SetMetadata(
char ** papszMetadata,
159 const char * pszDomain =
"" );
160 virtual const char *GetMetadataItem(
const char * pszName,
161 const char * pszDomain =
"" );
162 virtual CPLErr SetMetadataItem(
const char * pszName,
163 const char * pszValue,
164 const char * pszDomain =
"" );
184 class CPL_DLL GDALDefaultOverviews
195 bool bCheckedForMask;
204 bool bCheckedForOverviews;
208 char **papszInitSiblingFiles;
211 GDALDefaultOverviews();
212 ~GDALDefaultOverviews();
214 void Initialize(
GDALDataset *poDSIn,
const char *pszName =
nullptr,
215 char **papszSiblingFiles =
nullptr,
216 int bNameIsOVR = FALSE );
218 void TransferSiblingFiles(
char** papszSiblingFiles );
226 int GetOverviewCount(
int nBand );
230 const char * pszResampling,
231 int nOverviews,
int * panOverviewList,
232 int nBands,
int * panBandList,
233 GDALProgressFunc pfnProgress,
234 void *pProgressData );
236 CPLErr BuildOverviewsSubDataset(
const char * pszPhysicalFile,
237 const char * pszResampling,
238 int nOverviews,
int * panOverviewList,
239 int nBands,
int * panBandList,
240 GDALProgressFunc pfnProgress,
241 void *pProgressData );
249 int GetMaskFlags(
int nBand );
251 int HaveMaskFile(
char **papszSiblings =
nullptr,
252 const char *pszBasename =
nullptr );
254 char** GetSiblingFiles() {
return papszInitSiblingFiles; }
268 bool bHasGotSiblingFiles;
269 char **papszSiblingFiles;
270 int nHeaderBytesTried;
274 const char *
const * papszSiblingFiles =
nullptr );
303 int TryToIngest(
int nBytes);
304 char **GetSiblingFiles();
305 char **StealSiblingFiles();
306 bool AreSiblingFilesLoaded()
const;
321 class swq_select_parse_options;
325 typedef struct GDALSQLParseInfo GDALSQLParseInfo;
329 #ifdef GDAL_COMPILATION
330 #define OPTIONAL_OUTSIDE_GDAL(val)
332 #define OPTIONAL_OUTSIDE_GDAL(val) = val
340 unsigned int nOpenFlags,
341 const char*
const* papszAllowedDrivers,
342 const char*
const* papszOpenOptions,
343 const char*
const* papszSiblingFiles );
347 friend class GDALDefaultOverviews;
348 friend class GDALProxyDataset;
351 CPL_INTERNAL
void AddToDatasetOpenList();
359 int nRasterXSize = 512;
360 int nRasterYSize = 512;
367 bool bForceCachedIO =
false;
368 bool bShared =
false;
369 bool bIsInternal =
true;
370 bool bSuppressOnClose =
false;
375 void RasterInitialize(
int,
int );
378 GDALDefaultOverviews oOvManager{};
380 virtual CPLErr IBuildOverviews(
const char *,
int,
int *,
381 int,
int *, GDALProgressFunc,
void * );
392 void BlockBasedFlushCache();
395 int nXOff,
int nYOff,
int nXSize,
int nYSize,
396 void * pData,
int nBufXSize,
int nBufYSize,
398 int nBandCount,
int *panBandMap,
404 int nXOff,
int nYOff,
int nXSize,
int nYSize,
405 void * pData,
int nBufXSize,
int nBufYSize,
407 int nBandCount,
int *panBandMap,
412 CPLErr ValidateRasterIOOrAdviseReadParameters(
413 const char* pszCallingFunc,
414 int* pbStopProcessingOnCENone,
415 int nXOff,
int nYOff,
int nXSize,
int nYSize,
416 int nBufXSize,
int nBufYSize,
417 int nBandCount,
int *panBandMap);
420 int nXOff,
int nYOff,
int nXSize,
int nYSize,
421 void * pData,
int nBufXSize,
int nBufYSize,
423 int nBandCount,
int *panBandMap,
429 void ShareLockWithParentDataset(
GDALDataset* poParentDataset);
432 virtual int CloseDependentDatasets();
434 int ValidateLayerCreationOptions(
const char*
const* papszLCO );
436 char **papszOpenOptions =
nullptr;
443 void LeaveReadWrite();
446 void TemporarilyDropReadWriteLock();
447 void ReacquireReadWriteLock();
449 void DisableReadWriteMutex();
458 int GetRasterXSize();
459 int GetRasterYSize();
460 int GetRasterCount();
472 class CPL_DLL Iterator
475 std::unique_ptr<Private> m_poPrivate;
478 Iterator(
const Iterator& oOther);
479 Iterator(Iterator&& oOther) noexcept;
482 Iterator& operator++();
483 bool operator!=(
const Iterator& it)
const;
488 const Iterator
begin()
const;
490 const Iterator
end()
const;
500 virtual void FlushCache(
void);
506 const char *GetProjectionRef(
void)
const;
507 CPLErr SetProjection(
const char * pszProjection );
509 virtual CPLErr GetGeoTransform(
double * padfTransform );
510 virtual CPLErr SetGeoTransform(
double * padfTransform );
513 char **papszOptions=
nullptr );
515 virtual void *GetInternalHandle(
const char * pszHandleName );
517 virtual char **GetFileList(
void);
519 virtual const char* GetDriverName();
522 virtual int GetGCPCount();
524 virtual CPLErr SetGCPs(
int nGCPCount,
const GDAL_GCP *pasGCPList,
528 const char *GetGCPProjection();
530 const char *pszGCPProjection );
532 virtual CPLErr AdviseRead(
int nXOff,
int nYOff,
int nXSize,
int nYSize,
533 int nBufXSize,
int nBufYSize,
535 int nBandCount,
int *panBandList,
536 char **papszOptions );
538 virtual CPLErr CreateMaskBand(
int nFlagsIn );
541 BeginAsyncReader(
int nXOff,
int nYOff,
int nXSize,
int nYSize,
542 void *pBuf,
int nBufXSize,
int nBufYSize,
544 int nBandCount,
int* panBandMap,
545 int nPixelSpace,
int nLineSpace,
int nBandSpace,
546 char **papszOptions);
550 struct RawBinaryLayout
552 enum class Interleaving
559 std::string osRawFilename{};
560 Interleaving eInterleaving = Interleaving::UNKNOWN;
562 bool bLittleEndianOrder =
false;
570 virtual bool GetRawBinaryLayout(RawBinaryLayout&);
578 OPTIONAL_OUTSIDE_GDAL(
nullptr)
591 int GetShared()
const;
602 static GDALDataset **GetOpenDatasets(
int *pnDatasetCount );
604 CPLErr BuildOverviews(
const char *,
int,
int *,
605 int,
int *, GDALProgressFunc,
void * );
611 char ** GetMetadata(
const char * pszDomain =
"")
override;
616 const char * pszDomain )
override;
618 const char * pszValue,
619 const char * pszDomain )
override;
622 char **GetMetadataDomainList()
override;
640 unsigned int nOpenFlags = 0,
641 const char*
const* papszAllowedDrivers =
nullptr,
642 const char*
const* papszOpenOptions =
nullptr,
643 const char*
const* papszSiblingFiles =
nullptr )
645 return FromHandle(
GDALOpenEx(pszFilename, nOpenFlags,
663 Private *m_poPrivate;
665 CPL_INTERNAL
OGRLayer* BuildLayerFromSelectInfo(swq_select* psSelectInfo,
667 const char *pszDialect,
668 swq_select_parse_options* poSelectParseOptions);
673 virtual int GetLayerCount();
674 virtual OGRLayer *GetLayer(
int iLayer);
695 std::unique_ptr<Private> m_poPrivate;
716 bool operator!=(
const Iterator& it)
const;
725 OGRLayer* operator[](
size_t iLayer);
726 OGRLayer* operator[](
const char* pszLayername);
731 virtual OGRLayer *GetLayerByName(
const char *);
732 virtual OGRErr DeleteLayer(
int iLayer);
734 virtual void ResetReading();
736 double* pdfProgressPct,
737 GDALProgressFunc pfnProgress,
738 void* pProgressData );
750 class CPL_DLL Iterator
753 std::unique_ptr<Private> m_poPrivate;
756 Iterator(
const Iterator& oOther);
757 Iterator(Iterator&& oOther) noexcept;
760 Iterator& operator++();
761 bool operator!=(
const Iterator& it)
const;
766 const Iterator
begin()
const;
768 const Iterator
end()
const;
773 virtual int TestCapability(
const char * );
775 virtual OGRLayer *CreateLayer(
const char *pszName,
778 char ** papszOptions =
nullptr );
780 const char *pszNewName,
781 char **papszOptions =
nullptr );
784 virtual void SetStyleTableDirectly(
OGRStyleTable *poStyleTable );
788 virtual OGRLayer * ExecuteSQL(
const char *pszStatement,
790 const char *pszDialect );
791 virtual void ReleaseResultSet(
OGRLayer * poResultsSet );
793 int GetRefCount()
const;
794 int GetSummaryRefCount()
const;
797 virtual OGRErr StartTransaction(
int bForce=FALSE);
798 virtual OGRErr CommitTransaction();
799 virtual OGRErr RollbackTransaction();
801 virtual std::shared_ptr<GDALGroup> GetRootGroup()
const;
804 static int IsGenericSQLDialect(
const char* pszDialect);
807 GDALSQLParseInfo* BuildParseInfo(swq_select* psSelectInfo,
808 swq_select_parse_options* poSelectParseOptions);
809 static void DestroyParseInfo(GDALSQLParseInfo* psParseInfo );
810 OGRLayer * ExecuteSQL(
const char *pszStatement,
812 const char *pszDialect,
813 swq_select_parse_options* poSelectParseOptions);
817 virtual OGRLayer *ICreateLayer(
const char *pszName,
820 char ** papszOptions =
nullptr );
823 OGRErr ProcessSQLCreateIndex(
const char * );
824 OGRErr ProcessSQLDropIndex(
const char * );
825 OGRErr ProcessSQLDropTable(
const char * );
826 OGRErr ProcessSQLAlterTableAddColumn(
const char * );
827 OGRErr ProcessSQLAlterTableDropColumn(
const char * );
828 OGRErr ProcessSQLAlterTableAlterColumn(
const char * );
829 OGRErr ProcessSQLAlterTableRenameColumn(
const char * );
837 CPLErr OldSetGCPsFromNew(
int nGCPCount,
const GDAL_GCP *pasGCPList,
840 friend class GDALProxyPoolDataset;
841 virtual const char *_GetProjectionRef();
843 virtual const char *_GetGCPProjection();
845 virtual CPLErr _SetProjection(
const char * pszProjection );
846 virtual CPLErr _SetGCPs(
int nGCPCount,
const GDAL_GCP *pasGCPList,
847 const char *pszGCPProjection );
855 struct CPL_DLL GDALDatasetUniquePtrDeleter
879 friend class GDALAbstractBandBlockCache;
884 volatile int nLockCount;
901 CPL_INTERNAL
void Detach_unlocked(
void );
902 CPL_INTERNAL
void Touch_unlocked(
void );
904 CPL_INTERNAL
void RecycleFor(
int nXOffIn,
int nYOffIn );
911 CPLErr Internalize(
void );
913 void MarkDirty(
void );
914 void MarkClean(
void );
916 int AddLock(
void ) {
return CPLAtomicInc(&nLockCount); }
918 int DropLock(
void ) {
return CPLAtomicDec(&nLockCount); }
958 int DropLockForRemovalFromStorage();
964 static void FlushDirtyBlocks();
965 static int FlushCacheBlock(
int bDirtyBlocksOnly = FALSE);
966 static void Verify();
968 static void EnterDisableDirtyBlockFlush();
969 static void LeaveDisableDirtyBlockFlush();
974 static void DumpAll();
979 CPL_INTERNAL
static void DestroyRBMutex();
996 std::vector<GDALColorEntry> aoEntries{};
1007 int GetColorEntryCount()
const;
1037 class GDALAbstractBandBlockCache
1040 CPLLock *hSpinLock =
nullptr;
1044 CPLCond *hCond =
nullptr;
1045 CPLMutex *hCondMutex =
nullptr;
1046 volatile int nKeepAliveCounter = 0;
1048 volatile int m_nDirtyBlocks = 0;
1055 int m_nInitialDirtyBlocksInFlushCache = 0;
1056 int m_nLastTick = -1;
1058 void FreeDanglingBlocks();
1059 void UnreferenceBlockBase();
1061 void StartDirtyBlockFlushingLog();
1062 void UpdateDirtyBlockFlushingLog();
1063 void EndDirtyBlockFlushingLog();
1067 virtual ~GDALAbstractBandBlockCache();
1071 void IncDirtyBlocks(
int nInc);
1072 void WaitCompletionPendingTasks();
1074 virtual bool Init() = 0;
1075 virtual bool IsInitOK() = 0;
1076 virtual CPLErr FlushCache() = 0;
1079 int nYBlockYOff ) = 0;
1081 virtual CPLErr FlushBlock(
int nXBlockOff,
int nYBlockOff,
1082 int bWriteDirtyBlock ) = 0;
1085 GDALAbstractBandBlockCache* GDALArrayBandBlockCacheCreate(
GDALRasterBand* poBand);
1086 GDALAbstractBandBlockCache* GDALHashSetBandBlockCacheCreate(
GDALRasterBand* poBand);
1101 friend class GDALArrayBandBlockCache;
1102 friend class GDALHashSetBandBlockCache;
1106 CPLErr eFlushBlockErr = CE_None;
1107 GDALAbstractBandBlockCache* poBandBlockCache =
nullptr;
1109 CPL_INTERNAL
void SetFlushBlockErr(
CPLErr eErr );
1111 CPL_INTERNAL
void SetValidPercent(
GUIntBig nSampleCount,
GUIntBig nValidCount );
1112 CPL_INTERNAL
void IncDirtyBlocks(
int nInc);
1119 int nRasterXSize = 0;
1120 int nRasterYSize = 0;
1126 int nBlockXSize = -1;
1127 int nBlockYSize = -1;
1128 int nBlocksPerRow = 0;
1129 int nBlocksPerColumn = 0;
1131 int nBlockReads = 0;
1132 int bForceCachedIO = 0;
1135 bool bOwnMask =
false;
1138 void InvalidateMaskBand();
1140 friend class GDALProxyRasterBand;
1141 friend class GDALDefaultOverviews;
1148 void LeaveReadWrite();
1154 virtual CPLErr IWriteBlock(
int nBlockXOff,
int nBlockYOff,
void * pData );
1160 virtual int IGetDataCoverageStatus(
int nXOff,
int nYOff,
1161 int nXSize,
int nYSize,
1163 double* pdfDataPct);
1170 int nXOff,
int nYOff,
int nXSize,
int nYSize,
1171 void * pData,
int nBufXSize,
int nBufYSize,
1177 int InitBlockInfo();
1182 GDALRasterBlock *TryGetLockedBlockRef(
int nXBlockOff,
int nYBlockYOff );
1196 void GetBlockSize(
int *,
int * );
1197 CPLErr GetActualBlockSize (
int,
int,
int *,
int * );
1203 #ifndef DOXYGEN_SKIP
1204 OPTIONAL_OUTSIDE_GDAL(
nullptr)
1213 CPLErr FlushBlock(
int,
int,
int bWriteDirtyBlock = TRUE );
1215 unsigned char* GetIndexColorTranslationTo(
GDALRasterBand* poReferenceBand,
1216 unsigned char* pTranslationTable =
nullptr,
1217 int* pApproximateMatching =
nullptr);
1221 virtual CPLErr FlushCache();
1222 virtual char **GetCategoryNames();
1223 virtual double GetNoDataValue(
int *pbSuccess =
nullptr );
1224 virtual double GetMinimum(
int *pbSuccess =
nullptr );
1225 virtual double GetMaximum(
int *pbSuccess =
nullptr );
1226 virtual double GetOffset(
int *pbSuccess =
nullptr );
1227 virtual double GetScale(
int *pbSuccess =
nullptr );
1228 virtual const char *GetUnitType();
1231 virtual CPLErr Fill(
double dfRealValue,
double dfImaginaryValue = 0);
1233 virtual CPLErr SetCategoryNames(
char ** papszNames );
1234 virtual CPLErr SetNoDataValue(
double dfNoData );
1235 virtual CPLErr DeleteNoDataValue();
1238 virtual CPLErr SetOffset(
double dfNewOffset );
1239 virtual CPLErr SetScale(
double dfNewScale );
1240 virtual CPLErr SetUnitType(
const char * pszNewValue );
1242 virtual CPLErr GetStatistics(
int bApproxOK,
int bForce,
1243 double *pdfMin,
double *pdfMax,
1244 double *pdfMean,
double *padfStdDev );
1245 virtual CPLErr ComputeStatistics(
int bApproxOK,
1246 double *pdfMin,
double *pdfMax,
1247 double *pdfMean,
double *pdfStdDev,
1248 GDALProgressFunc,
void *pProgressData );
1249 virtual CPLErr SetStatistics(
double dfMin,
double dfMax,
1250 double dfMean,
double dfStdDev );
1251 virtual CPLErr ComputeRasterMinMax(
int,
double* );
1256 const char * pszDomain )
override;
1258 const char * pszValue,
1259 const char * pszDomain )
override;
1262 virtual int HasArbitraryOverviews();
1263 virtual int GetOverviewCount();
1266 virtual CPLErr BuildOverviews(
const char * pszResampling,
1268 int * panOverviewList,
1269 GDALProgressFunc pfnProgress,
1270 void * pProgressData );
1272 virtual CPLErr AdviseRead(
int nXOff,
int nYOff,
int nXSize,
int nYSize,
1273 int nBufXSize,
int nBufYSize,
1276 virtual CPLErr GetHistogram(
double dfMin,
double dfMax,
1277 int nBuckets,
GUIntBig * panHistogram,
1278 int bIncludeOutOfRange,
int bApproxOK,
1279 GDALProgressFunc,
void *pProgressData );
1281 virtual CPLErr GetDefaultHistogram(
double *pdfMin,
double *pdfMax,
1282 int *pnBuckets,
GUIntBig ** ppanHistogram,
1284 GDALProgressFunc,
void *pProgressData);
1285 virtual CPLErr SetDefaultHistogram(
double dfMin,
double dfMax,
1286 int nBuckets,
GUIntBig *panHistogram );
1292 virtual int GetMaskFlags();
1293 virtual CPLErr CreateMaskBand(
int nFlagsIn );
1300 int GetDataCoverageStatus(
int nXOff,
int nYOff,
1301 int nXSize,
int nYSize,
1302 int nMaskFlagStop = 0,
1303 double* pdfDataPct =
nullptr );
1305 std::shared_ptr<GDALMDArray> AsMDArray()
const;
1341 ~GDALAllValidMaskBand()
override;
1347 double *pdfMin,
double *pdfMax,
1348 double *pdfMean,
double *pdfStdDev,
1349 GDALProgressFunc,
void *pProgressData )
override;
1359 double dfNoDataValue;
1372 ~GDALNoDataMaskBand()
override;
1374 static bool IsNoDataInRange(
double dfNoDataValue,
1384 double *padfNodataValues;
1392 explicit GDALNoDataValuesMaskBand(
GDALDataset * );
1393 ~GDALNoDataValuesMaskBand()
override;
1416 ~GDALRescaledAlphaBand()
override;
1461 const char * pszValue,
1462 const char * pszDomain =
"" )
override;
1468 int nXSize,
int nYSize,
int nBands,
1471 GDALDataset *CreateMultiDimensional(
const char * pszName,
1475 CPLErr Delete(
const char * pszName );
1476 CPLErr Rename(
const char * pszNewName,
1477 const char * pszOldName );
1478 CPLErr CopyFiles(
const char * pszNewName,
1479 const char * pszOldName );
1483 GDALProgressFunc pfnProgress,
1495 int nXSize,
int nYSize,
int nBands,
1497 char ** papszOptions );
1500 int nXSize,
int nYSize,
int nBands,
1502 char ** papszOptions );
1504 GDALDataset *(*pfnCreateMultiDimensional)(
const char * pszName,
1508 CPLErr (*pfnDelete)(
const char * pszName );
1512 GDALProgressFunc pfnProgress,
1513 void * pProgressData );
1529 CPLErr (*pfnRename)(
const char * pszNewName,
1530 const char * pszOldName );
1531 CPLErr (*pfnCopyFiles)(
const char * pszNewName,
1532 const char * pszOldName );
1539 const char * pszName,
1540 char ** papszOptions );
1542 const char * pszName );
1551 GDALProgressFunc pfnProgress,
1554 static CPLErr DefaultCreateCopyMultiDimensional(
1559 GDALProgressFunc pfnProgress,
1560 void * pProgressData );
1569 GDALProgressFunc pfnProgress,
1570 void * pProgressData );
1572 static CPLErr QuietDelete(
const char * pszName,
1573 const char *
const *papszAllowedDrivers =
nullptr);
1576 static CPLErr DefaultRename(
const char * pszNewName,
1577 const char * pszOldName );
1578 static CPLErr DefaultCopyFiles(
const char * pszNewName,
1579 const char * pszOldName );
1592 {
return static_cast<GDALDriver*
>(hDriver); }
1613 std::map<CPLString, GDALDriver*> oMapNameToDrivers{};
1615 GDALDriver *GetDriver_unlocked(
int iDriver )
1616 {
return (iDriver >= 0 && iDriver < nDrivers) ?
1617 papoDrivers[iDriver] :
nullptr; }
1619 GDALDriver *GetDriverByName_unlocked(
const char * pszName )
1622 static char** GetSearchPaths(
const char* pszGDAL_DRIVER_PATH);
1624 static void CleanupPythonDrivers();
1632 int GetDriverCount(
void )
const;
1640 static void AutoLoadDrivers();
1641 void AutoSkipDrivers();
1643 static void AutoLoadPythonDrivers();
1745 int* pnBufXOff,
int* pnBufYOff,
1746 int* pnBufXSize,
int* pnBufYSize) = 0;
1747 virtual int LockBuffer(
double dfTimeout = -1.0 );
1748 virtual void UnlockBuffer();
1783 std::vector<std::unique_ptr<GDALEDTComponent>>&& components);
1794 const std::string&
GetName()
const {
return m_osName; }
1812 const std::vector<std::unique_ptr<GDALEDTComponent>>&
GetComponents()
const {
return m_aoComponents; }
1830 bool NeedsFreeDynamicMemory()
const;
1832 void FreeDynamicMemory(
void* pBuffer)
const;
1843 std::vector<std::unique_ptr<GDALEDTComponent>>&& components);
1845 std::string m_osName{};
1848 std::vector<std::unique_ptr<GDALEDTComponent>> m_aoComponents{};
1850 size_t m_nMaxStringLength = 0;
1875 const std::string&
GetName()
const {
return m_osName; }
1890 std::string m_osName;
1907 std::shared_ptr<GDALAttribute> GetAttributeFromAttributes(
const std::string& osName)
const;
1912 virtual std::shared_ptr<GDALAttribute> GetAttribute(
const std::string& osName)
const;
1914 virtual std::vector<std::shared_ptr<GDALAttribute>> GetAttributes(
CSLConstList papszOptions =
nullptr)
const;
1916 virtual std::shared_ptr<GDALAttribute> CreateAttribute(
1917 const std::string& osName,
1918 const std::vector<GUInt64>& anDimensions,
1939 std::string m_osName{};
1940 std::string m_osFullName{};
1942 GDALGroup(
const std::string& osParentName,
const std::string& osName);
1944 const GDALGroup* GetInnerMostGroup(
const std::string& osPathOrArrayOrDim,
1945 std::shared_ptr<GDALGroup>& curGroupHolder,
1946 std::string& osLastPart)
const;
1956 const std::string&
GetName()
const {
return m_osName; }
1964 virtual std::vector<std::string> GetMDArrayNames(
CSLConstList papszOptions =
nullptr)
const;
1965 virtual std::shared_ptr<GDALMDArray> OpenMDArray(
const std::string& osName,
1968 virtual std::vector<std::string> GetGroupNames(
CSLConstList papszOptions =
nullptr)
const;
1969 virtual std::shared_ptr<GDALGroup> OpenGroup(
const std::string& osName,
1972 virtual std::vector<std::shared_ptr<GDALDimension>> GetDimensions(
CSLConstList papszOptions =
nullptr)
const;
1974 virtual std::shared_ptr<GDALGroup> CreateGroup(
const std::string& osName,
1977 virtual std::shared_ptr<GDALDimension> CreateDimension(
const std::string& osName,
1978 const std::string& osType,
1979 const std::string& osDirection,
1983 virtual std::shared_ptr<GDALMDArray> CreateMDArray(
const std::string& osName,
1984 const std::vector<std::shared_ptr<GDALDimension>>& aoDimensions,
1988 GUInt64 GetTotalCopyCost()
const;
1990 virtual bool CopyFrom(
const std::shared_ptr<GDALGroup>& poDstRootGroup,
1992 const std::shared_ptr<GDALGroup>& poSrcGroup,
1996 GDALProgressFunc pfnProgress,
1997 void * pProgressData);
2001 std::shared_ptr<GDALMDArray> OpenMDArrayFromFullname(
2002 const std::string& osFullName,
2005 std::shared_ptr<GDALDimension> OpenDimensionFromFullname(
2006 const std::string& osFullName)
const;
2009 static constexpr
GUInt64 COPY_COST = 1000;
2026 std::string m_osName{};
2027 std::string m_osFullName{};
2028 std::weak_ptr<GDALAbstractMDArray> m_pSelf{};
2032 void SetSelf(std::weak_ptr<GDALAbstractMDArray>
self) { m_pSelf =
self; }
2034 bool CheckReadWriteParams(
const GUInt64* arrayStartIdx,
2035 const size_t* count,
2036 const GInt64*& arrayStep,
2040 const void* buffer_alloc_start,
2041 size_t buffer_alloc_size,
2042 std::vector<GInt64>& tmp_arrayStep,
2043 std::vector<GPtrDiff_t>& tmp_bufferStride)
const;
2045 virtual bool IRead(
const GUInt64* arrayStartIdx,
2046 const size_t* count,
2050 void* pDstBuffer)
const = 0;
2052 virtual bool IWrite(
const GUInt64* arrayStartIdx,
2053 const size_t* count,
2057 const void* pSrcBuffer);
2067 const std::string&
GetName()
const{
return m_osName; }
2075 GUInt64 GetTotalElementsCount()
const;
2077 virtual size_t GetDimensionCount()
const;
2079 virtual const std::vector<std::shared_ptr<GDALDimension>>&
GetDimensions()
const = 0;
2083 virtual std::vector<GUInt64> GetBlockSize()
const;
2085 virtual std::vector<size_t> GetProcessingChunkSize(
size_t nMaxChunkMemory)
const;
2102 typedef bool (*FuncProcessPerChunkType)(
2104 const GUInt64* chunkArrayStartIdx,
2105 const size_t* chunkCount,
2110 virtual bool ProcessPerChunk(
const GUInt64* arrayStartIdx,
2112 const size_t* chunkSize,
2113 FuncProcessPerChunkType pfnFunc,
2116 bool Read(
const GUInt64* arrayStartIdx,
2117 const size_t* count,
2122 const void* pDstBufferAllocStart =
nullptr,
2123 size_t nDstBufferAllocSize = 0)
const;
2125 bool Write(
const GUInt64* arrayStartIdx,
2126 const size_t* count,
2130 const void* pSrcBuffer,
2131 const void* pSrcBufferAllocStart =
nullptr,
2132 size_t nSrcBufferAllocSize = 0);
2176 size_t size()
const {
return m_nSize; }
2200 mutable std::string m_osCachedVal{};
2204 GDALAttribute(
const std::string& osParentName,
const std::string& osName);
2209 std::vector<GUInt64> GetDimensionsSize()
const;
2212 const char* ReadAsString()
const;
2213 int ReadAsInt()
const;
2214 double ReadAsDouble()
const;
2216 std::vector<int> ReadAsIntArray()
const;
2217 std::vector<double> ReadAsDoubleArray()
const;
2220 bool Write(
const void* pabyValue,
size_t nLen);
2221 bool Write(
const char*);
2225 bool Write(
const double*,
size_t);
2228 static constexpr
GUInt64 COPY_COST = 100;
2238 class CPL_DLL GDALAttributeString final:
public GDALAttribute
2240 std::vector<std::shared_ptr<GDALDimension>> m_dims{};
2242 std::string m_osValue;
2251 void* pDstBuffer)
const override;
2254 GDALAttributeString(
const std::string& osParentName,
2255 const std::string& osName,
2256 const std::string& osValue);
2258 const std::vector<std::shared_ptr<GDALDimension>>&
GetDimensions()
const override;
2269 class CPL_DLL GDALAttributeNumeric final:
public GDALAttribute
2271 std::vector<std::shared_ptr<GDALDimension>> m_dims{};
2274 double m_dfValue = 0;
2275 std::vector<GUInt32> m_anValuesUInt32{};
2284 void* pDstBuffer)
const override;
2287 GDALAttributeNumeric(
const std::string& osParentName,
2288 const std::string& osName,
2290 GDALAttributeNumeric(
const std::string& osParentName,
2291 const std::string& osName,
2293 GDALAttributeNumeric(
const std::string& osParentName,
2294 const std::string& osName,
2295 const std::vector<GUInt32>& anValues);
2297 const std::vector<std::shared_ptr<GDALDimension>>&
GetDimensions()
const override;
2317 std::shared_ptr<GDALMDArray> GetView(
const std::vector<GUInt64>& indices)
const;
2319 inline std::shared_ptr<GDALMDArray> atInternal(std::vector<GUInt64>& indices)
const
2321 return GetView(indices);
2324 template<
typename... GUInt64VarArg>
2326 inline std::shared_ptr<GDALMDArray> atInternal(std::vector<GUInt64>& indices,
2327 GUInt64 idx, GUInt64VarArg... tail)
const
2329 indices.push_back(idx);
2330 return atInternal(indices, tail...);
2335 GDALMDArray(
const std::string& osParentName,
const std::string& osName);
2340 GUInt64 GetTotalCopyCost()
const;
2347 GDALProgressFunc pfnProgress,
2348 void * pProgressData);
2355 virtual const std::string& GetUnit()
const;
2357 virtual bool SetUnit(
const std::string& osUnit);
2361 virtual std::shared_ptr<OGRSpatialReference> GetSpatialRef()
const;
2363 virtual const void* GetRawNoDataValue()
const;
2365 double GetNoDataValueAsDouble(
bool* pbHasNoData =
nullptr)
const;
2367 virtual bool SetRawNoDataValue(
const void* pRawNoData);
2369 bool SetNoDataValue(
double dfNoData);
2371 virtual double GetOffset(
bool* pbHasOffset =
nullptr)
const;
2373 virtual double GetScale(
bool* pbHasScale =
nullptr)
const;
2375 virtual bool SetOffset(
double dfOffset);
2377 virtual bool SetScale(
double dfScale);
2379 std::shared_ptr<GDALMDArray> GetView(
const std::string& viewExpr)
const;
2381 std::shared_ptr<GDALMDArray> operator[](
const std::string& fieldName)
const;
2392 template<
typename... GUInt64VarArg>
2394 std::shared_ptr<GDALMDArray>
at(
GUInt64 idx, GUInt64VarArg... tail)
const
2396 std::vector<GUInt64> indices;
2397 indices.push_back(idx);
2398 return atInternal(indices, tail...);
2401 virtual std::shared_ptr<GDALMDArray> Transpose(
const std::vector<int>& anMapNewAxisToOldAxis)
const;
2403 std::shared_ptr<GDALMDArray> GetUnscaled()
const;
2405 virtual std::shared_ptr<GDALMDArray> GetMask(
CSLConstList papszOptions)
const;
2407 virtual GDALDataset* AsClassicDataset(
size_t iXDim,
size_t iYDim)
const;
2410 static constexpr
GUInt64 COPY_COST = 1000;
2412 bool CopyFromAllExceptValues(
const GDALMDArray* poSrcArray,
2416 GDALProgressFunc pfnProgress,
2417 void * pProgressData);
2423 m_nStartIdx(nStartIdx), m_nIncr(nIncr) {}
2428 std::string m_osFieldName{};
2432 std::vector<size_t> m_mapDimIdxToParentDimIdx{};
2433 std::vector<Range> m_parentRanges{} ;
2436 virtual std::shared_ptr<GDALMDArray> GetView(
const std::string& viewExpr,
2437 bool bRenameDimensions,
2438 std::vector<ViewSpec>& viewSpecs)
const;
2448 class CPL_DLL GDALMDArrayRegularlySpaced:
public GDALMDArray
2451 double m_dfIncrement;
2452 double m_dfOffsetInIncrement;
2454 std::vector<std::shared_ptr<GDALDimension>> m_dims;
2455 std::vector<std::shared_ptr<GDALAttribute>> m_attributes{};
2464 void* pDstBuffer)
const override;
2467 GDALMDArrayRegularlySpaced(
2468 const std::string& osParentName,
2469 const std::string& osName,
2470 const std::shared_ptr<GDALDimension>& poDim,
2471 double dfStart,
double dfIncrement,
2472 double dfOffsetInIncrement);
2474 bool IsWritable()
const override {
return false; }
2476 const std::vector<std::shared_ptr<GDALDimension>>&
GetDimensions()
const override;
2482 void AddAttribute(
const std::shared_ptr<GDALAttribute>& poAttr);
2506 const std::string& osName,
2507 const std::string& osType,
2508 const std::string& osDirection,
2518 const std::string&
GetName()
const {
return m_osName; }
2534 const std::string&
GetType()
const {
return m_osType; }
2552 virtual std::shared_ptr<GDALMDArray> GetIndexingVariable()
const;
2554 virtual bool SetIndexingVariable(std::shared_ptr<GDALMDArray> poIndexingVariable);
2558 std::string m_osName;
2559 std::string m_osFullName;
2560 std::string m_osType;
2561 std::string m_osDirection;
2572 class CPL_DLL GDALDimensionWeakIndexingVar:
public GDALDimension
2574 std::weak_ptr<GDALMDArray> m_poIndexingVariable{};
2577 GDALDimensionWeakIndexingVar(
const std::string& osParentName,
2578 const std::string& osName,
2579 const std::string& osType,
2580 const std::string& osDirection,
2596 GDALRegenerateOverviewsMultiBand(
int nBands,
GDALRasterBand** papoSrcBands,
2599 const char * pszResampling,
2600 GDALProgressFunc pfnProgress,
void * pProgressData );
2602 typedef CPLErr (*GDALResampleFunction)
2603 (
double dfXRatioDstToSrc,
2604 double dfYRatioDstToSrc,
2609 GByte * pabyChunkNodataMask,
2610 int nChunkXOff,
int nChunkXSize,
2611 int nChunkYOff,
int nChunkYSize,
2612 int nDstXOff,
int nDstXOff2,
2613 int nDstYOff,
int nDstYOff2,
2615 const char * pszResampling,
2616 int bHasNoData,
float fNoDataValue,
2619 bool bPropagateNoData );
2621 GDALResampleFunction GDALGetResampleFunction(
const char* pszResampling,
2624 #ifdef GDAL_ENABLE_RESAMPLING_MULTIBAND
2625 typedef CPLErr (*GDALResampleFunctionMultiBands)
2626 (
double dfXRatioDstToSrc,
2627 double dfYRatioDstToSrc,
2631 void * pChunk,
int nBands,
2632 GByte * pabyChunkNodataMask,
2633 int nChunkXOff,
int nChunkXSize,
2634 int nChunkYOff,
int nChunkYSize,
2635 int nDstXOff,
int nDstXOff2,
2636 int nDstYOff,
int nDstYOff2,
2638 const char * pszResampling,
2639 int bHasNoData,
float fNoDataValue,
2643 GDALResampleFunctionMultiBands GDALGetResampleFunctionMultiBands(
const char* pszResampling,
2647 GDALDataType GDALGetOvrWorkDataType(
const char* pszResampling,
2653 HFAAuxBuildOverviews(
const char *pszOvrFilename,
GDALDataset *poParentDS,
2655 int nBands,
int *panBandList,
2656 int nNewOverviews,
int *panNewOverviewList,
2657 const char *pszResampling,
2658 GDALProgressFunc pfnProgress,
2659 void *pProgressData );
2662 GTIFFBuildOverviews(
const char * pszFilename,
2664 int nOverviews,
int * panOverviewList,
2665 const char * pszResampling,
2666 GDALProgressFunc pfnProgress,
void * pProgressData );
2669 int &nXOff,
int &nYOff,
2670 int &nXSize,
int &nYSize,
2671 int nBufXSize,
int nBufYSize) CPL_WARN_DEPRECATED(
"Use GDALBandGetBestOverviewLevel2 instead");
2672 int CPL_DLL GDALBandGetBestOverviewLevel2(
GDALRasterBand* poBand,
2673 int &nXOff,
int &nYOff,
2674 int &nXSize,
int &nYSize,
2675 int nBufXSize,
int nBufYSize,
2678 int CPL_DLL GDALOvLevelAdjust(
int nOvLevel,
int nXSize ) CPL_WARN_DEPRECATED(
"Use GDALOvLevelAdjust2 instead");
2679 int CPL_DLL GDALOvLevelAdjust2(
int nOvLevel,
int nXSize,
int nYSize );
2680 int CPL_DLL GDALComputeOvFactor(
int nOvrXSize,
int nRasterXSize,
2681 int nOvrYSize,
int nRasterYSize );
2684 GDALFindAssociatedAuxFile(
const char *pszBasefile,
GDALAccess eAccess,
2691 int CPL_DLL GDALCheckDatasetDimensions(
int nXSize,
int nYSize );
2692 int CPL_DLL GDALCheckBandCount(
int nBands,
int bIsZeroAllowed );
2697 int CPL_DLL GDALReadWorldFile2(
const char *pszBaseFilename,
const char *pszExtension,
2698 double *padfGeoTransform,
char** papszSiblingFiles,
2699 char** ppszWorldFileNameOut);
2700 int GDALReadTabFile2(
const char * pszBaseFilename,
2701 double *padfGeoTransform,
char **ppszWKT,
2702 int *pnGCPCount,
GDAL_GCP **ppasGCPs,
2703 char** papszSiblingFiles,
char** ppszTabFileNameOut );
2710 void GDALNullifyOpenDatasetsList();
2711 CPLMutex** GDALGetphDMMutex();
2712 CPLMutex** GDALGetphDLMutex();
2713 void GDALNullifyProxyPoolSingleton();
2715 void GDALSetResponsiblePIDForCurrentThread(
GIntBig responsiblePID);
2716 GIntBig GDALGetResponsiblePIDForCurrentThread();
2718 CPLString GDALFindAssociatedFile(
const char *pszBasename,
const char *pszExt,
2721 CPLErr EXIFExtractMetadata(
char**& papszMetadata,
2722 void *fpL,
int nOffset,
2723 int bSwabflag,
int nTIFFHEADER,
2724 int& nExifOffset,
int& nInterOffset,
int& nGPSOffset);
2727 const char*
const* papszOptionOptions);
2728 int GDALValidateOptions(
const char* pszOptionList,
2729 const char*
const* papszOptionsToValidate,
2730 const char* pszErrorMessageOptionType,
2731 const char* pszErrorMessageContainerName);
2737 int nXSize,
int nYSize,
2738 int nBufXSize,
int nBufYSize);
2742 int bThisLevelOnly);
2747 template<
class T>
inline bool ARE_REAL_EQUAL(T fVal1, T fVal2,
int ulp = 2)
2749 return fVal1 == fVal2 ||
2750 std::abs(fVal1 - fVal2) < std::numeric_limits<float>::epsilon() * std::abs(fVal1+fVal2) * ulp;
2753 double GDALAdjustNoDataCloseToFloatMax(
double dfVal);
2755 #define DIV_ROUND_UP(a, b) ( ((a) % (b)) == 0 ? ((a) / (b)) : (((a) / (b)) + 1) )
2759 #define GDALSTAT_APPROX_NUMSAMPLES 2500
2761 void GDALSerializeGCPListToXML(
CPLXMLNode* psParentNode,
2765 void GDALDeserializeGCPListFromXML(
CPLXMLNode* psGCPList,
2770 void GDALSerializeOpenOptionsToXML(
CPLXMLNode* psParentNode,
char** papszOpenOptions);
2771 char** GDALDeserializeOpenOptionsFromXML(
CPLXMLNode* psParentNode );
2773 int GDALCanFileAcceptSidecarFile(
const char* pszFilename);
@ GDAL_IDENTIFY_UNKNOWN
Identify could not determine if the file is recognized or not by the probed driver.
Definition: gdal_priv.h:1432
const std::string & GetFullName() const
Return the full name.
Definition: gdal_priv.h:2524
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:917
@ GDAL_IDENTIFY_FALSE
Identify determined the file is not recognized by the probed driver.
Definition: gdal_priv.h:1434
VSILFILE * fpL
Pointer to the file.
Definition: gdal_priv.h:293
size_t GetSize() const
Return data type size in bytes.
Definition: gdal_priv.h:1820
virtual bool SetIndexingVariable(std::shared_ptr< GDALMDArray > poIndexingVariable)
Set the variable that is used to index the dimension.
Definition: gdalmultidim.cpp:5359
int GDALGetDataTypeSizeBytes(GDALDataType)
Get data type size in bytes.
Definition: gdal_misc.cpp:305
const std::string & GetFullName() const
Return the full name of the group.
Definition: gdal_priv.h:1962
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
int GetYOffset() const
Return y offset.
Definition: gdal_priv.h:1697
Class used to represent potentially complex data types.
Definition: gdal_priv.h:1772
int GetYSize() const
Return the height of the block.
Definition: gdal_priv.h:942
std::input_iterator_tag iterator_category
iterator_category
Definition: gdal_priv.h:702
GUIntBig GUInt64
Unsigned 64 bit integer type.
Definition: cpl_port.h:269
Class for dataset open functions.
Definition: gdal_priv.h:267
Layer iterator.
Definition: gdal_priv.h:693
virtual CPLErr ComputeStatistics(int bApproxOK, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev, GDALProgressFunc, void *pProgressData)
Compute image statistics.
Definition: gdalrasterband.cpp:4895
int GetPixelSpace() const
Return pixel spacing.
Definition: gdal_priv.h:1733
const std::string & GetFullName() const
Return the name of an array or attribute.
Definition: gdal_priv.h:2073
GPtrDiff_t GetBlockSize() const
Return the block size in bytes.
Definition: gdal_priv.h:954
Class for a component of a compound extended data type.
Definition: gdal_priv.h:1863
int GetBandCount() const
Return band count.
Definition: gdal_priv.h:1725
OGRLayer::FeatureIterator begin(OGRLayer *poLayer)
Return begin of feature iterator.
Definition: ogrsf_frmts.h:287
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:3223
void difference_type
difference_type
Definition: gdal_priv.h:700
virtual bool IsWritable() const =0
Return whether an array is writable;.
This class represents a style table.
Definition: ogr_featurestyle.h:85
@ GEDTC_NUMERIC
Numeric value.
Definition: gdal.h:283
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:442
Class used as a session object for asynchronous requests.
Definition: gdal_priv.h:1660
@ GDT_Unknown
Definition: gdal.h:61
GIntBig GPtrDiff_t
Integer type large enough to hold the difference between 2 addresses.
Definition: cpl_port.h:286
GDALExtendedDataTypeClass GetClass() const
Return type class.
Definition: gdal_priv.h:1800
int GetBufferYSize() const
Return buffer height.
Definition: gdal_priv.h:1717
Format specific driver.
Definition: gdal_priv.h:1455
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:158
Abstract class, implemented by GDALAttribute and GDALMDArray.
Definition: gdal_priv.h:2023
Class returned by GetBands() that act as a container for raster bands.
Definition: gdal_priv.h:465
void * GDALColorTableH
Opaque type used for the C bindings of the C++ GDALColorTable class.
Definition: gdal.h:267
int GetLineSpace() const
Return line spacing.
Definition: gdal_priv.h:1737
void GDALClose(GDALDatasetH)
Close GDAL dataset.
Definition: gdaldataset.cpp:3624
void * GetDataRef(void)
Return the data buffer.
Definition: gdal_priv.h:950
int nOpenFlags
Open flags.
Definition: gdal_priv.h:285
char ** papszOpenOptions
Open options.
Definition: gdal_priv.h:280
virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="")
Set single metadata item.
Definition: gdalmajorobject.cpp:388
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:326
Color tuple.
Definition: gdal.h:1174
const std::string & GetName() const
Return the name.
Definition: gdal_priv.h:2518
virtual const std::vector< std::shared_ptr< GDALDimension > > & GetDimensions() const =0
Return the dimensions of an attribute/array.
GDALColorInterp
Definition: gdal.h:194
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:71
Convenient string class based on std::string.
Definition: cpl_string.h:333
A single raster band (or channel).
Definition: gdal_priv.h:1099
GIntBig GInt64
Signed 64 bit integer type.
Definition: cpl_port.h:267
GDALIdentifyEnum
Enumeration used by GDALDriver::pfnIdentify().
Definition: gdal_priv.h:1430
int GetBandSpace() const
Return band spacing.
Definition: gdal_priv.h:1741
virtual std::vector< std::shared_ptr< GDALAttribute > > GetAttributes(CSLConstList papszOptions=nullptr) const
Return the list of attributes contained in a GDALMDArray or GDALGroup.
Definition: gdalmultidim.cpp:113
const std::string & GetDirection() const
Return the axis direction.
Definition: gdal_priv.h:2544
GDALDataType GetBufferType() const
Return buffer data type.
Definition: gdal_priv.h:1721
GDALExtendedDataTypeClass
Enumeration giving the class of a GDALExtendedDataType.
Definition: gdal.h:281
const GByte * data() const
Return pointer to the start of data.
Definition: gdal_priv.h:2174
GDALDataType
Definition: gdal.h:60
Document node structure.
Definition: cpl_minixml.h:70
std::unique_ptr< OGRFeature, OGRFeatureUniquePtrDeleter > OGRFeatureUniquePtr
Unique pointer type for OGRFeature.
Definition: ogr_feature.h:780
const std::string & GetName() const
Return the name of an array or attribute.
Definition: gdal_priv.h:2067
A single raster block in the block cache.
Definition: gdal_priv.h:878
void * GDALMajorObjectH
Opaque type used for the C bindings of the C++ GDALMajorObject class.
Definition: gdal.h:255
Store the raw result of an attribute value, which might contain dynamically allocated structures (lik...
Definition: gdal_priv.h:2146
Class modeling a named container of GDALAttribute, GDALMDArray or other GDALGroup.
Definition: gdal_priv.h:1936
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:338
char ** GetOpenOptions()
Return open options.
Definition: gdal_priv.h:600
CPLErr BuildOverviews(const char *, int, int *, int, int *, GDALProgressFunc, void *)
Build raster overview(s)
Definition: gdaldataset.cpp:1925
static GDALMajorObject * FromHandle(GDALMajorObjectH hMajorObject)
Convert a GDALMajorObjectH to a GDALMajorObject*.
Definition: gdal_priv.h:175
size_t size() const
Return the size in bytes of the raw result.
Definition: gdal_priv.h:2176
Interface used to get a single GDALAttribute or a set of GDALAttribute.
Definition: gdal_priv.h:1905
int bStatOK
Whether stat()'ing the file was successful.
Definition: gdal_priv.h:288
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
Class for managing the registration of file format drivers.
Definition: gdal_priv.h:1610
Class modeling a multi-dimensional array.
Definition: gdal_priv.h:2316
GByte * pabyHeader
Buffer with first bytes of the file.
Definition: gdal_priv.h:298
int GetYSize() const
Return height.
Definition: gdal_priv.h:1705
GDALAccess eAccess
Access flag.
Definition: gdal_priv.h:283
virtual GDALRasterBand * GetMaskBand()
Return the mask band associated with the band.
Definition: gdalrasterband.cpp:5955
std::shared_ptr< GDALMDArray > at(GUInt64 idx, GUInt64VarArg... tail) const
Return a view of the array using integer indexing.
Definition: gdal_priv.h:2394
GDALDataType GetNumericDataType() const
Return numeric data type (only valid when GetClass() == GEDTC_NUMERIC)
Definition: gdal_priv.h:1806
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1212
static GDALExtendedDataType CreateString(size_t nMaxStringLength=0)
Return a new GDALExtendedDataType of class GEDTC_STRING.
Definition: gdalmultidim.cpp:5087
int CPLErrorNum
Error number.
Definition: cpl_error.h:94
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:251
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:639
@ GDT_Float64
Definition: gdal.h:70
int DropLock(void)
Decrement the lock count.
Definition: gdal_priv.h:918
int bIsDirectory
Whether the file is a directory.
Definition: gdal_priv.h:290
const std::string & GetType() const
Return the axis type.
Definition: gdal_priv.h:2534
Ground Control Point.
Definition: gdal.h:664
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
virtual CPLErr IReadBlock(int nBlockXOff, int nBlockYOff, void *pData)=0
Read a block of data.
Class modeling a a dimension / axis used to index multidimensional arrays.
Definition: gdal_priv.h:2502
#define CPL_NULL_TERMINATED
Null terminated variadic.
Definition: cpl_port.h:907
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:1812
virtual GDALAsyncStatusType GetNextUpdatedRegion(double dfTimeout, int *pnBufXOff, int *pnBufYOff, int *pnBufXSize, int *pnBufYSize)=0
Get async IO update.
virtual const GDALExtendedDataType & GetDataType() const =0
Return the data type of an attribute/array.
Object returned by GetFeatures() iterators.
Definition: gdal_priv.h:653
GDALDataset * GetGDALDataset()
Return dataset.
Definition: gdal_priv.h:1689
CPLString & toupper(void)
Convert to upper case in place.
Definition: cplstring.cpp:316
static GDALDatasetH ToHandle(GDALDataset *poDS)
Convert a GDALDataset* to a GDALDatasetH.
Definition: gdal_priv.h:627
struct CPLVirtualMem CPLVirtualMem
Opaque type that represents a virtual memory mapping.
Definition: cpl_virtualmem.h:62
const char *const * papszAllowedDrivers
Allowed drivers (NULL for all)
Definition: gdal_priv.h:301
virtual int CloseDependentDatasets()
Drop references to any other datasets referenced by this dataset.
Definition: gdaldataset.cpp:3995
static GDALColorTableH ToHandle(GDALColorTable *poCT)
Convert a GDALColorTable* to a GDALRasterBandH.
Definition: gdal_priv.h:1017
int AddLock(void)
Increment the lock count.
Definition: gdal_priv.h:916
virtual CPLErr CreateMaskBand(int nFlagsIn)
Adds a mask band to the dataset.
Definition: gdaldataset.cpp:3034
GIntBig GSpacing
Type to express pixel, line or band spacing.
Definition: gdal.h:276
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:140
GUInt64 GetSize() const
Return the size, that is the number of values along the dimension.
Definition: gdal_priv.h:2550
GDALAccess
Definition: gdal.h:113
void MarkSuppressOnClose()
Set that the dataset must be deleted on close.
Definition: gdal_priv.h:595
OGRLayer::FeatureIterator end(OGRLayer *poLayer)
Return end of feature iterator.
Definition: ogrsf_frmts.h:292
GDALAsyncStatusType
status of the asynchronous stream
Definition: gdal.h:101
size_t GetOffset() const
Return the offset (in bytes) of the component in the compound data type.
Definition: gdal_priv.h:1881
static GDALDriver * FromHandle(GDALDriverH hDriver)
Convert a GDALDriverH to a GDALDriver*.
Definition: gdal_priv.h:1591
const GByte & operator[](size_t idx) const
Return byte at specified index.
Definition: gdal_priv.h:2172
@ GDAL_IDENTIFY_TRUE
Identify determined the file is recognized by the probed driver.
Definition: gdal_priv.h:1436
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:318
@ GA_ReadOnly
Definition: gdal.h:114
virtual std::shared_ptr< GDALMDArray > GetIndexingVariable() const
Return the variable that is used to index the dimension (if there is one).
Definition: gdalmultidim.cpp:5338
int GetXSize() const
Return width.
Definition: gdal_priv.h:1701
int GetDirty() const
Return the dirty flag.
Definition: gdal_priv.h:946
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
void pointer
pointer
Definition: gdal_priv.h:701
int GetBufferXSize() const
Return buffer width.
Definition: gdal_priv.h:1713
int nHeaderBytes
Number of bytes in pabyHeader.
Definition: gdal_priv.h:296
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:346
static GDALDriverH ToHandle(GDALDriver *poDriver)
Convert a GDALDriver* to a GDALDriverH.
Definition: gdal_priv.h:1585
void static GDALRasterBandH ToHandle(GDALRasterBand *poBand)
Convert a GDALRasterBand* to a GDALRasterBandH.
Definition: gdal_priv.h:1314
int GetYOff() const
Return the y offset of the top-left corner of the block.
Definition: gdal_priv.h:934
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:942
GDALAccess GetAccess() const
Return access mode.
Definition: gdal_priv.h:589
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:355
GDALRWFlag
Definition: gdal.h:119
Class returned by GetFeatures() that act as a container for vector features.
Definition: gdal_priv.h:743
Object with metadata.
Definition: gdal_priv.h:134
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:1310
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:68
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
CPLErr
Error category.
Definition: cpl_error.h:53
Class modeling an attribute that has a name, a value and a type, and is typically used to describe a ...
Definition: gdal_priv.h:2199
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
const GDALExtendedDataType & GetType() const
Return the data type of the component.
Definition: gdal_priv.h:1887
~GDALColorTable()
Destructor.
char * pszFilename
Filename.
Definition: gdal_priv.h:278
static GDALColorTable * FromHandle(GDALColorTableH hCT)
Convert a GDALColorTableH to a GDALColorTable*.
Definition: gdal_priv.h:1023
@ GDT_Byte
Definition: gdal.h:62
@ GPI_RGB
Definition: gdal.h:222
virtual int GetMaskFlags()
Return the status flags of the mask band associated with the band.
Definition: gdalrasterband.cpp:6220
GDALEDTComponent(const GDALEDTComponent &)
Copy constructor.
GDALRIOResampleAlg
RasterIO() resampling method.
Definition: gdal.h:129
GDALDriverManager * GetGDALDriverManager(void)
Fetch the global GDAL driver manager.
Definition: gdaldrivermanager.cpp:97
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
Definition: gdal_rat.h:48
int GetXOffset() const
Return x offset.
Definition: gdal_priv.h:1693
size_t GetMaxStringLength() const
Return the maximum length of a string in bytes.
Definition: gdal_priv.h:1826
GDALRasterBand * GetBand()
Accessor to source GDALRasterBand object.
Definition: gdal_priv.h:962
Class returned by GetLayers() that acts as a range of layers.
Definition: gdal_priv.h:680
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
int GetXOff() const
Return the x offset of the top-left corner of the block.
Definition: gdal_priv.h:930
GDALDataType GetDataType() const
Return the data type.
Definition: gdal_priv.h:926
static GDALDataset * FromHandle(GDALDatasetH hDS)
Convert a GDALDatasetH to a GDALDataset*.
Definition: gdal_priv.h:633
GDALPaletteInterp
Definition: gdal.h:220
static GDALExtendedDataType Create(GDALDataType eType)
Return a new GDALExtendedDataType of class GEDTC_NUMERIC.
Definition: gdalmultidim.cpp:5024
static GDALMajorObjectH ToHandle(GDALMajorObject *poMajorObject)
Convert a GDALMajorObject* to a GDALMajorObjectH.
Definition: gdal_priv.h:169
void * GDALRasterBandH
Opaque type used for the C bindings of the C++ GDALRasterBand class.
Definition: gdal.h:261
const std::string & GetName() const
Return the name of the group.
Definition: gdal_priv.h:1956
@ wkbUnknown
unknown type, non-standard
Definition: ogr_core.h:347
void * GetBuffer()
Return buffer.
Definition: gdal_priv.h:1709
std::unique_ptr< GDALDataset, GDALDatasetUniquePtrDeleter > GDALDatasetUniquePtr
Unique pointer type for GDALDataset.
Definition: gdal_priv.h:867
const std::string & GetName() const
Return type name.
Definition: gdal_priv.h:1794
#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:1003
const std::string & GetName() const
Return the name.
Definition: gdal_priv.h:1875
int GetXSize() const
Return the width of the block.
Definition: gdal_priv.h:938
void * GDALDatasetH
Opaque type used for the C bindings of the C++ GDALDataset class.
Definition: gdal.h:258
static GDALRasterBand * FromHandle(GDALRasterBandH hBand)
Convert a GDALRasterBandH to a GDALRasterBand*.
Definition: gdal_priv.h:1320
A color table / palette.
Definition: gdal_priv.h:993
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:156
int * GetBandMap()
Return band map.
Definition: gdal_priv.h:1729
void * GDALDriverH
Opaque type used for the C bindings of the C++ GDALDriver class.
Definition: gdal.h:264