SENSRecorderDataHandler< T > Class Template Reference

#include <SENSRecorderDataHandler.h>

Public Member Functions
	SENSRecorderDataHandler (const std::string &name)
virtual	~SENSRecorderDataHandler ()
void	start (const std::string &outputDir)
	start the store thread More...
void	stop ()
	stop the store thread and clear values in queue More...
void	add (T &&item)
	add new value to store queue More...
bool	getErrorMsg (std::string &msg)
	get error msg (valid if function returns true) More...

Protected Member Functions
virtual void	writeOnThreadStart ()
	called in thread store routine when thread starts More...
virtual void	writeHeaderToFile (ofstream &file)
	called in thread store routine when file could be opened More...
virtual void	writeLineToFile (ofstream &file, const T &data)=0
	called in thread store routine for every new line More...
virtual void	writeOnThreadFinish ()
	called in thread store routine when thread finished More...

Protected Attributes
std::string	_outputDir
	output directory More...

Private Member Functions
void	store ()

Private Attributes
std::deque< T >	_queue
std::mutex	_mutex
std::condition_variable	_condVar
std::thread	_thread
bool	_stop = false
std::string	_name
std::mutex	_msgMutex
std::string	_errorMsg

Detailed Description

template<typename T>
class SENSRecorderDataHandler< T >

SENSRecorderDataHandler This class is meant to be used exclusively by the SENSRecorder class. The SENSRecorder listens to sensors and informs SENSRecorderDataHandler backends about new data. The SENSRecorderDataHandler stores values to file.

Definition at line 32 of file SENSRecorderDataHandler.h.

Constructor & Destructor Documentation

SENSRecorderDataHandler()

template<typename T >

SENSRecorderDataHandler< T >::SENSRecorderDataHandler

(

const std::string &

name

)

Definition at line 5 of file SENSRecorderDataHandler.cpp.

  : _name(name)
{
}

~SENSRecorderDataHandler()

template<typename T >

SENSRecorderDataHandler< T >::~SENSRecorderDataHandler

virtual

Definition at line 11 of file SENSRecorderDataHandler.cpp.

{
    stop();
}

Member Function Documentation

add()

template<typename T >

void SENSRecorderDataHandler< T >::add

(

T &&

item

)

add new value to store queue

Definition at line 101 of file SENSRecorderDataHandler.cpp.

{
    std::unique_lock<std::mutex> lock(_mutex);
    _queue.push_back(std::move(item));
    lock.unlock();
    _condVar.notify_one();
}

getErrorMsg()

template<typename T >

bool SENSRecorderDataHandler< T >::getErrorMsg

(

std::string &

msg

)

get error msg (valid if function returns true)

Definition at line 110 of file SENSRecorderDataHandler.cpp.

{
    std::lock_guard<std::mutex> lock(_msgMutex);
    if (_errorMsg.empty())
        return false;
    else
    {
        msg = _errorMsg;
        return true;
    }
}

start()

template<typename T >

void SENSRecorderDataHandler< T >::start

(

const std::string &

outputDir

)

start the store thread

Definition at line 17 of file SENSRecorderDataHandler.cpp.

{
    stop();
    //start writer thread
    _errorMsg.clear();
    _outputDir = outputDir;
    _thread    = std::thread(&SENSRecorderDataHandler::store, this);
}

stop()

template<typename T >

void SENSRecorderDataHandler< T >::stop

stop the store thread and clear values in queue

Definition at line 27 of file SENSRecorderDataHandler.cpp.

{
    std::unique_lock<std::mutex> lock(_mutex);
    _stop = true;
    lock.unlock();
    _condVar.notify_one();
 
    if (_thread.joinable())
        _thread.join();
 
    lock.lock();
    _queue.clear();
    _stop = false;
}

store()

template<typename T >

void SENSRecorderDataHandler< T >::store

private

Definition at line 43 of file SENSRecorderDataHandler.cpp.

{
    SENS_DEBUG("SENSRecorderDataHandler: starting store");
    writeOnThreadStart();
    //open file
    std::string fileName = _outputDir + _name + ".txt";
    ofstream    file;
    file.open(fileName);
    if (file.is_open())
    {
        writeHeaderToFile(file);
        while (true)
        {
            std::unique_lock<std::mutex> lock(_mutex);
 
            _condVar.wait(lock, [&]
                          { return (_stop == true || _queue.size() != 0); });
            if (_stop)
                break;
 
            SENS_DEBUG("SENSRecorderDataHandler: queue size: %d", _queue.size());
 
            std::deque<T> localQueue;
            while (_queue.size())
            {
                localQueue.push_back(_queue.front());
                _queue.pop_front();
            }
 
            lock.unlock();
 
            //write data
            if (localQueue.size())
            {
                writeLineToFile(file, localQueue.front());
                localQueue.pop_front();
            }
 
            if (localQueue.size())
            {
                std::stringstream ss;
                ss << "Data writing is too slow. Skipping " << localQueue.size() << " values from queue!";
                SENS_WARN("SENSRecorderDataHandler store: %s", ss.str().c_str());
                //if buffer is running full, warn and skip values
                {
                    std::lock_guard<std::mutex> lock(_msgMutex);
                    _errorMsg = ss.str();
                }
                localQueue.clear();
            }
        }
    }
    writeOnThreadFinish();
    //close file
    file.close();
}

writeHeaderToFile()

template<typename T >

virtual void SENSRecorderDataHandler< T >::writeHeaderToFile ( ofstream &  file )

inlineprotectedvirtual

called in thread store routine when file could be opened

Definition at line 51 of file SENSRecorderDataHandler.h.

{}

writeLineToFile()

template<typename T >

virtual void SENSRecorderDataHandler< T >::writeLineToFile ( ofstream &  file, const T &  data  )

protectedpure virtual

called in thread store routine for every new line

Implemented in SENSOrientationRecorderDataHandler, SENSGpsRecorderDataHandler, and SENSCameraRecorderDataHandler.

writeOnThreadFinish()

template<typename T >

virtual void SENSRecorderDataHandler< T >::writeOnThreadFinish ( )

inlineprotectedvirtual

called in thread store routine when thread finished

Reimplemented in SENSCameraRecorderDataHandler.

Definition at line 55 of file SENSRecorderDataHandler.h.

{}

writeOnThreadStart()

template<typename T >

virtual void SENSRecorderDataHandler< T >::writeOnThreadStart ( )

inlineprotectedvirtual

called in thread store routine when thread starts

Reimplemented in SENSCameraRecorderDataHandler.

Definition at line 49 of file SENSRecorderDataHandler.h.

{}

Member Data Documentation

_condVar

template<typename T >

std::condition_variable SENSRecorderDataHandler< T >::_condVar

private

Definition at line 68 of file SENSRecorderDataHandler.h.

_errorMsg

template<typename T >

std::string SENSRecorderDataHandler< T >::_errorMsg

private

Definition at line 77 of file SENSRecorderDataHandler.h.

_msgMutex

template<typename T >

std::mutex SENSRecorderDataHandler< T >::_msgMutex

private

Definition at line 76 of file SENSRecorderDataHandler.h.

_mutex

template<typename T >

std::mutex SENSRecorderDataHandler< T >::_mutex

private

Definition at line 67 of file SENSRecorderDataHandler.h.

_name

template<typename T >

std::string SENSRecorderDataHandler< T >::_name

private

Definition at line 74 of file SENSRecorderDataHandler.h.

_outputDir

template<typename T >

std::string SENSRecorderDataHandler< T >::_outputDir

protected

output directory

Definition at line 58 of file SENSRecorderDataHandler.h.

_queue

template<typename T >

std::deque<T> SENSRecorderDataHandler< T >::_queue

private

Definition at line 65 of file SENSRecorderDataHandler.h.

_stop

template<typename T >

bool SENSRecorderDataHandler< T >::_stop = false

private

Definition at line 72 of file SENSRecorderDataHandler.h.

_thread

template<typename T >

std::thread SENSRecorderDataHandler< T >::_thread

private

Definition at line 70 of file SENSRecorderDataHandler.h.

---

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

• SENSRecorderDataHandler.h
• SENSRecorderDataHandler.cpp