vtkKWStateMachineState Class Reference

a state machine state. More...

#include <vtkKWStateMachineState.h>

Inheritance diagram for vtkKWStateMachineState:

[legend]

Collaboration diagram for vtkKWStateMachineState:

[legend]

List of all members.

Public Types
typedef vtkKWObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Enter ()
virtual void	Leave ()
Static Public Member Functions
static vtkKWStateMachineState *	New ()
static int	IsTypeOf (const char *type)
static vtkKWStateMachineState *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWStateMachineState ()
	~vtkKWStateMachineState ()
Protected Attributes
vtkIdType	Id
char *	Name
char *	Description
int	Accepting
char *	EnterCommand
char *	LeaveCommand

enum	{ EnterEvent = 10000, LeaveEvent }
virtual vtkIdType	GetId ()
virtual char *	GetName ()
virtual void	SetName (const char *)
virtual char *	GetDescription ()
virtual void	SetDescription (const char *)
virtual void	SetEnterCommand (vtkObject object, const char method)
virtual void	InvokeEnterCommand ()
virtual int	HasEnterCommand ()
virtual void	SetLeaveCommand (vtkObject object, const char method)
virtual void	InvokeLeaveCommand ()
virtual int	HasLeaveCommand ()
virtual void	AcceptingOn ()
virtual void	AcceptingOff ()
virtual int	GetAccepting ()
virtual void	SetAccepting (int)

Detailed Description

a state machine state.

This class is the basis for a state machine state. A state machine is defined by a set of states, a set of inputs and a transition matrix that defines for each pair of (state,input) what is the next state to assume.

Thanks:: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on the National Centers for Biomedical Computing can be obtained from http://nihroadmap.nih.gov/bioinformatics.

See also:: vtkKWStateMachine vtkKWStateMachineInput vtkKWStateMachineTransition

Definition at line 36 of file vtkKWStateMachineState.h.

Member Typedef Documentation

typedef vtkKWObject vtkKWStateMachineState::Superclass

Reimplemented from vtkKWObject.

Definition at line 41 of file vtkKWStateMachineState.h.

Member Enumeration Documentation

anonymous enum

Events. The EnterEvent should be fired when the state machine enters this state. The LeaveEvent should be fired when the state machine leaves this state. In both case, state machine (sub)classes should call the corresponding Enter() end Leave() methods most of the time, which will take care of triggering both the callbacks and firing the events. BTX

Enumerator:

EnterEvent
LeaveEvent

Definition at line 110 of file vtkKWStateMachineState.h.

Constructor & Destructor Documentation

vtkKWStateMachineState::vtkKWStateMachineState ( ) [protected]

vtkKWStateMachineState::~vtkKWStateMachineState ( ) [protected]

Member Function Documentation

static vtkKWStateMachineState* vtkKWStateMachineState::New ( ) [static]

Reimplemented from vtkKWObject.

virtual const char* vtkKWStateMachineState::GetClassName ( ) [virtual]

Reimplemented from vtkKWObject.

static int vtkKWStateMachineState::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkKWObject.

virtual int vtkKWStateMachineState::IsA ( const char * type ) [virtual]

Reimplemented from vtkKWObject.

static vtkKWStateMachineState* vtkKWStateMachineState::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkKWObject.

void vtkKWStateMachineState::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Reimplemented from vtkKWObject.

virtual vtkIdType vtkKWStateMachineState::GetId ( ) [virtual]

Get id.

virtual char* vtkKWStateMachineState::GetName ( ) [virtual]

Set/Get simple name.

virtual void vtkKWStateMachineState::SetName ( const char * ) [virtual]

Events. The EnterEvent should be fired when the state machine enters this state. The LeaveEvent should be fired when the state machine leaves this state. In both case, state machine (sub)classes should call the corresponding Enter() end Leave() methods most of the time, which will take care of triggering both the callbacks and firing the events. BTX

virtual char* vtkKWStateMachineState::GetDescription ( ) [virtual]

Set/Get longer description.

virtual void vtkKWStateMachineState::SetDescription ( const char * ) [virtual]

Events. The EnterEvent should be fired when the state machine enters this state. The LeaveEvent should be fired when the state machine leaves this state. In both case, state machine (sub)classes should call the corresponding Enter() end Leave() methods most of the time, which will take care of triggering both the callbacks and firing the events. BTX

virtual void vtkKWStateMachineState::Enter ( ) [virtual]

Enter the state. This method should be invoked by the state machine when it enters this state. It will take care of calling the corresponding callbacks (EnterCommand) and events (EnterEvent). Subclasses that override this method should make sure they call their superclass's Enter() method.

virtual void vtkKWStateMachineState::Leave ( ) [virtual]

Leave the state. This method should be invoked by the state machine when it leaves this state. It will take care of calling the corresponding callbacks (LeaveCommand) and events (LeaveEvent). Subclasses that override this method should make sure they call their superclass's Leave() method.

virtual void vtkKWStateMachineState::SetEnterCommand	(	vtkObject *	object,
		const char *	method
	)			`[virtual]`

Specifies a command to associate with this state. This command should be invoked by the state machine when it enters this state. State machine (sub)classes should call the Enter() method most of the time, which will take care of triggering this callback and firing the EnterEvent as well. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.

virtual void vtkKWStateMachineState::InvokeEnterCommand ( ) [virtual]

Events. The EnterEvent should be fired when the state machine enters this state. The LeaveEvent should be fired when the state machine leaves this state. In both case, state machine (sub)classes should call the corresponding Enter() end Leave() methods most of the time, which will take care of triggering both the callbacks and firing the events. BTX

virtual int vtkKWStateMachineState::HasEnterCommand ( ) [virtual]

Events. The EnterEvent should be fired when the state machine enters this state. The LeaveEvent should be fired when the state machine leaves this state. In both case, state machine (sub)classes should call the corresponding Enter() end Leave() methods most of the time, which will take care of triggering both the callbacks and firing the events. BTX

virtual void vtkKWStateMachineState::SetLeaveCommand	(	vtkObject *	object,
		const char *	method
	)			`[virtual]`

Specifies a command to associate with this state. This command should be invoked by the state machine when it leaves this state. State machine (sub)classes should call the Leave() method most of the time, which will take care of triggering this callback and firing the EnterEvent as well. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.

virtual void vtkKWStateMachineState::InvokeLeaveCommand ( ) [virtual]

Events. The EnterEvent should be fired when the state machine enters this state. The LeaveEvent should be fired when the state machine leaves this state. In both case, state machine (sub)classes should call the corresponding Enter() end Leave() methods most of the time, which will take care of triggering both the callbacks and firing the events. BTX

virtual int vtkKWStateMachineState::HasLeaveCommand ( ) [virtual]

Events. The EnterEvent should be fired when the state machine enters this state. The LeaveEvent should be fired when the state machine leaves this state. In both case, state machine (sub)classes should call the corresponding Enter() end Leave() methods most of the time, which will take care of triggering both the callbacks and firing the events. BTX

virtual void vtkKWStateMachineState::AcceptingOn ( ) [virtual]

Set/Get if the set is an accepting state. This is mainly used for display or IO purposes (see vtkKWStateMachineDOTWriter).

virtual void vtkKWStateMachineState::AcceptingOff ( ) [virtual]

Events. The EnterEvent should be fired when the state machine enters this state. The LeaveEvent should be fired when the state machine leaves this state. In both case, state machine (sub)classes should call the corresponding Enter() end Leave() methods most of the time, which will take care of triggering both the callbacks and firing the events. BTX

virtual int vtkKWStateMachineState::GetAccepting ( ) [virtual]

Events. The EnterEvent should be fired when the state machine enters this state. The LeaveEvent should be fired when the state machine leaves this state. In both case, state machine (sub)classes should call the corresponding Enter() end Leave() methods most of the time, which will take care of triggering both the callbacks and firing the events. BTX

virtual void vtkKWStateMachineState::SetAccepting ( int ) [virtual]

Events. The EnterEvent should be fired when the state machine enters this state. The LeaveEvent should be fired when the state machine leaves this state. In both case, state machine (sub)classes should call the corresponding Enter() end Leave() methods most of the time, which will take care of triggering both the callbacks and firing the events. BTX