GUICommand.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 GUICOMMAND__H_
#define GUICOMMAND__H_
 
#include "eC_Types.h"
#include "GUIStreamableObject.h"
#include "eC_TList_doubleLinked.h"
#include "RefCounted.h"
#include "SharedPtr.h"
 
class CGUICommand;
typedef NSmartPtr::SharedPtr<CGUICommand> CGUICommandPtr;
 
bool operator==(const CGUICommandPtr& a, const CGUICommandPtr& b);
bool operator>(const CGUICommandPtr& a, const CGUICommandPtr& b);
 
typedef eC_TListDoubleLinked<CGUICommandPtr> CommandPtrList;
 
 
class CGUICommand :
    public CGUIStreamableObject,
    public NSmartPtr::RefCounted
{
    friend class CGUICommandHandler; 
public:
    void AddAdditionalCmd(CGUICommandPtr pkCmd, eC_Bool bOneTime = false);
 
    void RemoveAdditionalCmd(CGUICommandPtr pkCmd);
 
    void RemoveAllAdditionalCmds();
 
    inline eC_Bool IsFinished() const { return m_bIsFinished;}
 
    inline eC_UInt GetTimeUntilNextExecution() const { return m_uiTimeUntilNextExecution; };
 
    void SetTimeUntilNextExecution(eC_UInt uiTime);
 
    void SetPriority(eC_UInt uiPriority);
 
    inline eC_UInt GetPriority() const {return m_uiPriority;}
 
    eC_UInt GetNumberOfAdditionalCmds() const {return m_kAdditionalCmds.GetQuantity();}
 
    CGUICommandPtr GetAdditionalCmd(const eC_UInt& uiIndex) const;
 
 
#if defined GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID=false);
#endif
 
#if defined GUILIANI_STREAM_GUI
    virtual void ReadFromStream();
#endif
 
#if defined(GUILIANI_STREAM_GUI) || defined(GUILIANI_WRITE_GUI)
    static const eC_Char XMLTAG_COMMANDCLASSID[];
 
    static const eC_Char XMLTAG_ADDITIONALCMDCOUNT[];
 
    static const eC_Char XMLTAG_REMOVE_AFTER_EXECUTION[];
#endif
 
protected:
    inline void SetToBeFinished(eC_Bool bIsFinished){m_bIsFinished = bIsFinished;}
 
    CGUICommand(const eC_UInt uiPriority = 0, const eC_UInt uiTimeUntilFirstExecution = 0, const eC_Bool bFinished = true);
 
    virtual void Do() = 0;
 
    virtual ~CGUICommand() {}
private:
    void ExecuteAdditionalCmds();
 
    eC_Bool     m_bIsFinished;
 
    eC_UInt     m_uiTimeUntilNextExecution;
 
    eC_UInt     m_uiPriority;
 
    struct AdditionalCmd_t
    {
        AdditionalCmd_t()
            : m_pkCmd(NULL), m_bExecOneTime(false) {}
        AdditionalCmd_t(CGUICommandPtr pkCmd, eC_Bool bExecOneTime)
            : m_pkCmd(pkCmd), m_bExecOneTime(bExecOneTime) {}
        CGUICommandPtr m_pkCmd;
        eC_Bool m_bExecOneTime;
    };
 
    typedef eC_TListDoubleLinked<AdditionalCmd_t> AdditionalCmdList;
    AdditionalCmdList m_kAdditionalCmds;
};
#endif