Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 902

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qgeopositioninfo.cpp -->
  <title>Qt Mobility 1.2: QGeoPositionInfo Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtlocation.html">QtLocation</a></li>
<li>QGeoPositionInfo</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#related-non-members">Related Non-Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGeoPositionInfo Class Reference</h1>
<!-- $$$QGeoPositionInfo-brief -->
<p>The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time. <a href="#details">More...</a></p>
<!-- @@@QGeoPositionInfo -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QGeoPositionInfo&gt;</span></pre><p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qgeopositioninfo-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#Attribute-enum">Attribute</a></b> { Direction, GroundSpeed, VerticalSpeed, MagneticVariation, HorizontalAccuracy, VerticalAccuracy }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#QGeoPositionInfo">QGeoPositionInfo</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#QGeoPositionInfo-2">QGeoPositionInfo</a></b> ( const QGeoCoordinate &amp; <i>coordinate</i>, const QDateTime &amp; <i>timestamp</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#QGeoPositionInfo-3">QGeoPositionInfo</a></b> ( const QGeoPositionInfo &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#dtor.QGeoPositionInfo">~QGeoPositionInfo</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#attribute">attribute</a></b> ( Attribute <i>attribute</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoCoordinate </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#coordinate">coordinate</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#hasAttribute">hasAttribute</a></b> ( Attribute <i>attribute</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#removeAttribute">removeAttribute</a></b> ( Attribute <i>attribute</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#setAttribute">setAttribute</a></b> ( Attribute <i>attribute</i>, qreal <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#setCoordinate">setCoordinate</a></b> ( const QGeoCoordinate &amp; <i>coordinate</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#setTimestamp">setTimestamp</a></b> ( const QDateTime &amp; <i>timestamp</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDateTime </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#timestamp">timestamp</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-not-eq">operator!=</a></b> ( const QGeoPositionInfo &amp; <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoPositionInfo &amp; </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-eq">operator=</a></b> ( const QGeoPositionInfo &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-eq-eq">operator==</a></b> ( const QGeoPositionInfo &amp; <i>other</i> ) const</td></tr>
</table>
<a name="related-non-members"></a>
<h2>Related Non-Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream &amp; </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-lt-lt-99">operator&lt;&lt;</a></b> ( QDataStream &amp; <i>stream</i>, const QGeoPositionInfo &amp; <i>info</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream &amp; </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-gt-gt-84">operator&gt;&gt;</a></b> ( QDataStream &amp; <i>stream</i>, QGeoPositionInfo &amp; <i>info</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QGeoPositionInfo-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time.</p>
<p>A QGeoPositionInfo contains, at a minimum, a geographical coordinate and a timestamp. It may also have heading and speed measurements as well as estimates of the accuracy of the provided data.</p>
</div>
<p><b>See also </b><a href="qgeopositioninfosource.html">QGeoPositionInfoSource</a>.</p>
<!-- @@@QGeoPositionInfo -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Attribute$$$Direction$$$GroundSpeed$$$VerticalSpeed$$$MagneticVariation$$$HorizontalAccuracy$$$VerticalAccuracy -->
<h3 class="fn"><a name="Attribute-enum"></a>enum QGeoPositionInfo::<span class="name">Attribute</span></h3>
<p>Defines the attributes for positional information.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::Direction</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The bearing to true north from the direction of travel, in degrees.</td></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::GroundSpeed</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The ground speed, in metres/sec.</td></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::VerticalSpeed</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The vertical speed, in metres/sec.</td></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::MagneticVariation</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The angle between the horizontal component of the magnetic field and true north, in degrees. Also known as magnetic declination. A positive value indicates a clockwise direction from true north and a negative value indicates a counter-clockwise direction.</td></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::HorizontalAccuracy</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The accuracy of the provided latitude-longitude value, in metres.</td></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::VerticalAccuracy</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">The accuracy of the provided altitude value, in metres.</td></tr>
</table>
<!-- @@@Attribute -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoPositionInfo[overload1]$$$QGeoPositionInfo -->
<h3 class="fn"><a name="QGeoPositionInfo"></a>QGeoPositionInfo::<span class="name">QGeoPositionInfo</span> ()</h3>
<p>Creates an invalid <a href="qgeopositioninfo.html">QGeoPositionInfo</a> object.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#isValid">isValid</a>().</p>
<!-- @@@QGeoPositionInfo -->
<!-- $$$QGeoPositionInfo$$$QGeoPositionInfoconstQGeoCoordinate&constQDateTime& -->
<h3 class="fn"><a name="QGeoPositionInfo-2"></a>QGeoPositionInfo::<span class="name">QGeoPositionInfo</span> ( const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> &amp; <i>coordinate</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatetime.html">QDateTime</a></span> &amp; <i>timestamp</i> )</h3>
<p>Creates a <a href="qgeopositioninfo.html">QGeoPositionInfo</a> for the given <i>coordinate</i> and <i>timestamp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@QGeoPositionInfo -->
<!-- $$$QGeoPositionInfo$$$QGeoPositionInfoconstQGeoPositionInfo& -->
<h3 class="fn"><a name="QGeoPositionInfo-3"></a>QGeoPositionInfo::<span class="name">QGeoPositionInfo</span> ( const <span class="type">QGeoPositionInfo</span> &amp; <i>other</i> )</h3>
<p>Creates a <a href="qgeopositioninfo.html">QGeoPositionInfo</a> with the values of <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@QGeoPositionInfo -->
<!-- $$$~QGeoPositionInfo[overload1]$$$~QGeoPositionInfo -->
<h3 class="fn"><a name="dtor.QGeoPositionInfo"></a>QGeoPositionInfo::<span class="name">~QGeoPositionInfo</span> ()</h3>
<p>Destroys a <a href="qgeopositioninfo.html">QGeoPositionInfo</a> object.</p>
<!-- @@@~QGeoPositionInfo -->
<!-- $$$attribute[overload1]$$$attributeAttribute -->
<h3 class="fn"><a name="attribute"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span> QGeoPositionInfo::<span class="name">attribute</span> ( <span class="type"><a href="qgeopositioninfo.html#Attribute-enum">Attribute</a></span> <i>attribute</i> ) const</h3>
<p>Returns the value of the specified <i>attribute</i> as a qreal value.</p>
<p>Returns -1 if the value has not been set, although this may also be a legitimate value for some attributes.</p>
<p>The function <a href="qgeopositioninfo.html#hasAttribute">hasAttribute</a>() should be used to determine whether or not a value has been set for an attribute.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#hasAttribute">hasAttribute</a>() and <a href="qgeopositioninfo.html#setAttribute">setAttribute</a>().</p>
<!-- @@@attribute -->
<!-- $$$coordinate[overload1]$$$coordinate -->
<h3 class="fn"><a name="coordinate"></a><span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> QGeoPositionInfo::<span class="name">coordinate</span> () const</h3>
<p>Returns the coordinate for this position.</p>
<p>Returns an invalid coordinate if no coordinate has been set.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#setCoordinate">setCoordinate</a>().</p>
<!-- @@@coordinate -->
<!-- $$$hasAttribute[overload1]$$$hasAttributeAttribute -->
<h3 class="fn"><a name="hasAttribute"></a><span class="type">bool</span> QGeoPositionInfo::<span class="name">hasAttribute</span> ( <span class="type"><a href="qgeopositioninfo.html#Attribute-enum">Attribute</a></span> <i>attribute</i> ) const</h3>
<p>Returns true if the specified <i>attribute</i> is present for this <a href="qgeopositioninfo.html">QGeoPositionInfo</a> object.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@hasAttribute -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QGeoPositionInfo::<span class="name">isValid</span> () const</h3>
<p>Returns true if the <a href="qgeopositioninfo.html#timestamp">timestamp</a>() and <a href="qgeopositioninfo.html#coordinate">coordinate</a>() values are both valid.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qgeocoordinate.html#isValid">QGeoCoordinate::isValid</a>() and <a href="http://qt.nokia.com/doc/4.7/qdatetime.html#isValid">QDateTime::isValid</a>().</p>
<!-- @@@isValid -->
<!-- $$$removeAttribute[overload1]$$$removeAttributeAttribute -->
<h3 class="fn"><a name="removeAttribute"></a><span class="type">void</span> QGeoPositionInfo::<span class="name">removeAttribute</span> ( <span class="type"><a href="qgeopositioninfo.html#Attribute-enum">Attribute</a></span> <i>attribute</i> )</h3>
<p>Removes the specified <i>attribute</i> and its value.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@removeAttribute -->
<!-- $$$setAttribute[overload1]$$$setAttributeAttributeqreal -->
<h3 class="fn"><a name="setAttribute"></a><span class="type">void</span> QGeoPositionInfo::<span class="name">setAttribute</span> ( <span class="type"><a href="qgeopositioninfo.html#Attribute-enum">Attribute</a></span> <i>attribute</i>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span> <i>value</i> )</h3>
<p>Sets the value for <i>attribute</i> to <i>value</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#attribute">attribute</a>().</p>
<!-- @@@setAttribute -->
<!-- $$$setCoordinate[overload1]$$$setCoordinateconstQGeoCoordinate& -->
<h3 class="fn"><a name="setCoordinate"></a><span class="type">void</span> QGeoPositionInfo::<span class="name">setCoordinate</span> ( const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> &amp; <i>coordinate</i> )</h3>
<p>Sets the coordinate for this position to <i>coordinate</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#coordinate">coordinate</a>().</p>
<!-- @@@setCoordinate -->
<!-- $$$setTimestamp[overload1]$$$setTimestampconstQDateTime& -->
<h3 class="fn"><a name="setTimestamp"></a><span class="type">void</span> QGeoPositionInfo::<span class="name">setTimestamp</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatetime.html">QDateTime</a></span> &amp; <i>timestamp</i> )</h3>
<p>Sets the date and time at which this position was reported to <i>timestamp</i>.</p>
<p>The <i>timestamp</i> must be in UTC time.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#timestamp">timestamp</a>().</p>
<!-- @@@setTimestamp -->
<!-- $$$timestamp[overload1]$$$timestamp -->
<h3 class="fn"><a name="timestamp"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatetime.html">QDateTime</a></span> QGeoPositionInfo::<span class="name">timestamp</span> () const</h3>
<p>Returns the date and time at which this position was reported, in UTC time.</p>
<p>Returns an invalid <a href="http://qt.nokia.com/doc/4.7/qdatetime.html">QDateTime</a> if no date/time value has been set.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#setTimestamp">setTimestamp</a>().</p>
<!-- @@@timestamp -->
<!-- $$$operator!=[overload1]$$$operator!=constQGeoPositionInfo& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QGeoPositionInfo::<span class="name">operator!=</span> ( const <span class="type">QGeoPositionInfo</span> &amp; <i>other</i> ) const</h3>
<p>Returns true if any of this object's values are not the same as those of <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQGeoPositionInfo& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QGeoPositionInfo</span> &amp; QGeoPositionInfo::<span class="name">operator=</span> ( const <span class="type">QGeoPositionInfo</span> &amp; <i>other</i> )</h3>
<p>Assigns the values from <i>other</i> to this <a href="qgeopositioninfo.html">QGeoPositionInfo</a>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQGeoPositionInfo& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QGeoPositionInfo::<span class="name">operator==</span> ( const <span class="type">QGeoPositionInfo</span> &amp; <i>other</i> ) const</h3>
<p>Returns true if all of this object's values are the same as those of <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator== -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$operator<<$$$operator<<QDataStream&constQGeoPositionInfo& -->
<h3 class="fn"><a name="operator-lt-lt-99"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatastream.html">QDataStream</a></span> &amp; <span class="name">operator&lt;&lt;</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatastream.html">QDataStream</a></span> &amp; <i>stream</i>, const <span class="type">QGeoPositionInfo</span> &amp; <i>info</i> )</h3>
<p>Writes the given <i>info</i> to the specified <i>stream</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="http://qt.nokia.com/doc/4.7/datastreamformat.html">Serializing Qt Data Types</a>.</p>
<!-- @@@operator<< -->
<!-- $$$operator>>$$$operator>>QDataStream&QGeoPositionInfo& -->
<h3 class="fn"><a name="operator-gt-gt-84"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatastream.html">QDataStream</a></span> &amp; <span class="name">operator&gt;&gt;</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatastream.html">QDataStream</a></span> &amp; <i>stream</i>, <span class="type">QGeoPositionInfo</span> &amp; <i>info</i> )</h3>
<p>Reads a coordinate from the specified <i>stream</i> into the given <i>info</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="http://qt.nokia.com/doc/4.7/datastreamformat.html">Serializing Qt Data Types</a>.</p>
<!-- @@@operator>> -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
    Free Documentation License version 1.3</a>
    as published by the Free Software Foundation.</p>
</div>
</body>
</html>