Murl::Input::ILocationDevice Interface Reference

The ILocationDevice interface. More...

#include <murl_input_i_location_device.h>

Detailed Description

The ILocationDevice interface.

To receive data the device must be activated by IAppConfiguration::SetLocationActive().

Inheritance diagram for Murl::Input::ILocationDevice:

Public Member Functions
virtual Double	GetLatitude () const =0
	Get the latitude in degrees relative to the equator. More...
virtual Double	GetLongitude () const =0
	Get the longitude in degrees relative to the zero meridian. More...
virtual Double	GetAltitude () const =0
	Get the altitude above sea level in meters. More...
virtual Util::GeoLocation	GetGeoLocation () const =0
	Get the latitude, longitude and altitude geo location. More...
virtual Double	GetVelocity () const =0
	Get the velocity over ground in meters per second. More...
virtual Double	GetHorizontalAccuracy () const =0
	Get the radius of uncertainty for the location in meters. More...
virtual Double	GetVerticalAccuracy () const =0
	Get the accuracy of the altitude in meters. More...
virtual IEnums::AuthorizationStatus	GetAuthorization () const =0
	Get the current device authorization status. More...
Public Member Functions inherited from Murl::Input::IDevice
virtual const String &	GetName () const =0
	Get the device name. More...
virtual UInt32	GetId () const =0
	Get the unique device identifier. More...
virtual Bool	HasUpdate () const =0
	Check if the device has received new data since the last Update(). More...
virtual void	LogicUpdate ()=0
	Is executed in the logic thread context each logic tick.
virtual void	ConfigChanged (const IAppConfiguration *appConfig)=0
	Notification of changed configuration. More...

Member Function Documentation

GetLatitude()

virtual Double Murl::Input::ILocationDevice::GetLatitude ( ) const

pure virtual

Get the latitude in degrees relative to the equator.

Use GetHorizontalAccuracy() to check validity.

Returns

The latitude in degrees relative to the equator. Positive values indicate latitudes north of the equator and negative values indicate latitudes south of the equator.

GetLongitude()

virtual Double Murl::Input::ILocationDevice::GetLongitude ( ) const

pure virtual

Get the longitude in degrees relative to the zero meridian.

Use GetHorizontalAccuracy() to check validity.

Returns

The longitude in degrees relative to the zero meridian. Positive values extending east of the meridian and negative values extending west of the meridian.

GetAltitude()

virtual Double Murl::Input::ILocationDevice::GetAltitude ( ) const

pure virtual

Get the altitude above sea level in meters.

Use GetVerticalAccuracy() to check validity.

Returns

The altitude above sea level in meters. Positive values are above sea level and negative values are below sea level.

GetGeoLocation()

virtual Util::GeoLocation Murl::Input::ILocationDevice::GetGeoLocation ( ) const

pure virtual

Get the latitude, longitude and altitude geo location.

Returns

The geo location object.

GetVelocity()

virtual Double Murl::Input::ILocationDevice::GetVelocity ( ) const

pure virtual

Get the velocity over ground in meters per second.

A negative values indicates an invalid speed.

Returns

The velocity over ground in meters per second.

GetHorizontalAccuracy()

virtual Double Murl::Input::ILocationDevice::GetHorizontalAccuracy ( ) const

pure virtual

Get the radius of uncertainty for the location in meters.

A negative value indicates that the latitude and longitude are invalid.

Returns

The radius of uncertainty for the location in meters.

GetVerticalAccuracy()

virtual Double Murl::Input::ILocationDevice::GetVerticalAccuracy ( ) const

pure virtual

Get the accuracy of the altitude in meters.

A negative value indicates that the altitude value is invalid.

Returns

The accuracy of the altitude in meters.

GetAuthorization()

virtual IEnums::AuthorizationStatus Murl::Input::ILocationDevice::GetAuthorization ( ) const

pure virtual

Get the current device authorization status.

Returns

The current authorization status.

---

The documentation for this interface was generated from the following file:

• murl_input_i_location_device.h