Route Class Reference

Container for a single route. More...

#include <route.h>

List of all members.

Public Member Functions

 Route ()
 Constructor.
void appendGeometryPoint (const GeoCoordinate &geometryPoint)
 Append geometry point (a.k.a track point) of the route.
void appendSegment (const RouteSegment &segment)
 Append a route segment to the route.
const QString & endPointName () const
 Getter for route end point name.
const QList< GeoCoordinate > & geometryPoints () const
 Get list of geometry points.
const QList< RouteSegment > & segments () const
 Get list of route segments.
void setEndPointName (const QString &endPoint)
 Set name of the route end point.
void setStartPointName (const QString &startPoint)
 Set name of the route start point.
void setTotalDistance (int meters)
 Set total distance of the route.
void setTotalTime (int seconds)
 Set estimated total travel time of the route.
const QString & startPointName () const
 Getter for route start point name.
int totalDistance () const
 Getter for total route distance.
int totalTime () const
 Getter for estimated travel time.

Private Attributes

int m_totalDistance
 route total distance in meters
int m_totalTime
 estimated route total time in seconds
QList< GeoCoordinatem_geometryPoints
 lat/lon coordinates of the route points
QList< RouteSegmentm_segments
 route segments
QString m_endPointName
 name of the route end point
QString m_startPointName
 name of the route starting point

Detailed Description

Container for a single route.

Contains all data for a single route including route geometry points (a.k.a track points) and route segments.

Author:
Sami Rämö - sami.ramo@ixonos.com

Member Function Documentation

void Route::appendGeometryPoint ( const GeoCoordinate geometryPoint  ) 

Append geometry point (a.k.a track point) of the route.

Appending must be done in order starting from the beginning of the route.

Parameters:
geometryPoint Geometry point
void Route::appendSegment ( const RouteSegment segment  ) 

Append a route segment to the route.

Appending must be done in order starting from the beginning of the route.

Parameters:
segment Route segment object
const QString & Route::endPointName (  )  const

Getter for route end point name.

Returns:
Name of the end point (or empty QString)
const QList< GeoCoordinate > & Route::geometryPoints (  )  const

Get list of geometry points.

Returns:
Reference to list of geometry points
const QList< RouteSegment > & Route::segments (  )  const

Get list of route segments.

Returns:
Reference to list of route segments
void Route::setEndPointName ( const QString &  endPoint  ) 

Set name of the route end point.

Parameters:
endPoint Name of the end point
void Route::setStartPointName ( const QString &  startPoint  ) 

Set name of the route start point.

Parameters:
startPoint Name of the route start point
void Route::setTotalDistance ( int  meters  ) 

Set total distance of the route.

Parameters:
meters Total distance of the route in meters
void Route::setTotalTime ( int  seconds  ) 

Set estimated total travel time of the route.

Parameters:
seconds Estimated total travel time
const QString & Route::startPointName (  )  const

Getter for route start point name.

Returns:
Name of the start point (or empty QString)
int Route::totalDistance (  )  const

Getter for total route distance.

Returns:
Total route distance in meters
int Route::totalTime (  )  const

Getter for estimated travel time.

Returns:
Estimated travel time in seconds

The documentation for this class was generated from the following files:

Generated on Fri Sep 3 12:05:42 2010 for Situare client for Maemo by  doxygen 1.6.1