|
North State Framework in C#
V3.0.0
An object-oriented framework for implementing UML state machines.
|
Classes | |
| interface | INSFEventHandler |
| Represents the interface for classes that can queue and handle events. More... | |
| interface | INSFIdObject |
| Represents an interface for objects containing an id number. More... | |
| interface | INSFNamedObject |
| Represents an interface for objects containing a name. More... | |
| class | NSFBoolGuards< ContextType > |
| Represents a list of guards. More... | |
| class | NSFChoiceState |
| Represents a choice pseudo-state. More... | |
| class | NSFCompositeState |
| Represents a state that may contain one or more orthogonal regions. More... | |
| class | NSFContext |
| Represents a general purpose action or guard context. More... | |
| class | NSFDataEvent< DataType > |
| Represents an event that contains a data payload. More... | |
| class | NSFDebugUtility |
| Represents a debug utility class. More... | |
| class | NSFDeepHistory |
| Represents a deep history pseudo-state. More... | |
| class | NSFDelegateListBase |
| Represents a common base class for NSF delegate lists. More... | |
| class | NSFEnvironment |
| Represents information and methods applicable to the entire framework environment. More... | |
| class | NSFEvent |
| Represents an event which can trigger a transition or be handled by an event handler. More... | |
| class | NSFEventContext |
| Represents contextual information for NSF event actions. More... | |
| class | NSFEventHandler |
| Represents a light-weight event handler. More... | |
| class | NSFEventThread |
| Represents a thread that has an event queue and dispatches events to their destinations. More... | |
| class | NSFExceptionContext |
| Represents contextual information for exception actions. More... | |
| class | NSFExceptionHandler |
| Represents a global exception handler through which clients can receive notification of runtime exceptions. More... | |
| class | NSFExternalTransition |
| Represents an external state transition. More... | |
| class | NSFForkJoin |
| Represents a fork-join state. More... | |
| class | NSFForkJoinTransition |
| Represents a transition between two fork-joins. More... | |
| class | NSFId |
| An alias for System.Int64. More... | |
| class | NSFInitialState |
| Represents an initial pseudo-state. More... | |
| class | NSFInternalTransition |
| Represents an internal state transition. More... | |
| class | NSFLocalTransition |
| Represents a local state transition. More... | |
| class | NSFOSSignal |
| Represents an operating system signal that may be used to block thread execution until the signal is sent. More... | |
| class | NSFOSThread |
| Represents an operating system thread. More... | |
| class | NSFOSTimer |
| Represents an operating system timer that can be used to retrieve accurate time and block waiting for the next timeout. More... | |
| class | NSFRegion |
| Represents a composite state region for nested substates. More... | |
| class | NSFScheduledAction |
| Represents an action or actions that can be scheduled for execution on a specified thread at a specified time. More... | |
| class | NSFShallowHistory |
| Represents a shallow history pseudo-state. More... | |
| class | NSFState |
| Represents a state machine state. More... | |
| class | NSFStateMachine |
| Represents a state machine. More... | |
| class | NSFStateMachineContext |
| Represents contextual information for state machine actions and guards. More... | |
| class | NSFString |
| An alias for System.String. More... | |
| class | NSFTaggedObject |
| Represents an object containing unique id and name More... | |
| class | NSFThread |
| Represents the common framework thread functionality. More... | |
| class | NSFTimerAction |
| Represents the base class functionality for implementing a timer action. More... | |
| class | NSFTimerThread |
| Represents a timer thread. More... | |
| class | NSFTraceLog |
| Represents a trace log. More... | |
| class | NSFTraceTags |
| Represents commonly used tags for the trace log. More... | |
| class | NSFTransition |
| Represents a state transition. More... | |
| class | NSFUniquelyNumberedObject |
| Represents an object containing a uniquely numbered id. More... | |
| class | NSFVoidActions< ContextType > |
| Represents a list of actions. More... | |
| class | NSFXMLDocument |
| Represents a simple in-memory xml document editor. More... | |
| class | NSFXMLElement |
| Represents an xml element in an xml document. More... | |
Enumerations | |
| enum | NSFEventStatus { NSFEventUnhandled = 1, NSFEventHandled } |
| Represents the status of the event after attempting to handle it. More... | |
| enum | NSFEventHandlerRunStatus { EventHandlerStopped = 1, EventHandlerStarted } |
| Represents the run status of an event handler. More... | |
| enum | NSFEventHandlerTerminationStatus { EventHandlerReady = 1, EventHandlerTerminating, EventHandlerTerminated } |
| Represents the termination status of an event handler. More... | |
| enum | NSFThreadTerminationStatus { ThreadReady = 1, ThreadTerminating, ThreadTerminated } |
| Represents the termination status of a thread. More... | |
Functions | |
| delegate bool | NSFBoolGuard< ContextType > (ContextType context) |
| Represents a general purpose guard. More... | |
| delegate void | NSFVoidAction< ContextType > (ContextType context) |
| Represents a general purpose action. More... | |
Represents the run status of an event handler.
The run status indicates if the event handler is processing events in its queue. When the method getRunStatus() returns EventHandlerStarted, the event handler is processing events. Use the methods startEventHandler() and stopEventHandler() control event processing.
| Enumerator | |
|---|---|
| EventHandlerStopped | |
| EventHandlerStarted | |
Represents the termination status of an event handler.
The termination status of an event handler can be used to determine when it is safe to delete. When the method getTerminationStatus() returns EventHandlerTerminated, it is safe to delete the event handler. Use the method terminate(...) to initiate the termination process.
| Enumerator | |
|---|---|
| EventHandlerReady | |
| EventHandlerTerminating | |
| EventHandlerTerminated | |
| enum NSFEventStatus |
| delegate bool NorthStateSoftware.NorthStateFramework.NSFBoolGuard< ContextType > | ( | ContextType | context | ) |
Represents a general purpose guard.
| ContextType | The context type passed as an argument to the guard. |
An guard is a delegate type used by the North State Framework.
| delegate void NorthStateSoftware.NorthStateFramework.NSFVoidAction< ContextType > | ( | ContextType | context | ) |
Represents a general purpose action.
| ContextType | The context type passed as an argument to the action. |
An action is a delegate type used by the North State Framework.