SENSGps Class Reference

#include <SENSGps.h>

Inheritance diagram for SENSGps:

Classes
struct	Location

Public Member Functions
virtual	~SENSGps ()
virtual bool	start ()=0
virtual void	stop ()=0
Location	getLocation () const
bool	isRunning ()
bool	permissionGranted () const
void	registerListener (SENSGpsListener *listener)
void	unregisterListener (SENSGpsListener *listener)
void	registerPermissionListener (std::function< void(void)> listener)
void	updatePermission (bool granted)

Protected Member Functions
void	setLocation (SENSGps::Location location)
void	informPermissionListeners ()

Protected Attributes
bool	_running = false
std::atomic_bool	_permissionGranted {false}

Private Attributes
SENSTimePt	_timePt
Location	_location
std::mutex	_llaMutex
std::vector< SENSGpsListener * >	_listeners
std::mutex	_listenerMutex
std::mutex	_permissionListenerMutex
std::vector< std::function< void(void)> >	_permissionListeners

Detailed Description

Definition at line 14 of file SENSGps.h.

Constructor & Destructor Documentation

~SENSGps()

virtual SENSGps::~SENSGps ( )

inlinevirtual

Definition at line 25 of file SENSGps.h.

{}

Member Function Documentation

getLocation()

SENSGps::Location SENSGps::getLocation

(

)

const

Definition at line 5 of file SENSGps.cpp.

{
    const std::lock_guard<std::mutex> lock(_llaMutex);
    return _location;
}

informPermissionListeners()

void SENSGps::informPermissionListeners ( )

protected

Definition at line 64 of file SENSGps.cpp.

{
    std::lock_guard<std::mutex> lock(_permissionListenerMutex);
    for (auto listener : _permissionListeners)
        listener();
}

isRunning()

bool SENSGps::isRunning ( )

inline

Definition at line 32 of file SENSGps.h.

{ return _running; }

permissionGranted()

bool SENSGps::permissionGranted

(

)

const

Definition at line 49 of file SENSGps.cpp.

{
    return _permissionGranted;
}

registerListener()

void SENSGps::registerListener

(

SENSGpsListener *

listener

)

Definition at line 29 of file SENSGps.cpp.

{
    std::lock_guard<std::mutex> lock(_listenerMutex);
    if (std::find(_listeners.begin(), _listeners.end(), listener) == _listeners.end())
        _listeners.push_back(listener);
}

registerPermissionListener()

void SENSGps::registerPermissionListener

(

std::function< void(void)>

listener

)

Definition at line 54 of file SENSGps.cpp.

{
    {
        std::lock_guard<std::mutex> lock(_permissionListenerMutex);
        _permissionListeners.push_back(listener);
    }
    //inform about initial state
    informPermissionListeners();
}

setLocation()

void SENSGps::setLocation ( SENSGps::Location  location )

protected

Definition at line 11 of file SENSGps.cpp.

{
    //estimate time before running into lock
    SENSTimePt timePt = SENSClock::now();
 
    {
        const std::lock_guard<std::mutex> lock(_llaMutex);
        _location = location;
        _timePt   = timePt;
    }
 
    {
        std::lock_guard<std::mutex> lock(_listenerMutex);
        for (SENSGpsListener* l : _listeners)
            l->onGps(timePt, location);
    }
}

start()

virtual bool SENSGps::start ( )

pure virtual

Implemented in SENSSimulatedGps, SENSDummyGps, SENSiOSGps, and SENSAndroidGps.

stop()

virtual void SENSGps::stop ( )

pure virtual

Implemented in SENSSimulatedGps, SENSDummyGps, SENSiOSGps, and SENSAndroidGps.

unregisterListener()

void SENSGps::unregisterListener

(

SENSGpsListener *

listener

)

Definition at line 36 of file SENSGps.cpp.

{
    std::lock_guard<std::mutex> lock(_listenerMutex);
    for (auto it = _listeners.begin(); it != _listeners.end(); ++it)
    {
        if (*it == listener)
        {
            _listeners.erase(it);
            break;
        }
    }
}

updatePermission()

void SENSGps::updatePermission

(

bool

granted

)

Definition at line 71 of file SENSGps.cpp.

{
    _permissionGranted = granted;
    informPermissionListeners();
}

Member Data Documentation

_listenerMutex

std::mutex SENSGps::_listenerMutex

private

Definition at line 55 of file SENSGps.h.

_listeners

std::vector<SENSGpsListener*> SENSGps::_listeners

private

Definition at line 54 of file SENSGps.h.

_llaMutex

std::mutex SENSGps::_llaMutex

mutableprivate

Definition at line 52 of file SENSGps.h.

_location

Location SENSGps::_location

private

Definition at line 51 of file SENSGps.h.

_permissionGranted

std::atomic_bool SENSGps::_permissionGranted {false}

protected

Definition at line 47 of file SENSGps.h.

_permissionListenerMutex

std::mutex SENSGps::_permissionListenerMutex

mutableprivate

Definition at line 57 of file SENSGps.h.

_permissionListeners

std::vector<std::function<void(void)> > SENSGps::_permissionListeners

private

Definition at line 58 of file SENSGps.h.

_running

bool SENSGps::_running = false

protected

Definition at line 46 of file SENSGps.h.

_timePt

SENSTimePt SENSGps::_timePt

private

Definition at line 50 of file SENSGps.h.

---

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

• SENSGps.h
• SENSGps.cpp