threadbase.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright 2016-2017 Karolin Stange, Christoph Wick, and Haye Hinrichsen
 *
 * This file is part of JustIntonation.
 *
 * JustIntonation is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * JustIntonation is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along 
 * with JustIntonation. If not, see http://www.gnu.org/licenses/.
 *****************************************************************************/

//=============================================================================
//         Thread base - a universal base class for threaded modules
//=============================================================================

#ifndef THREADBASE_H
#define THREADBASE_H

#include <QObject>

#include "log.h"
#include "threadworker.h"
#include "shared.h"


class ThreadBase : public QObject, public Log
{
    Q_OBJECT
public:
    friend class ThreadWorker;

    ThreadBase();
    ~ThreadBase();

    virtual bool init() { return true; }  
    virtual bool exit() { return true; }  

    virtual bool start();
    virtual bool stop();

    virtual void suspend();
    virtual void resume();
    bool isActive() const;
    void setVerbosity (int verbosity);
    int getVerbosity() { return mThreadWorker.getVerbosity(); } 
    QString getThreadName() const;

protected:
    virtual void initiallyCalledWorker() {}
    virtual void finallyCalledWorker() {}
    virtual void periodicallyCalledWorker() {}

    void setPriority (const QThread::Priority p);
    void setTimerInterval (const int msec, const int firstMsec=0);
    void setThreadName (const QString name);
    bool isInterruptionRequested() const;

private slots:
    virtual void timeout();
private:
    ThreadWorker mThreadWorker;         
    bool mSuspended;                    
};

#endif // THREADBASE_H