GUIThread.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef _GUITHREAD__H_
#define _GUITHREAD__H_
 
#include "eC_Types.h"
 
enum ThreadPriority_t
{
    GUITHREAD_PRIORITY_IDLE,
    GUITHREAD_PRIORITY_ABOVE_IDLE,
    GUITHREAD_PRIORITY_BELOW_LOW,
    GUITHREAD_PRIORITY_LOW,
    GUITHREAD_PRIORITY_ABOVE_LOW,
    GUITHREAD_PRIORITY_BELOW_NORM,
    GUITHREAD_PRIORITY_NORM,
    GUITHREAD_PRIORITY_ABOVE_NORM,
    GUITHREAD_PRIORITY_BELOW_HIGH,
    GUITHREAD_PRIORITY_HIGH,
    GUITHREAD_PRIORITY_ABOVE_HIGH,
    GUITHREAD_PRIORITY_BELOW_CRITICAL,
    GUITHREAD_PRIORITY_CRITICAL,
    GUITHREAD_PRIORITY_ABOVE_CRITICAL,
    GUITHREAD_PRIORITY_BELOW_REALTIME,
    GUITHREAD_PRIORITY_REALTIME,
    GUITHREAD_PRIORITY_NOT_SET
};
 
 
class CGUIThread
{
public:
    inline void* GetArg() const {return m_pArg;}
 
    inline void SetArg(void* pArg) {m_pArg = pArg;}
 
    inline eC_Bool IsRunning() const {return m_bRunning;}
 
    inline eC_Bool IsShutdownCompleted() const {return m_bShutdownFinishedFlag;}
 
    inline void* GetThreadId() const {return m_pThreadId;}
 
    eC_Int Start(void *pArg);
 
    void Terminate();
 
    inline void InitShutdown() {m_bRunning = false;}
 
    void WaitForShutdown();
 
    void SetPriority(const ThreadPriority_t& ePriority);
 
    ThreadPriority_t GetPriority();
 
protected:
    CGUIThread(const eC_UInt& uiStackSize);
 
    virtual ~CGUIThread();
 
    virtual void Setup() {}
 
    virtual void Execute(void *pArg) =0;
 
    virtual void Cleanup() {}
 
    eC_Int MapPriority(const ThreadPriority_t& ePriority);
 
    ThreadPriority_t MapPriority(const eC_Int& iPriority);
 
    eC_UInt m_uiStackSize;          
    void* m_pThreadId;           
    void *m_pArg;                   
    volatile eC_Bool m_bRunning;    
 
private:
    CGUIThread();
 
    /* Private copy-constructor. Should not be used.
    *  Dummy declaration with no implementation, just to hide the function.
       @param kSource Source object.
    */
    CGUIThread(const CGUIThread& kSource);
 
    /* Private operator= method. Should not be used.
    *  Dummy declaration with no implementation, just to hide the function.
       @param kSource Source object.
       @return this object.
    */
    CGUIThread& operator=(const CGUIThread& kSource);
 
    void Run();
 
    static void* EntryPoint(void *pThis);
 
    void Init();
 
    void DeInit();
 
private:
    void *m_pHandle;
 
    eC_Bool m_bShutdownFinishedFlag;
};
#endif