/usr/share/doc/geographiclib/html/classGeographicLib_1_1OSGB.html is in geographiclib-tools 1.8-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 | <!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"/>
<title>GeographicLib: GeographicLib::OSGB Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div 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><a href="namespaces.html"><span>Namespaces</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>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespaceGeographicLib.html">GeographicLib</a> </li>
<li><a class="el" href="classGeographicLib_1_1OSGB.html">GeographicLib::OSGB</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>GeographicLib::OSGB Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="GeographicLib::OSGB" -->
<p>Ordnance Survey grid system for Great Britain.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="OSGB_8hpp_source.html">GeographicLib/OSGB.hpp</a>></code></p>
<p><a href="classGeographicLib_1_1OSGB-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#a92618eea9870908e11446875d80aab6b">Forward</a> (real lat, real lon, real &x, real &y, real &gamma, real &k) throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#ae006380e574858a81011752dd1d4af60">Reverse</a> (real x, real y, real &lat, real &lon, real &gamma, real &k) throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#a0f705bee98c6669ca7a95394712fd758">Forward</a> (real lat, real lon, real &x, real &y) throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#ab804929a4126ed390a40d35e837b4001">Reverse</a> (real x, real y, real &lat, real &lon) throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#a0a79e8f2babae1eb0305a0e728fea8c8">GridReference</a> (real x, real y, int prec, std::string &gridref)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#a3693cfef49442747750e8393c81014aa">GridReference</a> (const std::string &gridref, real &x, real &y, int &prec, bool centerp=true)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Inspector functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp59c92495387f56c5711d0f52918a49b2"></a> </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#a9bb3b0ff55a462ac2ebcd0cfd446d811">MajorRadius</a> () throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#a72bb966b2a93e4607bfcbf78f5b80bb4">InverseFlattening</a> () throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#a65210bfdcac362f393a8f81f28259ad0">CentralScale</a> () throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#ad6bcef7e2dcc2992831e101bf0b05fa8">OriginLatitude</a> () throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#a4eb3b20734af47c9661d40581555c345">OriginLongitude</a> () throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#a74072d4e62fcd4ca679b222716b6a6a1">FalseNorthing</a> () throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGeographicLib_1_1OSGB.html#ab27e19f7688f6b472d217b31aeae079c">FalseEasting</a> () throw ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Ordnance Survey grid system for Great Britain. </p>
<p>The class implements the coordinate system used by the Ordnance Survey for maps of Great Britain and conversions to the grid reference system.</p>
<p>See</p>
<ul>
<li><a href="http://www.ordnancesurvey.co.uk/oswebsite/gps/docs/A_Guide_to_Coordinate_Systems_in_Great_Britain.pdf">A guide to coordinate systems in Great Britain</a></li>
<li><a href="http://www.ordnancesurvey.co.uk/oswebsite/gps/information/coordinatesystemsinfo/guidetonationalgrid/page1.html">Guide to National Grid</a></li>
</ul>
<p><b>WARNING:</b> the latitudes and longitudes for the Ordnance Survey grid system do not use the WGS84 datum. Do not use the values returned by this class in the <a class="el" href="classGeographicLib_1_1UTMUPS.html" title="Convert between Geographic coordinates and UTM/UPS.">UTMUPS</a>, <a class="el" href="classGeographicLib_1_1MGRS.html" title="Convert between UTM/UPS and MGRS.">MGRS</a>, or <a class="el" href="classGeographicLib_1_1Geoid.html" title="Looking up the height of the geoid.">Geoid</a> classes without first converting the datum (and vice versa). </p>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00036">36</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a92618eea9870908e11446875d80aab6b"></a><!-- doxytag: member="GeographicLib::OSGB::Forward" ref="a92618eea9870908e11446875d80aab6b" args="(real lat, real lon, real &x, real &y, real &gamma, real &k)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void GeographicLib::OSGB::Forward </td>
<td>(</td>
<td class="paramtype">real </td>
<td class="paramname"> <em>lat</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real </td>
<td class="paramname"> <em>lon</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>gamma</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>k</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Forward projection, from geographic to <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> coordinates.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>lat</em> </td><td>latitude of point (degrees). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>lon</em> </td><td>longitude of point (degrees). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>x</em> </td><td>easting of point (meters). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>y</em> </td><td>northing of point (meters). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>gamma</em> </td><td>meridian convergence at point (degrees). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>k</em> </td><td>scale of projection at point.</td></tr>
</table>
</dd>
</dl>
<p><em>lat</em> should be in the range [-90, 90]; <em>lon</em> and <em>lon0</em> should be in the range [-180, 360]. </p>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00083">83</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
<p>References <a class="el" href="OSGB_8hpp_source.html#l00217">FalseEasting()</a>, <a class="el" href="TransverseMercator_8cpp_source.html#l00217">GeographicLib::TransverseMercator::Forward()</a>, and <a class="el" href="OSGB_8hpp_source.html#l00207">OriginLongitude()</a>.</p>
<p>Referenced by <a class="el" href="OSGB_8hpp_source.html#l00113">Forward()</a>.</p>
</div>
</div>
<a class="anchor" id="ae006380e574858a81011752dd1d4af60"></a><!-- doxytag: member="GeographicLib::OSGB::Reverse" ref="ae006380e574858a81011752dd1d4af60" args="(real x, real y, real &lat, real &lon, real &gamma, real &k)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void GeographicLib::OSGB::Reverse </td>
<td>(</td>
<td class="paramtype">real </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>lat</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>lon</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>gamma</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>k</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reverse projection, from <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> coordinates to geographic.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>x</em> </td><td>easting of point (meters). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>y</em> </td><td>northing of point (meters). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>lat</em> </td><td>latitude of point (degrees). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>lon</em> </td><td>longitude of point (degrees). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>gamma</em> </td><td>meridian convergence at point (degrees). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>k</em> </td><td>scale of projection at point.</td></tr>
</table>
</dd>
</dl>
<p>The value of <em>lon</em> returned is in the range [-180, 180). </p>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00103">103</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
<p>References <a class="el" href="OSGB_8hpp_source.html#l00217">FalseEasting()</a>, <a class="el" href="OSGB_8hpp_source.html#l00207">OriginLongitude()</a>, and <a class="el" href="TransverseMercator_8cpp_source.html#l00387">GeographicLib::TransverseMercator::Reverse()</a>.</p>
<p>Referenced by <a class="el" href="OSGB_8hpp_source.html#l00121">Reverse()</a>.</p>
</div>
</div>
<a class="anchor" id="a0f705bee98c6669ca7a95394712fd758"></a><!-- doxytag: member="GeographicLib::OSGB::Forward" ref="a0f705bee98c6669ca7a95394712fd758" args="(real lat, real lon, real &x, real &y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void GeographicLib::OSGB::Forward </td>
<td>(</td>
<td class="paramtype">real </td>
<td class="paramname"> <em>lat</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real </td>
<td class="paramname"> <em>lon</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classGeographicLib_1_1OSGB.html#a92618eea9870908e11446875d80aab6b">OSGB::Forward</a> without returning the convergence and scale. </p>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00113">113</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
<p>References <a class="el" href="OSGB_8hpp_source.html#l00083">Forward()</a>.</p>
</div>
</div>
<a class="anchor" id="ab804929a4126ed390a40d35e837b4001"></a><!-- doxytag: member="GeographicLib::OSGB::Reverse" ref="ab804929a4126ed390a40d35e837b4001" args="(real x, real y, real &lat, real &lon)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void GeographicLib::OSGB::Reverse </td>
<td>(</td>
<td class="paramtype">real </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>lat</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>lon</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classGeographicLib_1_1OSGB.html#ae006380e574858a81011752dd1d4af60">OSGB::Reverse</a> without returning the convergence and scale. </p>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00121">121</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
<p>References <a class="el" href="OSGB_8hpp_source.html#l00103">Reverse()</a>.</p>
</div>
</div>
<a class="anchor" id="a0a79e8f2babae1eb0305a0e728fea8c8"></a><!-- doxytag: member="GeographicLib::OSGB::GridReference" ref="a0a79e8f2babae1eb0305a0e728fea8c8" args="(real x, real y, int prec, std::string &gridref)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GeographicLib::OSGB::GridReference </td>
<td>(</td>
<td class="paramtype">real </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>prec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>gridref</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> coordinates to a grid reference.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>x</em> </td><td>easting of point (meters). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>y</em> </td><td>northing of point (meters). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>prec</em> </td><td>precision relative to 100 km. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>gridref</em> </td><td>National Grid reference.</td></tr>
</table>
</dd>
</dl>
<p><em>prec</em> specifies the precision of the grid reference string as follows:</p>
<ul>
<li>prec = 0 (min), 100km</li>
<li>prec = 1, 10km</li>
<li>prec = 2, 1km</li>
<li>prec = 3, 100m</li>
<li>prec = 4, 10m</li>
<li>prec = 5, 1m</li>
<li>prec = 6, 0.1m</li>
<li>prec = 11 (max), 1um</li>
</ul>
<p>The easting must be in the range [-1000 km, 1500 km) and the northing must be in the range [-500 km, 2000 km). An exception is thrown if either the easting and northing is outside these bounds. These bounds are consistent with rules for the letter designations for the grid system. </p>
<p>Definition at line <a class="el" href="OSGB_8cpp_source.html#l00035">35</a> of file <a class="el" href="OSGB_8cpp_source.html">OSGB.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3693cfef49442747750e8393c81014aa"></a><!-- doxytag: member="GeographicLib::OSGB::GridReference" ref="a3693cfef49442747750e8393c81014aa" args="(const std::string &gridref, real &x, real &y, int &prec, bool centerp=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GeographicLib::OSGB::GridReference </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>gridref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real & </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>prec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>centerp</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> coordinates to a grid reference.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>gridref</em> </td><td>National Grid reference. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>x</em> </td><td>easting of point (meters). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>y</em> </td><td>northing of point (meters). </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>prec</em> </td><td>precision relative to 100 km. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>centerp</em> </td><td>if true (default), return center of the grid square, else return SW (lower left) corner.</td></tr>
</table>
</dd>
</dl>
<p>The grid reference must be of the form: two letters (not including I) followed by an even number of digits (up to 22). </p>
<p>Definition at line <a class="el" href="OSGB_8cpp_source.html#l00082">82</a> of file <a class="el" href="OSGB_8cpp_source.html">OSGB.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9bb3b0ff55a462ac2ebcd0cfd446d811"></a><!-- doxytag: member="GeographicLib::OSGB::MajorRadius" ref="a9bb3b0ff55a462ac2ebcd0cfd446d811" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> GeographicLib::OSGB::MajorRadius </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd><em>a</em> the equatorial radius of the Airy 1830 ellipsoid (meters).</dd></dl>
<p>This is 20923713 ft converted to meters using the rule 1 ft = 10^(9.48401603-10) m. (The Airy 1830 value is returned because the <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> projection is based on this ellipsoid.) </p>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00179">179</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a72bb966b2a93e4607bfcbf78f5b80bb4"></a><!-- doxytag: member="GeographicLib::OSGB::InverseFlattening" ref="a72bb966b2a93e4607bfcbf78f5b80bb4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> GeographicLib::OSGB::InverseFlattening </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd><em>r</em> the inverse flattening of the Airy 1830 ellipsoid.</dd></dl>
<p>For the Airy 1830 ellipsoid, <em>a</em> = 20923713 ft and <em>b</em> = 20853810 ft; thus the inverse flattening = 20923713/(20923713 - 20853810) = 2324857/7767 = 299.32496459... (The Airy 1830 value is returned because the <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> projection is based on this ellipsoid.) </p>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00190">190</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a65210bfdcac362f393a8f81f28259ad0"></a><!-- doxytag: member="GeographicLib::OSGB::CentralScale" ref="a65210bfdcac362f393a8f81f28259ad0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> GeographicLib::OSGB::CentralScale </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd><em>k0</em> central scale for the <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> projection (0.9996012717). </dd></dl>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00196">196</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad6bcef7e2dcc2992831e101bf0b05fa8"></a><!-- doxytag: member="GeographicLib::OSGB::OriginLatitude" ref="ad6bcef7e2dcc2992831e101bf0b05fa8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> GeographicLib::OSGB::OriginLatitude </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>latitude of the origin for the <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> projection (49 degrees). </dd></dl>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00202">202</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4eb3b20734af47c9661d40581555c345"></a><!-- doxytag: member="GeographicLib::OSGB::OriginLongitude" ref="a4eb3b20734af47c9661d40581555c345" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> GeographicLib::OSGB::OriginLongitude </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>longitude of the origin for the <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> projection (-2 degrees). </dd></dl>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00207">207</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
<p>Referenced by <a class="el" href="OSGB_8hpp_source.html#l00083">Forward()</a>, and <a class="el" href="OSGB_8hpp_source.html#l00103">Reverse()</a>.</p>
</div>
</div>
<a class="anchor" id="a74072d4e62fcd4ca679b222716b6a6a1"></a><!-- doxytag: member="GeographicLib::OSGB::FalseNorthing" ref="a74072d4e62fcd4ca679b222716b6a6a1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> GeographicLib::OSGB::FalseNorthing </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>false northing the <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> projection (-100000 meters). </dd></dl>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00212">212</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab27e19f7688f6b472d217b31aeae079c"></a><!-- doxytag: member="GeographicLib::OSGB::FalseEasting" ref="ab27e19f7688f6b472d217b31aeae079c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGeographicLib_1_1Math.html#aeee4778d7cf2f9fb9648efe4911da59d">Math::real</a> GeographicLib::OSGB::FalseEasting </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw ()<code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>false easting the <a class="el" href="classGeographicLib_1_1OSGB.html" title="Ordnance Survey grid system for Great Britain.">OSGB</a> projection (400000 meters). </dd></dl>
<p>Definition at line <a class="el" href="OSGB_8hpp_source.html#l00217">217</a> of file <a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a>.</p>
<p>Referenced by <a class="el" href="OSGB_8hpp_source.html#l00083">Forward()</a>, and <a class="el" href="OSGB_8hpp_source.html#l00103">Reverse()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OSGB_8hpp_source.html">OSGB.hpp</a></li>
<li><a class="el" href="OSGB_8cpp_source.html">OSGB.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 22 2011 for GeographicLib by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
|