1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>o-du/phy: basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >::json_pointer Class Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20 <table cellspacing="0" cellpadding="0">
22 <tr style="height: 56px;">
23 <td id="projectalign" style="padding-left: 0.5em;">
24 <div id="projectname">o-du/phy
26 <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.13 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
37 <script type="text/javascript" src="menudata.js"></script>
38 <script type="text/javascript" src="menu.js"></script>
39 <script type="text/javascript">
41 initMenu('',true,false,'search.php','Search');
42 $(document).ready(function() { init_search(); });
45 <div id="main-nav"></div>
46 <!-- window showing the filter options -->
47 <div id="MSearchSelectWindow"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 onkeydown="return searchBox.OnSearchSelectKey(event)">
53 <!-- iframe showing the search results (closed by default) -->
54 <div id="MSearchResultsWindow">
55 <iframe src="javascript:void(0)" frameborder="0"
56 name="MSearchResults" id="MSearchResults">
60 <div id="nav-path" class="navpath">
62 <li class="navelem"><a class="el" href="namespacenlohmann.html">nlohmann</a></li><li class="navelem"><a class="el" href="classnlohmann_1_1basic__json.html">basic_json</a></li><li class="navelem"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html">json_pointer</a></li> </ul>
67 <a href="#pub-methods">Public Member Functions</a> |
68 <a href="#friends">Friends</a> </div>
69 <div class="headertitle">
70 <div class="title">basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >::json_pointer Class Reference</div> </div>
72 <div class="contents">
75 <a href="classnlohmann_1_1basic__json_1_1json__pointer.html#details">More...</a></p>
77 <p><code>#include <<a class="el" href="json_8hpp_source.html">json.hpp</a>></code></p>
78 <div class="dynheader">
79 Collaboration diagram for basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >::json_pointer:</div>
80 <div class="dyncontent">
81 <div class="center"><img src="classnlohmann_1_1basic__json_1_1json__pointer__coll__graph.png" border="0" usemap="#basic__json_3_01_object_type_00_01_array_type_00_01_string_type_00_01_boolean_type_00_01_number_integer_type_00_01_number_unsigned_type_00_01_number_float_type_00_01_allocator_type_00_01_j_s_o_n_serializer_01_4_1_1json__pointer_coll__map" alt="Collaboration graph"/></div>
83 <table class="memberdecls">
84 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
85 Public Member Functions</h2></td></tr>
86 <tr class="memitem:a15ea0c26b93c10a51bcef1df5e30cb1a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html#a15ea0c26b93c10a51bcef1df5e30cb1a">json_pointer</a> (const std::string &s="")</td></tr>
87 <tr class="memdesc:a15ea0c26b93c10a51bcef1df5e30cb1a"><td class="mdescLeft"> </td><td class="mdescRight">create JSON pointer <a href="#a15ea0c26b93c10a51bcef1df5e30cb1a">More...</a><br /></td></tr>
88 <tr class="separator:a15ea0c26b93c10a51bcef1df5e30cb1a"><td class="memSeparator" colspan="2"> </td></tr>
89 <tr class="memitem:a37b45672a268d893d5c07bed4160ed0d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html#a37b45672a268d893d5c07bed4160ed0d">to_string</a> () const noexcept</td></tr>
90 <tr class="memdesc:a37b45672a268d893d5c07bed4160ed0d"><td class="mdescLeft"> </td><td class="mdescRight">return a string representation of the JSON pointer <a href="#a37b45672a268d893d5c07bed4160ed0d">More...</a><br /></td></tr>
91 <tr class="separator:a37b45672a268d893d5c07bed4160ed0d"><td class="memSeparator" colspan="2"> </td></tr>
92 <tr class="memitem:a3888dcd59dd5acd1ca5b9bee4c2e252a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html#a3888dcd59dd5acd1ca5b9bee4c2e252a">operator std::string</a> () const</td></tr>
93 <tr class="memdesc:a3888dcd59dd5acd1ca5b9bee4c2e252a"><td class="mdescLeft"> </td><td class="mdescRight">return a string representation of the JSON pointer <a href="#a3888dcd59dd5acd1ca5b9bee4c2e252a">More...</a><br /></td></tr>
94 <tr class="separator:a3888dcd59dd5acd1ca5b9bee4c2e252a"><td class="memSeparator" colspan="2"> </td></tr>
95 </table><table class="memberdecls">
96 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
97 Friends</h2></td></tr>
98 <tr class="memitem:ada3100cdb8700566051828f1355fa745"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html#ada3100cdb8700566051828f1355fa745">basic_json</a></td></tr>
99 <tr class="memdesc:ada3100cdb8700566051828f1355fa745"><td class="mdescLeft"> </td><td class="mdescRight">allow <a class="el" href="classnlohmann_1_1basic__json.html" title="a class to store JSON values ">basic_json</a> to access private members <a href="#ada3100cdb8700566051828f1355fa745">More...</a><br /></td></tr>
100 <tr class="separator:ada3100cdb8700566051828f1355fa745"><td class="memSeparator" colspan="2"> </td></tr>
101 <tr class="memitem:a4667ef558c8c3f8a646bfda0c6654653"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html#a4667ef558c8c3f8a646bfda0c6654653">operator==</a> (<a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html">json_pointer</a> const &lhs, <a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html">json_pointer</a> const &rhs) noexcept</td></tr>
102 <tr class="separator:a4667ef558c8c3f8a646bfda0c6654653"><td class="memSeparator" colspan="2"> </td></tr>
103 <tr class="memitem:a6779edcf28e6f018a3bbb29c0b4b5e1e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html#a6779edcf28e6f018a3bbb29c0b4b5e1e">operator!=</a> (<a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html">json_pointer</a> const &lhs, <a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html">json_pointer</a> const &rhs) noexcept</td></tr>
104 <tr class="separator:a6779edcf28e6f018a3bbb29c0b4b5e1e"><td class="memSeparator" colspan="2"> </td></tr>
106 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
107 <div class="textblock"><h3>template<template< typename U, typename V, typename... Args > class ObjectType = std::map, template< typename U, typename... Args > class ArrayType = std::vector, class StringType = std::string, class BooleanType = bool, class NumberIntegerType = std::int64_t, class NumberUnsignedType = std::uint64_t, class NumberFloatType = double, template< typename U > class AllocatorType = std::allocator, template< typename T, typename SFINAE=void > class JSONSerializer = adl_serializer><br />
108 class nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >::json_pointer</h3>
110 <p>JSON Pointer. </p>
111 <p>A JSON pointer defines a string syntax for identifying a specific value within a JSON document. It can be used with functions <code>at</code> and <code>operator[]</code>. Furthermore, JSON pointers are the base for JSON patches.</p>
112 <dl class="section see"><dt>See also</dt><dd><a href="https://tools.ietf.org/html/rfc6901">RFC 6901</a></dd></dl>
113 <dl class="section since"><dt>Since</dt><dd>version 2.0.0 </dd></dl>
115 <p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l11623">11623</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
116 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
117 <a id="a15ea0c26b93c10a51bcef1df5e30cb1a"></a>
118 <h2 class="memtitle"><span class="permalink"><a href="#a15ea0c26b93c10a51bcef1df5e30cb1a">◆ </a></span>json_pointer()</h2>
120 <div class="memitem">
121 <div class="memproto">
122 <table class="mlabels">
124 <td class="mlabels-left">
125 <table class="memname">
127 <td class="memname"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html">json_pointer</a> </td>
129 <td class="paramtype">const std::string & </td>
130 <td class="paramname"><em>s</em> = <code>""</code></td><td>)</td>
135 <td class="mlabels-right">
136 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
139 </div><div class="memdoc">
141 <p>create JSON pointer </p>
142 <p>Create a JSON pointer according to the syntax described in <a href="https://tools.ietf.org/html/rfc6901#section-3">Section 3 of RFC6901</a>.</p>
143 <dl class="params"><dt>Parameters</dt><dd>
144 <table class="params">
145 <tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>string representing the JSON pointer; if omitted, the empty string is assumed which references the whole JSON value</td></tr>
149 <dl class="exception"><dt>Exceptions</dt><dd>
150 <table class="exception">
151 <tr><td class="paramname">std::domain_error</td><td>if reference token is nonempty and does not begin with a slash (<code>/</code>); example: <code>"JSON pointer must be empty or
152 begin with /"</code> </td></tr>
153 <tr><td class="paramname">std::domain_error</td><td>if a tilde (<code>~</code>) is not followed by <code>0</code> (representing <code>~</code>) or <code>1</code> (representing <code>/</code>); example: <code>"escape error:
154 ~ must be followed with 0 or 1"</code></td></tr>
158 <p>{The example shows the construction several valid JSON pointers as well as the exceptional behavior.,<a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html" title="JSON Pointer. ">json_pointer</a>}</p>
159 <dl class="section since"><dt>Since</dt><dd>version 2.0.0 </dd></dl>
161 <p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l11651">11651</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
165 <h2 class="groupheader">Member Function Documentation</h2>
166 <a id="a3888dcd59dd5acd1ca5b9bee4c2e252a"></a>
167 <h2 class="memtitle"><span class="permalink"><a href="#a3888dcd59dd5acd1ca5b9bee4c2e252a">◆ </a></span>operator std::string()</h2>
169 <div class="memitem">
170 <div class="memproto">
171 <table class="mlabels">
173 <td class="mlabels-left">
174 <table class="memname">
176 <td class="memname">operator std::string </td>
178 <td class="paramname"></td><td>)</td>
183 <td class="mlabels-right">
184 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
187 </div><div class="memdoc">
189 <p>return a string representation of the JSON pointer </p>
190 <dl class="section invariant"><dt>Invariant</dt><dd>For each JSON pointer <code>ptr</code>, it holds: <div class="fragment"><div class="line">ptr == <a class="code" href="classnlohmann_1_1basic__json_1_1json__pointer.html#a15ea0c26b93c10a51bcef1df5e30cb1a">json_pointer</a>(ptr.to_string());</div></div><!-- fragment --></dd></dl>
191 <dl class="section return"><dt>Returns</dt><dd>a string representation of the JSON pointer</dd></dl>
192 <p>{The example shows the result of <code>to_string</code>., json_pointer__to_string}</p>
193 <dl class="section since"><dt>Since</dt><dd>version 2.0.0 </dd></dl>
195 <p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l11681">11681</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
196 <div class="dynheader">
197 Here is the call graph for this function:</div>
198 <div class="dyncontent">
199 <div class="center"><img src="classnlohmann_1_1basic__json_1_1json__pointer_a3888dcd59dd5acd1ca5b9bee4c2e252a_cgraph.png" border="0" usemap="#classnlohmann_1_1basic__json_1_1json__pointer_a3888dcd59dd5acd1ca5b9bee4c2e252a_cgraph" alt=""/></div>
200 <map name="classnlohmann_1_1basic__json_1_1json__pointer_a3888dcd59dd5acd1ca5b9bee4c2e252a_cgraph" id="classnlohmann_1_1basic__json_1_1json__pointer_a3888dcd59dd5acd1ca5b9bee4c2e252a_cgraph">
201 <area shape="rect" id="node2" href="classnlohmann_1_1basic__json.html#ad6a2a9425ea3806424417c2e7dcdbc01" title="return whether value is an object " alt="" coords="184,5,332,47"/>
207 <a id="a37b45672a268d893d5c07bed4160ed0d"></a>
208 <h2 class="memtitle"><span class="permalink"><a href="#a37b45672a268d893d5c07bed4160ed0d">◆ </a></span>to_string()</h2>
210 <div class="memitem">
211 <div class="memproto">
212 <table class="mlabels">
214 <td class="mlabels-left">
215 <table class="memname">
217 <td class="memname">std::string to_string </td>
219 <td class="paramname"></td><td>)</td>
224 <td class="mlabels-right">
225 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
228 </div><div class="memdoc">
230 <p>return a string representation of the JSON pointer </p>
231 <dl class="section invariant"><dt>Invariant</dt><dd>For each JSON pointer <code>ptr</code>, it holds: <div class="fragment"><div class="line">ptr == <a class="code" href="classnlohmann_1_1basic__json_1_1json__pointer.html#a15ea0c26b93c10a51bcef1df5e30cb1a">json_pointer</a>(ptr.to_string());</div></div><!-- fragment --></dd></dl>
232 <dl class="section return"><dt>Returns</dt><dd>a string representation of the JSON pointer</dd></dl>
233 <p>{The example shows the result of <code>to_string</code>., json_pointer__to_string}</p>
234 <dl class="section since"><dt>Since</dt><dd>version 2.0.0 </dd></dl>
236 <p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l11670">11670</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
240 <h2 class="groupheader">Friends And Related Function Documentation</h2>
241 <a id="ada3100cdb8700566051828f1355fa745"></a>
242 <h2 class="memtitle"><span class="permalink"><a href="#ada3100cdb8700566051828f1355fa745">◆ </a></span>basic_json</h2>
244 <div class="memitem">
245 <div class="memproto">
246 <table class="mlabels">
248 <td class="mlabels-left">
249 <table class="memname">
251 <td class="memname">friend class <a class="el" href="classnlohmann_1_1basic__json.html">basic_json</a></td>
255 <td class="mlabels-right">
256 <span class="mlabels"><span class="mlabel">friend</span></span> </td>
259 </div><div class="memdoc">
261 <p>allow <a class="el" href="classnlohmann_1_1basic__json.html" title="a class to store JSON values ">basic_json</a> to access private members </p>
263 <p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l11626">11626</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
267 <a id="a6779edcf28e6f018a3bbb29c0b4b5e1e"></a>
268 <h2 class="memtitle"><span class="permalink"><a href="#a6779edcf28e6f018a3bbb29c0b4b5e1e">◆ </a></span>operator!=</h2>
270 <div class="memitem">
271 <div class="memproto">
272 <table class="mlabels">
274 <td class="mlabels-left">
275 <table class="memname">
277 <td class="memname">bool operator!= </td>
279 <td class="paramtype"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html">json_pointer</a> const & </td>
280 <td class="paramname"><em>lhs</em>, </td>
283 <td class="paramkey"></td>
285 <td class="paramtype"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html">json_pointer</a> const & </td>
286 <td class="paramname"><em>rhs</em> </td>
295 <td class="mlabels-right">
296 <span class="mlabels"><span class="mlabel">friend</span></span> </td>
299 </div><div class="memdoc">
301 <p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l12211">12211</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
305 <a id="a4667ef558c8c3f8a646bfda0c6654653"></a>
306 <h2 class="memtitle"><span class="permalink"><a href="#a4667ef558c8c3f8a646bfda0c6654653">◆ </a></span>operator==</h2>
308 <div class="memitem">
309 <div class="memproto">
310 <table class="mlabels">
312 <td class="mlabels-left">
313 <table class="memname">
315 <td class="memname">bool operator== </td>
317 <td class="paramtype"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html">json_pointer</a> const & </td>
318 <td class="paramname"><em>lhs</em>, </td>
321 <td class="paramkey"></td>
323 <td class="paramtype"><a class="el" href="classnlohmann_1_1basic__json_1_1json__pointer.html">json_pointer</a> const & </td>
324 <td class="paramname"><em>rhs</em> </td>
333 <td class="mlabels-right">
334 <span class="mlabels"><span class="mlabel">friend</span></span> </td>
337 </div><div class="memdoc">
339 <p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l12205">12205</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
343 <hr/>The documentation for this class was generated from the following file:<ul>
344 <li><a class="el" href="json_8hpp_source.html">json.hpp</a></li>
346 </div><!-- contents -->
347 <!-- start footer part -->
348 <hr class="footer"/><address class="footer"><small>
349 Generated by  <a href="http://www.doxygen.org/index.html">
350 <img class="footer" src="doxygen.png" alt="doxygen"/>