File: classXapian_1_1LatLongCoords.html

package info (click to toggle)
xapian-core 1.4.22-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 22,816 kB
  • sloc: cpp: 92,138; ansic: 9,983; sh: 4,929; perl: 850; makefile: 503; javascript: 331; tcl: 319; python: 40
file content (146 lines) | stat: -rw-r--r-- 10,688 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::LatLongCoords 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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">xapian-core
   &#160;<span id="projectnumber">1.4.22</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classXapian_1_1LatLongCoords-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Xapian::LatLongCoords Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>A sequence of latitude-longitude coordinates.  
 <a href="classXapian_1_1LatLongCoords.html#details">More...</a></p>

<p><code>#include &lt;geospatial.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3a74623ff33240465f6383e5effd6718"><td class="memItemLeft" align="right" valign="top"><a id="a3a74623ff33240465f6383e5effd6718" name="a3a74623ff33240465f6383e5effd6718"></a>
<a class="el" href="classXapian_1_1LatLongCoordsIterator.html">LatLongCoordsIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> () const</td></tr>
<tr class="memdesc:a3a74623ff33240465f6383e5effd6718"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a begin iterator for the coordinates. <br /></td></tr>
<tr class="separator:a3a74623ff33240465f6383e5effd6718"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f2791d019b82d4f8bdf5c421a69574c"><td class="memItemLeft" align="right" valign="top"><a id="a5f2791d019b82d4f8bdf5c421a69574c" name="a5f2791d019b82d4f8bdf5c421a69574c"></a>
<a class="el" href="classXapian_1_1LatLongCoordsIterator.html">LatLongCoordsIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> () const</td></tr>
<tr class="memdesc:a5f2791d019b82d4f8bdf5c421a69574c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an end iterator for the coordinates. <br /></td></tr>
<tr class="separator:a5f2791d019b82d4f8bdf5c421a69574c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cfcb41799e6e9e43454d5a253b164aa"><td class="memItemLeft" align="right" valign="top"><a id="a2cfcb41799e6e9e43454d5a253b164aa" name="a2cfcb41799e6e9e43454d5a253b164aa"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> () const</td></tr>
<tr class="memdesc:a2cfcb41799e6e9e43454d5a253b164aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of coordinates in the container. <br /></td></tr>
<tr class="separator:a2cfcb41799e6e9e43454d5a253b164aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab95368c7ed6916a62a829812eac5f58b"><td class="memItemLeft" align="right" valign="top"><a id="ab95368c7ed6916a62a829812eac5f58b" name="ab95368c7ed6916a62a829812eac5f58b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>empty</b> () const</td></tr>
<tr class="memdesc:ab95368c7ed6916a62a829812eac5f58b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if and only if there are no coordinates in the container. <br /></td></tr>
<tr class="separator:ab95368c7ed6916a62a829812eac5f58b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4383a3d4354c392208e974200e79a7e3"><td class="memItemLeft" align="right" valign="top"><a id="a4383a3d4354c392208e974200e79a7e3" name="a4383a3d4354c392208e974200e79a7e3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>append</b> (const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &amp;coord)</td></tr>
<tr class="memdesc:a4383a3d4354c392208e974200e79a7e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append a coordinate to the end of the sequence. <br /></td></tr>
<tr class="separator:a4383a3d4354c392208e974200e79a7e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bb4337208d1850b2b476fc975e06aaa"><td class="memItemLeft" align="right" valign="top"><a id="a2bb4337208d1850b2b476fc975e06aaa" name="a2bb4337208d1850b2b476fc975e06aaa"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>LatLongCoords</b> ()</td></tr>
<tr class="memdesc:a2bb4337208d1850b2b476fc975e06aaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an empty container. <br /></td></tr>
<tr class="separator:a2bb4337208d1850b2b476fc975e06aaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01e74d652bae14ecac5526d5eb08027b"><td class="memItemLeft" align="right" valign="top"><a id="a01e74d652bae14ecac5526d5eb08027b" name="a01e74d652bae14ecac5526d5eb08027b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>LatLongCoords</b> (const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &amp;coord)</td></tr>
<tr class="memdesc:a01e74d652bae14ecac5526d5eb08027b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a container holding one coordinate. <br /></td></tr>
<tr class="separator:a01e74d652bae14ecac5526d5eb08027b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33680af41e8ab71ea3e0a61076681430"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#a33680af41e8ab71ea3e0a61076681430">unserialise</a> (const std::string &amp;serialised)</td></tr>
<tr class="memdesc:a33680af41e8ab71ea3e0a61076681430"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unserialise a string and set this object to the coordinates in it.  <a href="classXapian_1_1LatLongCoords.html#a33680af41e8ab71ea3e0a61076681430">More...</a><br /></td></tr>
<tr class="separator:a33680af41e8ab71ea3e0a61076681430"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbf1adc9898aca341783e03b40f31897"><td class="memItemLeft" align="right" valign="top"><a id="abbf1adc9898aca341783e03b40f31897" name="abbf1adc9898aca341783e03b40f31897"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>serialise</b> () const</td></tr>
<tr class="memdesc:abbf1adc9898aca341783e03b40f31897"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a serialised form of the coordinate list. <br /></td></tr>
<tr class="separator:abbf1adc9898aca341783e03b40f31897"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1f12f56db65001241f15cada42fe933"><td class="memItemLeft" align="right" valign="top"><a id="ab1f12f56db65001241f15cada42fe933" name="ab1f12f56db65001241f15cada42fe933"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>get_description</b> () const</td></tr>
<tr class="memdesc:ab1f12f56db65001241f15cada42fe933"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:ab1f12f56db65001241f15cada42fe933"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >A sequence of latitude-longitude coordinates. </p>
<p >Experimental - see <a href="https://xapian.org/docs/deprecation#experimental-features">https://xapian.org/docs/deprecation#experimental-features</a> </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a33680af41e8ab71ea3e0a61076681430" name="a33680af41e8ab71ea3e0a61076681430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33680af41e8ab71ea3e0a61076681430">&#9670;&nbsp;</a></span>unserialise()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Xapian::LatLongCoords::unserialise </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>serialised</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unserialise a string and set this object to the coordinates in it. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">serialised</td><td>the string to unserialise the coordinates from.</td></tr>
  </table>
  </dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classXapian_1_1SerialisationError.html" title="Indicates an error in the std::string serialisation of an object.">Xapian::SerialisationError</a></td><td>if the string does not contain a valid serialised latitude-longitude pair, or contains junk at the end of it. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="geospatial_8h.html">geospatial.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.4</a>
</small></address>
</body>
</html>