EVOLUTION-MANAGER
Edit File: classCPLJSONDocument.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>SDTS_AL: CPLJSONDocument Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">SDTS_AL </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classCPLJSONDocument-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">CPLJSONDocument Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>The <a class="el" href="classCPLJSONDocument.html" title="The CPLJSONDocument class Wrapper class around json-c library. ">CPLJSONDocument</a> class Wrapper class around json-c library. <a href="classCPLJSONDocument.html#details">More...</a></p> <p><code>#include <<a class="el" href="cpl__json_8h_source.html">cpl_json.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a7f50f31265c68eb71daa0b60844c2d46"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLJSONDocument.html#a7f50f31265c68eb71daa0b60844c2d46">Save</a> (const std::string &osPath)</td></tr> <tr class="separator:a7f50f31265c68eb71daa0b60844c2d46"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acf05299f6690a1d10be3b2f1a686ff50"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLJSONDocument.html#acf05299f6690a1d10be3b2f1a686ff50">SaveAsString</a> ()</td></tr> <tr class="separator:acf05299f6690a1d10be3b2f1a686ff50"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a156e52465bfe6c14809fa7329850f5ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCPLJSONObject.html">CPLJSONObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLJSONDocument.html#a156e52465bfe6c14809fa7329850f5ca">GetRoot</a> ()</td></tr> <tr class="separator:a156e52465bfe6c14809fa7329850f5ca"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a05b337d2b7f92e36f09271935a1b6ce0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLJSONDocument.html#a05b337d2b7f92e36f09271935a1b6ce0">Load</a> (const std::string &osPath)</td></tr> <tr class="separator:a05b337d2b7f92e36f09271935a1b6ce0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa14a29038ebda7a062cfff7710a9e119"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLJSONDocument.html#aa14a29038ebda7a062cfff7710a9e119">LoadMemory</a> (const std::string &osStr)</td></tr> <tr class="separator:aa14a29038ebda7a062cfff7710a9e119"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae06d8e4a47c7b61fcf5a0532bc0de6cc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLJSONDocument.html#ae06d8e4a47c7b61fcf5a0532bc0de6cc">LoadMemory</a> (const <a class="el" href="cpl__port_8h.html#ae7fbc84d3d1f7a40973be07382e28401">GByte</a> *pabyData, int nLength=-1)</td></tr> <tr class="separator:ae06d8e4a47c7b61fcf5a0532bc0de6cc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5355924cae6d945dd348b4e84c809d22"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLJSONDocument.html#a5355924cae6d945dd348b4e84c809d22">LoadChunks</a> (const std::string &osPath, size_t nChunkSize=16384, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)</td></tr> <tr class="separator:a5355924cae6d945dd348b4e84c809d22"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6f70a8891f2c9ce4ab918224d32b29ee"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLJSONDocument.html#a6f70a8891f2c9ce4ab918224d32b29ee">LoadUrl</a> (const std::string &osUrl, char **papszOptions, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)</td></tr> <tr class="separator:a6f70a8891f2c9ce4ab918224d32b29ee"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The <a class="el" href="classCPLJSONDocument.html" title="The CPLJSONDocument class Wrapper class around json-c library. ">CPLJSONDocument</a> class Wrapper class around json-c library. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a156e52465bfe6c14809fa7329850f5ca"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classCPLJSONObject.html">CPLJSONObject</a> CPLJSONDocument::GetRoot </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Get json document root object </p> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classCPLJSONObject.html" title="The CPLJSONArray class holds JSON object from CPLJSONDocument. ">CPLJSONObject</a> class instance</dd></dl> <dl class="section since"><dt>Since</dt><dd>GDAL 2.3 </dd></dl> </div> </div> <a class="anchor" id="a05b337d2b7f92e36f09271935a1b6ce0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool CPLJSONDocument::Load </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>osPath</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Load json document from file by provided path </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">osPath</td><td>Path to json file. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true on success. If error occurred it can be received using CPLGetLastErrorMsg method.</dd></dl> <dl class="section since"><dt>Since</dt><dd>GDAL 2.3 </dd></dl> </div> </div> <a class="anchor" id="a5355924cae6d945dd348b4e84c809d22"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool CPLJSONDocument::LoadChunks </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>osPath</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>nChunkSize</em> = <code>16384</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">GDALProgressFunc </td> <td class="paramname"><em>pfnProgress</em> = <code>nullptr</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>pProgressArg</em> = <code>nullptr</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Load json document from file using small chunks of data. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">osPath</td><td>Path to json document file. </td></tr> <tr><td class="paramname">nChunkSize</td><td>Chunk size. </td></tr> <tr><td class="paramname">pfnProgress</td><td>a function to report progress of the json data loading. </td></tr> <tr><td class="paramname">pProgressArg</td><td>application data passed into progress function. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true on success. If error occurred it can be received using CPLGetLastErrorMsg method.</dd></dl> <dl class="section since"><dt>Since</dt><dd>GDAL 2.3 </dd></dl> </div> </div> <a class="anchor" id="aa14a29038ebda7a062cfff7710a9e119"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool CPLJSONDocument::LoadMemory </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>osStr</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Load json document from memory buffer. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">osStr</td><td>String </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true on success. If error occurred it can be received using CPLGetLastErrorMsg method.</dd></dl> <dl class="section since"><dt>Since</dt><dd>GDAL 2.3 </dd></dl> </div> </div> <a class="anchor" id="ae06d8e4a47c7b61fcf5a0532bc0de6cc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool CPLJSONDocument::LoadMemory </td> <td>(</td> <td class="paramtype">const <a class="el" href="cpl__port_8h.html#ae7fbc84d3d1f7a40973be07382e28401">GByte</a> * </td> <td class="paramname"><em>pabyData</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>nLength</em> = <code>-1</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Load json document from memory buffer. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pabyData</td><td>Buffer.data. </td></tr> <tr><td class="paramname">nLength</td><td>Buffer size. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true on success. If error occurred it can be received using CPLGetLastErrorMsg method.</dd></dl> <dl class="section since"><dt>Since</dt><dd>GDAL 2.3 </dd></dl> </div> </div> <a class="anchor" id="a6f70a8891f2c9ce4ab918224d32b29ee"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool CPLJSONDocument::LoadUrl </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>osUrl</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char ** </td> <td class="paramname"><em>papszOptions</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">GDALProgressFunc </td> <td class="paramname"><em>pfnProgress</em> = <code>nullptr</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>pProgressArg</em> = <code>nullptr</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Load json document from web. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">osUrl</td><td>Url to json document. </td></tr> <tr><td class="paramname">papszOptions</td><td>Option list as a NULL-terminated array of strings. May be NULL. The available keys are same for CPLHTTPFetch method. Additional key JSON_DEPTH define json parse depth. Default is 10. </td></tr> <tr><td class="paramname">pfnProgress</td><td>a function to report progress of the json data loading. </td></tr> <tr><td class="paramname">pProgressArg</td><td>application data passed into progress function. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true on success. If error occurred it can be received using CPLGetLastErrorMsg method.</dd></dl> <dl class="section since"><dt>Since</dt><dd>GDAL 2.3 </dd></dl> </div> </div> <a class="anchor" id="a7f50f31265c68eb71daa0b60844c2d46"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool CPLJSONDocument::Save </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>osPath</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Save json document at specified path </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">osPath</td><td>Path to save json document </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true on success. If error occurred it can be received using CPLGetLastErrorMsg method.</dd></dl> <dl class="section since"><dt>Since</dt><dd>GDAL 2.3 </dd></dl> </div> </div> <a class="anchor" id="acf05299f6690a1d10be3b2f1a686ff50"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string CPLJSONDocument::SaveAsString </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Return the json document as a serialized string. </p> <dl class="section return"><dt>Returns</dt><dd>serialized document.</dd></dl> <dl class="section since"><dt>Since</dt><dd>GDAL 2.3 </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="cpl__json_8h_source.html">cpl_json.h</a></li> <li>cpl_json.cpp</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>