NSFCompositeState Class Reference

Represents a state that may contain one or more orthogonal regions. More...

Inheritance diagram for NSFCompositeState:

Public Member Functions
	NSFCompositeState (NSFString name, NSFRegion parentRegion, NSFVoidAction< NSFStateMachineContext > entryAction, NSFVoidAction< NSFStateMachineContext > exitAction)
	Creates a composite state. More...
	NSFCompositeState (NSFString name, NSFCompositeState parentState, NSFVoidAction< NSFStateMachineContext > entryAction, NSFVoidAction< NSFStateMachineContext > exitAction)
	Creates a composite state. More...
override bool	isInState (NSFState state)
	Indicates if the specified state is active, i.e. is "in" the specified state. More...
override bool	isInState (NSFString stateName)
	Indicates if the specified state is active, i.e. is "in" the specified state. More...
Public Member Functions inherited from NSFState
	NSFState (NSFString name, NSFRegion parentRegion, NSFVoidAction< NSFStateMachineContext > entryAction, NSFVoidAction< NSFStateMachineContext > exitAction)
	Creates a state. More...
	NSFState (NSFString name, NSFCompositeState parentState, NSFVoidAction< NSFStateMachineContext > entryAction, NSFVoidAction< NSFStateMachineContext > exitAction)
	Creates a state. More...
bool	isActive ()
	Indicates if the state is currently active. More...
Public Member Functions inherited from NSFTaggedObject
	NSFTaggedObject (NSFString name)
	Creates an object with a unique id and a name. More...
Public Member Functions inherited from NSFUniquelyNumberedObject
	NSFUniquelyNumberedObject ()
	Creates a uniquely numbered object. More...
bool	isSameObject (NSFUniquelyNumberedObject other)
	Checks if this object is the same as another object. More...

Additional Inherited Members
Static Public Member Functions inherited from NSFUniquelyNumberedObject
static NSFId	getNextUniqueId ()
	Gets the next unique id. More...
Public Attributes inherited from NSFState
NSFVoidActions < NSFStateMachineContext >	EntryActions = new NSFVoidActions<NSFStateMachineContext>()
	Actions to be executed whenever the state is entered. More...
NSFVoidActions < NSFStateMachineContext >	ExitActions = new NSFVoidActions<NSFStateMachineContext>()
	Actions to be executed whenever the state is exited. More...
Properties inherited from NSFState
bool	LogEntry [get, set]
	Gets or sets the flag indicating if trace logging is enabled or disabled for the state. More...
virtual NSFStateMachine	TopStateMachine [get]
	Gets the top state machine encompassing the state. More...
Properties inherited from NSFTaggedObject
NSFString	Name [get, set]
Properties inherited from NSFUniquelyNumberedObject
NSFId	UniqueId [get]
	Gets or sets the unique id of the object. More...
Properties inherited from INSFNamedObject
NSFString	Name [get]
	Gets the name of the object. More...

Detailed Description

Represents a state that may contain one or more orthogonal regions.

NSFCompositeState is the most commonly used state type. It affords the ability to nest regions and substates, making it flexible for extension. There is minimal performance penalty for this capability, so this type should be preferred over the basic NSFState.

Constructor & Destructor Documentation

NSFCompositeState	(	NSFString	name,
		NSFRegion	parentRegion,
		NSFVoidAction< NSFStateMachineContext >	entryAction,
		NSFVoidAction< NSFStateMachineContext >	exitAction
	)

Creates a composite state.

Parameters

name	The name of the composite state.
parentRegion	The parent region of the composite state.
entryAction	The actions to be performed upon entry to the composite state.
exitAction	The actions to be performed upon exit of the composite state.

NSFCompositeState	(	NSFString	name,
		NSFCompositeState	parentState,
		NSFVoidAction< NSFStateMachineContext >	entryAction,
		NSFVoidAction< NSFStateMachineContext >	exitAction
	)

Creates a composite state.

Parameters

name	The name of the composite state.
parentState	The parent state of the composite state.
entryAction	The actions to be performed upon entry to the composite state.
exitAction	The actions to be performed upon exit of the composite state.

Member Function Documentation

override bool isInState ( NSFState  state )

virtual

Indicates if the specified state is active, i.e. is "in" the specified state.

Parameters

state

State in question.

Returns

True if the specified state is active, otherwise false.

Reimplemented from NSFState.

override bool isInState ( NSFString  stateName )

virtual

Indicates if the specified state is active, i.e. is "in" the specified state.

Parameters

stateName

Name of state in question. Assumes unique names.

Returns

True if the specified state is active, otherwise false.

Reimplemented from NSFState.