← Back to branch summary

~ubuntu-branches/ubuntu/quantal/qtmobility/quantal

« back to all changes in this revision

Viewing changes to doc/html/qgeoroutesegment.html

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2010-11-16 16:18:07 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20101116161807-k2dzt2nyse975r3l
Tags: 1.1.0-0ubuntu1
* New upstream release
* Syncronise with Debian, no remaining changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qgeoroutesegment.html
47
47
    </div>
48
48
    <div id="shortCut">
49
49
      <ul>
50
 
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1 BETA</a></span></li>
 
50
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1</a></span></li>
51
51
        <li class="shortCut-topleft-active"><a href="http://doc.qt.nokia.com">ALL VERSIONS        </a></li>
52
52
      </ul>
53
53
     </div>
159
159
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#QGeoRouteSegment-2">QGeoRouteSegment</a></b> ( const QGeoRouteSegment &amp; <i>other</i> )</td></tr>
160
160
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#dtor.QGeoRouteSegment">~QGeoRouteSegment</a></b> ()</td></tr>
161
161
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#distance">distance</a></b> () const</td></tr>
162
 
<tr><td class="memItemLeft rightAlign topAlign"> QGeoInstruction </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#instruction">instruction</a></b> () const</td></tr>
 
162
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#isValid">isValid</a></b> () const</td></tr>
 
163
<tr><td class="memItemLeft rightAlign topAlign"> QGeoManeuver </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#maneuver">maneuver</a></b> () const</td></tr>
 
164
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRouteSegment </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#nextRouteSegment">nextRouteSegment</a></b> () const</td></tr>
163
165
<tr><td class="memItemLeft rightAlign topAlign"> QList&lt;QGeoCoordinate&gt; </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#path">path</a></b> () const</td></tr>
164
166
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#setDistance">setDistance</a></b> ( qreal <i>distance</i> )</td></tr>
165
 
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#setInstruction">setInstruction</a></b> ( const QGeoInstruction &amp; <i>instruction</i> )</td></tr>
 
167
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#setManeuver">setManeuver</a></b> ( const QGeoManeuver &amp; <i>maneuver</i> )</td></tr>
 
168
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#setNextRouteSegment">setNextRouteSegment</a></b> ( const QGeoRouteSegment &amp; <i>routeSegment</i> )</td></tr>
166
169
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#setPath">setPath</a></b> ( const QList&lt;QGeoCoordinate&gt; &amp; <i>path</i> )</td></tr>
167
170
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#setTravelTime">setTravelTime</a></b> ( int <i>secs</i> )</td></tr>
168
171
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutesegment.html#travelTime">travelTime</a></b> () const</td></tr>
175
178
<div class="descr"/>
176
179
<h2>Detailed Description</h2>
177
180
<p>The QGeoRouteSegment class represents a segment of a route.</p>
178
 
<p>A QGeoRouteSegment instance has information about the physcial layout of the route segment, the length of the route and the estimated time and navigation instructions required to traverse the route segment.</p>
 
181
<p>A QGeoRouteSegment instance has information about the physcial layout of the route segment, the length of the route and estimated time required to traverse the route segment and an optional <a href="qgeomaneuver.html">QGeoManeuver</a> associated with the end of the route segment.</p>
 
182
<p>QGeoRouteSegment instances can be thought of as edges on a routing graph, with <a href="qgeomaneuver.html">QGeoManeuver</a> instances as optional labels attached to the vertices of the graph.</p>
179
183
</div>
180
184
<hr />
181
185
<div class="func"/>
182
186
<h2>Member Function Documentation</h2>
183
187
<h3 class="fn"><a name="QGeoRouteSegment"></a>QGeoRouteSegment::QGeoRouteSegment ()</h3>
184
 
<p>Constructs a route segment object.</p>
 
188
<p>Constructs an invalid route segment object.</p>
 
189
<p>The route segment will remain invalid until one of <a href="qgeoroutesegment.html#setNextRouteSegment">setNextRouteSegment</a>(), <a href="qgeoroutesegment.html#setTravelTime">setTravelTime</a>(), <a href="qgeoroutesegment.html#setDistance">setDistance</a>(), <a href="qgeoroutesegment.html#setPath">setPath</a>() or <a href="qgeoroutesegment.html#setManeuver">setManeuver</a>() is called.</p>
185
190
<h3 class="fn"><a name="QGeoRouteSegment-2"></a>QGeoRouteSegment::QGeoRouteSegment ( const QGeoRouteSegment &amp; <i>other</i> )</h3>
186
191
<p>Constructs a route segment object from the contents of <i>other</i>.</p>
187
192
<h3 class="fn"><a name="dtor.QGeoRouteSegment"></a>QGeoRouteSegment::~QGeoRouteSegment ()</h3>
188
193
<p>Destroys this route segment object.</p>
189
 
<h3 class="fn"><a name="distance"></a>qreal QGeoRouteSegment::distance () const</h3>
 
194
<h3 class="fn"><a name="distance"></a><a href="http://qt.nokia.com/doc/4.6/qtglobal.html#qreal-typedef">qreal</a> QGeoRouteSegment::distance () const</h3>
190
195
<p>Returns the distance covered by this segment of the route, in metres.</p>
191
196
<p>See also <a href="qgeoroutesegment.html#setDistance">setDistance</a>().</p>
192
 
<h3 class="fn"><a name="instruction"></a><a href="qgeoinstruction.html">QGeoInstruction</a> QGeoRouteSegment::instruction () const</h3>
193
 
<p>Returns the instruction for this route segment.</p>
194
 
<p>See also <a href="qgeoroutesegment.html#setInstruction">setInstruction</a>().</p>
195
 
<h3 class="fn"><a name="path"></a>QList&lt;<a href="qgeocoordinate.html">QGeoCoordinate</a>&gt; QGeoRouteSegment::path () const</h3>
 
197
<h3 class="fn"><a name="isValid"></a>bool QGeoRouteSegment::isValid () const</h3>
 
198
<p>Returns whether this route segment is valid or not.</p>
 
199
<p>If <a href="qgeoroutesegment.html#nextRouteSegment">nextRouteSegment</a>() is called on the last route segment of a route, the returned value will be an invalid route segment.</p>
 
200
<h3 class="fn"><a name="maneuver"></a><a href="qgeomaneuver.html">QGeoManeuver</a> QGeoRouteSegment::maneuver () const</h3>
 
201
<p>Returns the manevuer for this route segment.</p>
 
202
<p>Will return an invalid <a href="qgeomaneuver.html">QGeoManeuver</a> if no information has been attached to the endpoint of this route segment.</p>
 
203
<p>See also <a href="qgeoroutesegment.html#setManeuver">setManeuver</a>().</p>
 
204
<h3 class="fn"><a name="nextRouteSegment"></a>QGeoRouteSegment QGeoRouteSegment::nextRouteSegment () const</h3>
 
205
<p>Returns the next route segment in the route.</p>
 
206
<p>Will return an invalid route segment if this is the last route segment in the route.</p>
 
207
<p>See also <a href="qgeoroutesegment.html#setNextRouteSegment">setNextRouteSegment</a>().</p>
 
208
<h3 class="fn"><a name="path"></a><a href="http://qt.nokia.com/doc/4.6/qlist.html">QList</a>&lt;<a href="qgeocoordinate.html">QGeoCoordinate</a>&gt; QGeoRouteSegment::path () const</h3>
196
209
<p>Returns the geometric shape of this route segment of the route.</p>
197
210
<p>The coordinates should be listed in the order in which they would be traversed by someone travelling along this segment of the route.</p>
198
211
<p>See also <a href="qgeoroutesegment.html#setPath">setPath</a>().</p>
199
 
<h3 class="fn"><a name="setDistance"></a>void QGeoRouteSegment::setDistance ( qreal <i>distance</i> )</h3>
 
212
<h3 class="fn"><a name="setDistance"></a>void QGeoRouteSegment::setDistance ( <a href="http://qt.nokia.com/doc/4.6/qtglobal.html#qreal-typedef">qreal</a> <i>distance</i> )</h3>
200
213
<p>Sets the distance covered by this segment of the route, in metres, to <i>distance</i>.</p>
201
214
<p>See also <a href="qgeoroutesegment.html#distance">distance</a>().</p>
202
 
<h3 class="fn"><a name="setInstruction"></a>void QGeoRouteSegment::setInstruction ( const <a href="qgeoinstruction.html">QGeoInstruction</a> &amp; <i>instruction</i> )</h3>
203
 
<p>Sets the instruction for this route segement to <i>instruction</i>.</p>
204
 
<p>See also <a href="qgeoroutesegment.html#instruction">instruction</a>().</p>
205
 
<h3 class="fn"><a name="setPath"></a>void QGeoRouteSegment::setPath ( const QList&lt;<a href="qgeocoordinate.html">QGeoCoordinate</a>&gt; &amp; <i>path</i> )</h3>
 
215
<h3 class="fn"><a name="setManeuver"></a>void QGeoRouteSegment::setManeuver ( const <a href="qgeomaneuver.html">QGeoManeuver</a> &amp; <i>maneuver</i> )</h3>
 
216
<p>Sets the maneuver for this route segement to <i>maneuver</i>.</p>
 
217
<p>See also <a href="qgeoroutesegment.html#maneuver">maneuver</a>().</p>
 
218
<h3 class="fn"><a name="setNextRouteSegment"></a>void QGeoRouteSegment::setNextRouteSegment ( const QGeoRouteSegment &amp; <i>routeSegment</i> )</h3>
 
219
<p>Sets the next route segment in the route to <i>routeSegment</i>.</p>
 
220
<p>See also <a href="qgeoroutesegment.html#nextRouteSegment">nextRouteSegment</a>().</p>
 
221
<h3 class="fn"><a name="setPath"></a>void QGeoRouteSegment::setPath ( const <a href="http://qt.nokia.com/doc/4.6/qlist.html">QList</a>&lt;<a href="qgeocoordinate.html">QGeoCoordinate</a>&gt; &amp; <i>path</i> )</h3>
206
222
<p>Sets the geometric shape of this segment of the route to <i>path</i>.</p>
207
223
<p>The coordinates in <i>path</i> should be listed in the order in which they would be traversed by someone travelling along this segment of the route.</p>
208
224
<p>See also <a href="qgeoroutesegment.html#path">path</a>().</p>
214
230
<p>See also <a href="qgeoroutesegment.html#setTravelTime">setTravelTime</a>().</p>
215
231
<h3 class="fn"><a name="operator-not-eq"></a>bool QGeoRouteSegment::operator!= ( const QGeoRouteSegment &amp; <i>other</i> ) const</h3>
216
232
<p>Returns whether this route segment and <i>other</i> are not equal.</p>
 
233
<p>The value of <a href="qgeoroutesegment.html#nextRouteSegment">nextRouteSegment</a>() is not considered in the comparison.</p>
217
234
<h3 class="fn"><a name="operator-eq"></a>QGeoRouteSegment &amp; QGeoRouteSegment::operator= ( const QGeoRouteSegment &amp; <i>other</i> )</h3>
218
235
<p>Assigns <i>other</i> to this route segment object and then returns a reference to this route segment object.</p>
219
236
<h3 class="fn"><a name="operator-eq-eq"></a>bool QGeoRouteSegment::operator== ( const QGeoRouteSegment &amp; <i>other</i> ) const</h3>
220
237
<p>Returns whether this route segment and <i>other</i> are equal.</p>
 
238
<p>The value of <a href="qgeoroutesegment.html#nextRouteSegment">nextRouteSegment</a>() is not considered in the comparison.</p>
221
239
</div>
222
240
        <!-- /div -->
223
241
        <div class="feedback t_button">