mitkStateMachineState.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 SMSTATE_H_HEADER_INCLUDED_C19A8A5D
#define SMSTATE_H_HEADER_INCLUDED_C19A8A5D

#include "MitkCoreExports.h"
#include "mitkStateMachineTransition.h"
#include <itkLightObject.h>
#include <string>

namespace mitk
{
  class MITKCORE_EXPORT StateMachineState : public itk::LightObject
  {
  public:
    mitkClassMacroItkParent(StateMachineState, itk::LightObject);
    mitkNewMacro2Param(Self, const std::string &, const std::string &);

    typedef std::vector<mitk::StateMachineState::Pointer> StateMap;
    typedef std::vector<StateMachineTransition::Pointer> TransitionVector;

    bool AddTransition(StateMachineTransition::Pointer transition);

    DEPRECATED(StateMachineTransition::Pointer GetTransition(const std::string &eventClass,
                                                             const std::string &eventVariant));

    TransitionVector GetTransitionList(const std::string &eventClass, const std::string &eventVariant);

    std::string GetName() const;

    std::string GetMode() const;

    bool ConnectTransitions(StateMap *allStates);

  protected:
    StateMachineState(const std::string &name, const std::string &stateMode);
    ~StateMachineState() override;

  private:
    std::string m_Name;
    std::string m_StateMode;

    TransitionVector m_Transitions;
  };
} // namespace mitk
#endif /* SMSTATE_H_HEADER_INCLUDED_C19A8A5D */