Marble::PositionProviderPluginInterface Class Reference

#include <PositionProviderPluginInterface.h>

Inheritance diagram for Marble::PositionProviderPluginInterface:

Public Member Functions
virtual	~PositionProviderPluginInterface ()
virtual GeoDataAccuracy	accuracy () const =0
virtual qreal	direction () const =0
virtual QString	error () const
virtual void	initialize ()=0
virtual bool	isInitialized () const =0
virtual GeoDataCoordinates	position () const =0
virtual qreal	speed () const =0
virtual PositionProviderStatus	status () const =0
virtual QDateTime	timestamp () const =0
Public Member Functions inherited from Marble::PluginInterface
virtual	~PluginInterface ()
virtual QString	aboutDataText () const
virtual QString	copyrightYears () const =0
virtual QString	description () const =0
virtual QIcon	icon () const =0
virtual QString	name () const =0
virtual QString	nameId () const =0
virtual QList< PluginAuthor >	pluginAuthors () const =0
virtual QString	version () const =0

Detailed Description

The interface for position provider plugins.

Definition at line 36 of file PositionProviderPluginInterface.h.

Constructor & Destructor Documentation

Marble::PositionProviderPluginInterface::~PositionProviderPluginInterface ( )

virtual

Definition at line 16 of file PositionProviderPluginInterface.cpp.

Member Function Documentation

virtual GeoDataAccuracy Marble::PositionProviderPluginInterface::accuracy ( ) const

pure virtual

Implemented in Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::GeoCluePositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, Marble::GpsdPositionProviderPlugin, and Marble::FlightGearPositionProviderPlugin.

virtual qreal Marble::PositionProviderPluginInterface::direction ( ) const

pure virtual

Returns the direction in which the gps device is moving.

The direction is an angle (in degrees) clockwise from geographical north

Implemented in Marble::GpsdPositionProviderPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, Marble::FlightGearPositionProviderPlugin, Marble::QtMobilityPositionProviderPlugin, and Marble::RouteSimulationPositionProviderPlugin.

QString Marble::PositionProviderPluginInterface::error ( ) const

virtual

Returns an error string to be presented to the user if the status is PositionProviderStatusError.

For other states, the result value is undefined.

Reimplemented in Marble::GpsdPositionProviderPlugin, and Marble::FlightGearPositionProviderPlugin.

Definition at line 21 of file PositionProviderPluginInterface.cpp.

virtual void Marble::PositionProviderPluginInterface::initialize ( )

pure virtual

Implemented in Marble::GeoCluePositionProviderPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::GpsdPositionProviderPlugin, Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, and Marble::FlightGearPositionProviderPlugin.

virtual bool Marble::PositionProviderPluginInterface::isInitialized ( ) const

pure virtual

Implemented in Marble::GeoCluePositionProviderPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::GpsdPositionProviderPlugin, Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, and Marble::FlightGearPositionProviderPlugin.

virtual GeoDataCoordinates Marble::PositionProviderPluginInterface::position ( ) const

pure virtual

Implemented in Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::GeoCluePositionProviderPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::GpsdPositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, and Marble::FlightGearPositionProviderPlugin.

virtual qreal Marble::PositionProviderPluginInterface::speed ( ) const

pure virtual

Returns the speed of the gps device in meters per second.

Implemented in Marble::GpsdPositionProviderPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, Marble::FlightGearPositionProviderPlugin, Marble::QtMobilityPositionProviderPlugin, and Marble::RouteSimulationPositionProviderPlugin.

virtual PositionProviderStatus Marble::PositionProviderPluginInterface::status ( ) const

pure virtual

Implemented in Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::GeoCluePositionProviderPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::GpsdPositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, and Marble::FlightGearPositionProviderPlugin.

virtual QDateTime Marble::PositionProviderPluginInterface::timestamp ( ) const

pure virtual

Implemented in Marble::GpsdPositionProviderPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, Marble::FlightGearPositionProviderPlugin, Marble::QtMobilityPositionProviderPlugin, and Marble::RouteSimulationPositionProviderPlugin.

---

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

• PositionProviderPluginInterface.h
• PositionProviderPluginInterface.cpp