YiAbstractSignalTransition.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_ABSTRACT_SIGNAL_TRANSITION_H_
#define _YI_ABSTRACT_SIGNAL_TRANSITION_H_

#include "deprecated/YiTransition.h"

namespace yi
{
namespace deprecated
{
class CYISignalEventGenerator;

/*
 *  CYISignalTransition: transitions based on signals
 *      To check the signal parameters, subclass the correct SignalTransition class,
 *      and cast the event using a similar line:
 *       CYIStateMachineSignalEvent<YI_SLOT_PARAM1> *pEvent = (CYIStateMachineSignalEvent<YI_SLOT_PARAM1> *)e;
 *      after verifying that the superclass' TestEvent returns true.
 */
class CYIAbstractSignalTransition : public CYITransition
{
public:
    CYIAbstractSignalTransition(CYISignalBase *pSignal,
                                CYICompoundState *source,
                                CYIAbstractState *target = 0);
    virtual ~CYIAbstractSignalTransition();

    virtual CYISignalBase *GetSignal() = 0;

protected:
    virtual bool TestEvent(CYIEvent *) override;

    virtual void Connect() = 0;

    void SetSource(CYICompoundState *source);

protected:
    CYISignalEventGenerator *m_pGenerator;

    friend class CYISignalTransitionPriv;
};

} //namespace deprecated

} //namespace yi

#endif /* _YI_ABSTRACT_SIGNAL_TRANSITION_H_ */