mitkStateMachineTransition.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef SMTRANSITION_H_HEADER_INCLUDED
#define SMTRANSITION_H_HEADER_INCLUDED

#include "mitkCommon.h"
#include "mitkInteractionEvent.h"
#include "mitkStateMachineAction.h"
#include "mitkStateMachineCondition.h"
#include <itkLightObject.h>
#include <string>

#include "MitkCoreExports.h"

namespace mitk
{
  class StateMachineState;

  typedef std::vector<mitk::StateMachineAction::Pointer> ActionVectorType;
  typedef std::vector<StateMachineCondition> ConditionVectorType;
  typedef itk::SmartPointer<StateMachineState> SpStateMachineState;

  class MITKCORE_EXPORT StateMachineTransition : public itk::LightObject
  {
    friend class StateMachineFactory;
    friend class StateMachineContainer;

  public:
    mitkClassMacroItkParent(StateMachineTransition, itk::LightObject);
    mitkNewMacro3Param(Self, const std::string &, const std::string &, const std::string &);

    SpStateMachineState GetNextState() const;
    std::string GetNextStateName() const;
    bool operator==(const StateMachineTransition &transition) const;

    ActionVectorType GetActions() const;

    const ConditionVectorType &GetConditions() const;

    void SetNextState(const SpStateMachineState &nextState);

  protected:
    StateMachineTransition(const std::string &nextStateName,
                           const std::string &eventClass,
                           const std::string &eventVariant);
    ~StateMachineTransition() override;

    // Triggering Event
    std::string m_EventClass;
    std::string m_EventVariant;

  private:
    void AddAction(const StateMachineAction::Pointer &action);

    void AddCondition(const StateMachineCondition &condition);

    SpStateMachineState m_NextState;

    std::string m_NextStateName;

    InteractionEvent::Pointer m_TransitionEvent;

    std::vector<StateMachineAction::Pointer> m_Actions;

    ConditionVectorType m_Conditions;
  };

} // namespace mitk

#endif /* SMTRANSITION_H_HEADER_INCLUDED */