SENSOrientation Class Reference

#include <SENSOrientation.h>

Inheritance diagram for SENSOrientation:

Classes
struct	Quat

Public Member Functions
virtual	~SENSOrientation ()
virtual bool	start ()=0
virtual void	stop ()=0
Quat	getOrientation () const
bool	isRunning ()
void	registerListener (SENSOrientationListener *listener)
void	unregisterListener (SENSOrientationListener *listener)

Protected Member Functions
void	setOrientation (Quat orientation)

Protected Attributes
bool	_running = false

Private Attributes
SENSTimePt	_timePt
Quat	_orientation
std::mutex	_orientationMutex
std::vector< SENSOrientationListener * >	_listeners
std::mutex	_listenerMutex

Detailed Description

Definition at line 52 of file SENSOrientation.h.

Constructor & Destructor Documentation

~SENSOrientation()

virtual SENSOrientation::~SENSOrientation ( )

inlinevirtual

Definition at line 71 of file SENSOrientation.h.

{}

Member Function Documentation

getOrientation()

SENSOrientation::Quat SENSOrientation::getOrientation

(

)

const

Definition at line 7 of file SENSOrientation.cpp.

{
    const std::lock_guard<std::mutex> lock(_orientationMutex);
    return _orientation;
}

isRunning()

bool SENSOrientation::isRunning ( )

inline

Definition at line 78 of file SENSOrientation.h.

{ return _running; }

registerListener()

void SENSOrientation::registerListener

(

SENSOrientationListener *

listener

)

Definition at line 31 of file SENSOrientation.cpp.

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

setOrientation()

void SENSOrientation::setOrientation ( SENSOrientation::Quat  orientation )

protected

Definition at line 13 of file SENSOrientation.cpp.

{
    //estimate time before running into lock
    SENSTimePt timePt = SENSClock::now();
 
    {
        const std::lock_guard<std::mutex> lock(_orientationMutex);
        _orientation = orientation;
        _timePt      = timePt;
    }
 
    {
        std::lock_guard<std::mutex> lock(_listenerMutex); //to secure new listeners from registerListener, should not be a performance issue
        for (SENSOrientationListener* l : _listeners)
            l->onOrientation(timePt, orientation);
    }
}

start()

virtual bool SENSOrientation::start ( )

pure virtual

Implemented in SENSSimulatedOrientation, SENSDummyOrientation, SENSiOSOrientation, and SENSAndroidOrientation.

stop()

virtual void SENSOrientation::stop ( )

pure virtual

Implemented in SENSSimulatedOrientation, SENSDummyOrientation, SENSiOSOrientation, and SENSAndroidOrientation.

unregisterListener()

void SENSOrientation::unregisterListener

(

SENSOrientationListener *

listener

)

Definition at line 37 of file SENSOrientation.cpp.

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

Member Data Documentation

_listenerMutex

std::mutex SENSOrientation::_listenerMutex

private

Definition at line 94 of file SENSOrientation.h.

_listeners

std::vector<SENSOrientationListener*> SENSOrientation::_listeners

private

Definition at line 93 of file SENSOrientation.h.

_orientation

Quat SENSOrientation::_orientation

private

Definition at line 90 of file SENSOrientation.h.

_orientationMutex

std::mutex SENSOrientation::_orientationMutex

mutableprivate

Definition at line 91 of file SENSOrientation.h.

_running

bool SENSOrientation::_running = false

protected

Definition at line 86 of file SENSOrientation.h.

_timePt

SENSTimePt SENSOrientation::_timePt

private

Definition at line 89 of file SENSOrientation.h.

---

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

• SENSOrientation.h
• SENSOrientation.cpp