North State Framework in C#  V3.0.0
An object-oriented framework for implementing UML state machines.
Public Member Functions | List of all members
NSFShallowHistory Class Reference

Represents a shallow history pseudo-state. More...

Inheritance diagram for NSFShallowHistory:
NSFState NSFTaggedObject NSFUniquelyNumberedObject INSFNamedObject

Public Member Functions

 NSFShallowHistory (NSFString name, NSFRegion parentRegion)
 Creates a shallow history pseudo-state. More...
 
 NSFShallowHistory (NSFString name, NSFCompositeState parentState)
 Creates a shallow history pseudo-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...
 
virtual bool isInState (NSFState state)
 Indicates if the specified state is active, i.e. is "in" the specified state. More...
 
virtual bool isInState (NSFString stateName)
 Indicates if the specified state is active, i.e. is "in" the specified state. 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 shallow history pseudo-state.

NSFShallowHistory is a transient state. Once entered, it forces entry into the last active substate in the region.

Constructor & Destructor Documentation

NSFShallowHistory ( NSFString  name,
NSFRegion  parentRegion 
)

Creates a shallow history pseudo-state.

Parameters
nameThe name of the shallow history pseudo-state.
parentRegionThe parent region of the shallow history pseudo-state.
NSFShallowHistory ( NSFString  name,
NSFCompositeState  parentState 
)

Creates a shallow history pseudo-state.

Parameters
nameThe name of the shallow history pseudo-state.
parentStateThe parent state of the shallow history pseudo-state.



Copyright 2004-2014, North State Software, LLC. All rights reserved.