State.h

Go to the documentation of this file.

#ifndef _ESTATE_H_
#define _ESTATE_H_

#include <string>
#include <qobject.h>
#include <stdint.h>

#include "StateDefines.h"

class StateManager;
class StorageList;

class State : public QObject
{
    Q_OBJECT
public:
    virtual ~State();

    virtual State *Clone( StorageList &inputStream ) = 0;

    QString GetStateName() const;

    virtual void OnEnter();
    virtual void OnEnter( const int32_t stateRequestCode );

    virtual void OnResume();
    virtual void OnResume( const int32_t stateRequestCode, const int32_t stateResultCode, StorageList &storageList );

    virtual void OnLeave();

    virtual void OnTimeOut();

    virtual void OnSecondTick();

    virtual void OnMinuteTick();

protected:
    State( const QString &stateName, StateManager *context );

    virtual void TimerStart( unsigned long timeout );

    virtual void TimerStop();
    
    virtual bool IsTimerActive();

    virtual StateDefines::StateAlgorithmResult ChangeState( const QString &stateName, StorageList &storageList, const StateDefines::ChangeStateFlag changeStateFlag = StateDefines::ChangeStateFlagUndefined );

    virtual StateDefines::StateAlgorithmResult ChangeStateForResult( const QString &stateName, StorageList &storageList, const int32_t stateRequestCode );

    virtual StateDefines::StateAlgorithmResult FinishState( const StateDefines::FinishStateFlag finishStateFlag = StateDefines::FinishStateFlagUndefined );

    virtual StateDefines::StateAlgorithmResult FinishStateWithResult( const int32_t stateResultCode, StorageList &storageList );

    virtual bool IsChangeStateForResultMapEmpty();

    StateManager *GetStateManager();

    virtual void FillStorageList( const StorageList &storageList );

    virtual StorageList &GetStorageList();

private slots:
    // timer slots
    void TimeOut();

private:

    class DataClass;
    DataClass *d;

};

#endif // _ESTATE_H_