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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: Xapian::LatLongCoords Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</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> |
<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>
<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:a3a74623ff33240465f6383e5effd6718"><td class="memItemLeft" align="right" valign="top"><a id="a3a74623ff33240465f6383e5effd6718"></a>
<a class="el" href="classXapian_1_1LatLongCoordsIterator.html">LatLongCoordsIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#a3a74623ff33240465f6383e5effd6718">begin</a> () const</td></tr>
<tr class="memdesc:a3a74623ff33240465f6383e5effd6718"><td class="mdescLeft"> </td><td class="mdescRight">Get a begin iterator for the coordinates. <br /></td></tr>
<tr class="separator:a3a74623ff33240465f6383e5effd6718"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f2791d019b82d4f8bdf5c421a69574c"><td class="memItemLeft" align="right" valign="top"><a id="a5f2791d019b82d4f8bdf5c421a69574c"></a>
<a class="el" href="classXapian_1_1LatLongCoordsIterator.html">LatLongCoordsIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#a5f2791d019b82d4f8bdf5c421a69574c">end</a> () const</td></tr>
<tr class="memdesc:a5f2791d019b82d4f8bdf5c421a69574c"><td class="mdescLeft"> </td><td class="mdescRight">Get an end iterator for the coordinates. <br /></td></tr>
<tr class="separator:a5f2791d019b82d4f8bdf5c421a69574c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2cfcb41799e6e9e43454d5a253b164aa"><td class="memItemLeft" align="right" valign="top"><a id="a2cfcb41799e6e9e43454d5a253b164aa"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#a2cfcb41799e6e9e43454d5a253b164aa">size</a> () const</td></tr>
<tr class="memdesc:a2cfcb41799e6e9e43454d5a253b164aa"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of coordinates in the container. <br /></td></tr>
<tr class="separator:a2cfcb41799e6e9e43454d5a253b164aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab95368c7ed6916a62a829812eac5f58b"><td class="memItemLeft" align="right" valign="top"><a id="ab95368c7ed6916a62a829812eac5f58b"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#ab95368c7ed6916a62a829812eac5f58b">empty</a> () const</td></tr>
<tr class="memdesc:ab95368c7ed6916a62a829812eac5f58b"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:a4383a3d4354c392208e974200e79a7e3"><td class="memItemLeft" align="right" valign="top"><a id="a4383a3d4354c392208e974200e79a7e3"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#a4383a3d4354c392208e974200e79a7e3">append</a> (const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &coord)</td></tr>
<tr class="memdesc:a4383a3d4354c392208e974200e79a7e3"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:a2bb4337208d1850b2b476fc975e06aaa"><td class="memItemLeft" align="right" valign="top"><a id="a2bb4337208d1850b2b476fc975e06aaa"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#a2bb4337208d1850b2b476fc975e06aaa">LatLongCoords</a> ()</td></tr>
<tr class="memdesc:a2bb4337208d1850b2b476fc975e06aaa"><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty container. <br /></td></tr>
<tr class="separator:a2bb4337208d1850b2b476fc975e06aaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01e74d652bae14ecac5526d5eb08027b"><td class="memItemLeft" align="right" valign="top"><a id="a01e74d652bae14ecac5526d5eb08027b"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#a01e74d652bae14ecac5526d5eb08027b">LatLongCoords</a> (const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &coord)</td></tr>
<tr class="memdesc:a01e74d652bae14ecac5526d5eb08027b"><td class="mdescLeft"> </td><td class="mdescRight">Construct a container holding one coordinate. <br /></td></tr>
<tr class="separator:a01e74d652bae14ecac5526d5eb08027b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33680af41e8ab71ea3e0a61076681430"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#a33680af41e8ab71ea3e0a61076681430">unserialise</a> (const std::string &serialised)</td></tr>
<tr class="memdesc:a33680af41e8ab71ea3e0a61076681430"><td class="mdescLeft"> </td><td class="mdescRight">Unserialise a string and set this object to the coordinates in it. <a href="#a33680af41e8ab71ea3e0a61076681430">More...</a><br /></td></tr>
<tr class="separator:a33680af41e8ab71ea3e0a61076681430"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abbf1adc9898aca341783e03b40f31897"><td class="memItemLeft" align="right" valign="top"><a id="abbf1adc9898aca341783e03b40f31897"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#abbf1adc9898aca341783e03b40f31897">serialise</a> () const</td></tr>
<tr class="memdesc:abbf1adc9898aca341783e03b40f31897"><td class="mdescLeft"> </td><td class="mdescRight">Return a serialised form of the coordinate list. <br /></td></tr>
<tr class="separator:abbf1adc9898aca341783e03b40f31897"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1f12f56db65001241f15cada42fe933"><td class="memItemLeft" align="right" valign="top"><a id="ab1f12f56db65001241f15cada42fe933"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongCoords.html#ab1f12f56db65001241f15cada42fe933">get_description</a> () const</td></tr>
<tr class="memdesc:ab1f12f56db65001241f15cada42fe933"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:ab1f12f56db65001241f15cada42fe933"><td class="memSeparator" colspan="2"> </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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33680af41e8ab71ea3e0a61076681430">◆ </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 & </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 -->
<hr>
<address><small>
Documentation for Xapian (version 1.4.3).<br>
Generated on Wed Jan 25 2017 by
<a href="http://www.doxygen.org/">Doxygen 1.8.13</a>.
</small></address>
</body>
</html>
|