vtkKWStateMachine.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWStateMachine.h,v $

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkKWStateMachine_h
#define __vtkKWStateMachine_h

#include "vtkKWObject.h"

class vtkKWStateMachineState;
class vtkKWStateMachineTransition;
class vtkKWStateMachineInput;
class vtkKWStateMachineInternals;
class vtkKWStateMachineCluster;

class KWWidgets_EXPORT vtkKWStateMachine : public vtkKWObject
{
// @cond section_public
public:
  static vtkKWStateMachine* New();
  vtkTypeRevisionMacro(vtkKWStateMachine, vtkKWObject);
  void PrintSelf(ostream& os, vtkIndent indent);


  virtual int AddState(vtkKWStateMachineState *state);
  virtual int HasState(vtkKWStateMachineState *state);
  virtual int GetNumberOfStates();
  virtual vtkKWStateMachineState* GetNthState(int rank);


  virtual int AddInput(vtkKWStateMachineInput *input);
  virtual int HasInput(vtkKWStateMachineInput *input);
  virtual int GetNumberOfInputs();
  virtual vtkKWStateMachineInput* GetNthInput(int rank);


  virtual int AddTransition(vtkKWStateMachineTransition *transition);
  virtual int HasTransition(vtkKWStateMachineTransition *transition);
  virtual int GetNumberOfTransitions();
  virtual vtkKWStateMachineTransition* GetNthTransition(int rank);


  virtual vtkKWStateMachineTransition* CreateTransition(
    vtkKWStateMachineState *origin,
    vtkKWStateMachineInput *input,
    vtkKWStateMachineState *destination);


  virtual vtkKWStateMachineTransition* FindTransition(
    vtkKWStateMachineState *origin,
    vtkKWStateMachineInput *input);
  virtual vtkKWStateMachineTransition* FindTransition(
    vtkKWStateMachineState *origin,
    vtkKWStateMachineInput *input,
    vtkKWStateMachineState *destination);
  

  vtkGetObjectMacro(InitialState, vtkKWStateMachineState);
  virtual int SetInitialState(vtkKWStateMachineState*);

  virtual int IsRunning();


  vtkGetObjectMacro(CurrentState, vtkKWStateMachineState);
  vtkKWStateMachineState* GetPreviousState();

  virtual void PushInput(vtkKWStateMachineInput *input);

  virtual void ProcessInputs();


  virtual int GetNumberOfTransitionsInHistory();
  virtual vtkKWStateMachineTransition* GetNthTransitionInHistory(int rank);


  virtual int AddCluster(vtkKWStateMachineCluster *cluster);
  virtual int HasCluster(vtkKWStateMachineCluster *cluster);
  virtual int GetNumberOfClusters();
  virtual vtkKWStateMachineCluster* GetNthCluster(int rank);


  virtual void SetCurrentStateChangedCommand(
    vtkObject *object, const char *method);
  virtual void InvokeCurrentStateChangedCommand();
  virtual int HasCurrentStateChangedCommand();


  enum
  {
    CurrentStateChangedEvent = 10000
  };
  //ETX

// @endcond
// @cond section_protected
protected:
  vtkKWStateMachine();
  ~vtkKWStateMachine();

  vtkKWStateMachineState *InitialState;
  vtkKWStateMachineState *CurrentState;


  virtual void RemoveState(vtkKWStateMachineState *state);
  virtual void RemoveAllStates();


  virtual void RemoveInput(vtkKWStateMachineInput *input);
  virtual void RemoveAllInputs();


  virtual void RemoveTransition(vtkKWStateMachineTransition *transition);
  virtual void RemoveAllTransitions();


  virtual void RemoveCluster(vtkKWStateMachineCluster *cluster);
  virtual void RemoveAllClusters();

  // PIMPL Encapsulation for STL containers
  //BTX
  vtkKWStateMachineInternals *Internals;
  //ETX

  virtual void ProcessInput(vtkKWStateMachineInput *input);

  char *CurrentStateChangedCommand;

  virtual void PushTransitionToHistory(vtkKWStateMachineTransition*);

// @endcond
// @cond section_private
private:

  vtkKWStateMachine(const vtkKWStateMachine&); // Not implemented
  void operator=(const vtkKWStateMachine&); // Not implemented
};

#endif
// @endcond

---