GDAL
Public Member Functions | List of all members
CPLJSONDocument Class Reference

The CPLJSONDocument class Wrapper class around json-c library. More...

#include <cpl_json.h>

Public Member Functions

bool Save (const std::string &osPath)
 Save json document at specified path. More...
 
CPLJSONObject GetRoot ()
 Get json document root object. More...
 
bool Load (const std::string &osPath)
 Load json document from file by provided path. More...
 
bool LoadMemory (const GByte *pabyData, int nLength=-1)
 Load json document from memory buffer. More...
 
bool LoadChunks (const std::string &osPath, size_t nChunkSize=16384, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)
 Load json document from file using small chunks of data. More...
 
bool LoadUrl (const std::string &osUrl, char **papszOptions, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)
 Load json document from web. More...
 

Detailed Description

The CPLJSONDocument class Wrapper class around json-c library.

Member Function Documentation

CPLJSONObject CPLJSONDocument::GetRoot ( )

Get json document root object.

Returns
CPLJSONObject class instance
Since
GDAL 2.3
bool CPLJSONDocument::Load ( const std::string &  osPath)

Load json document from file by provided path.

Parameters
osPathPath to json file.
Returns
true on success. If error occured it can be received using CPLGetLastErrorMsg method.
Since
GDAL 2.3
bool CPLJSONDocument::LoadChunks ( const std::string &  osPath,
size_t  nChunkSize = 16384,
GDALProgressFunc  pfnProgress = nullptr,
void *  pProgressArg = nullptr 
)

Load json document from file using small chunks of data.

Parameters
osPathPath to json document file.
nChunkSizeChunk size.
pfnProgressa function to report progress of the json data loading.
pProgressArgapplication data passed into progress function.
Returns
true on success. If error occured it can be received using CPLGetLastErrorMsg method.
Since
GDAL 2.3
bool CPLJSONDocument::LoadMemory ( const GByte pabyData,
int  nLength = -1 
)

Load json document from memory buffer.

Parameters
pabyDataBuffer.data.
nLengthBuffer size.
Returns
true on success. If error occured it can be received using CPLGetLastErrorMsg method.
Since
GDAL 2.3
bool CPLJSONDocument::LoadUrl ( const std::string &  osUrl,
char **  papszOptions,
GDALProgressFunc  pfnProgress = nullptr,
void *  pProgressArg = nullptr 
)

Load json document from web.

Parameters
osUrlUrl to json document.
papszOptionsOption list as a NULL-terminated array of strings. May be NULL. The available keys are same for CPLHTTPFetch method. Addtional key JSON_DEPTH define json parse depth. Default is 10.
pfnProgressa function to report progress of the json data loading.
pProgressArgapplication data passed into progress function.
Returns
true on success. If error occured it can be received using CPLGetLastErrorMsg method.
Since
GDAL 2.3
bool CPLJSONDocument::Save ( const std::string &  osPath)

Save json document at specified path.

Parameters
osPathPath to save json document
Returns
true on success. If error occured it can be received using CPLGetLastErrorMsg method.
Since
GDAL 2.3

The documentation for this class was generated from the following files:

Generated for GDAL by doxygen 1.8.8.