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

Represents an external state transition. More...

Inheritance diagram for NSFExternalTransition:
NSFTransition NSFTaggedObject NSFUniquelyNumberedObject INSFNamedObject NSFForkJoinTransition

Public Member Functions

 NSFExternalTransition (NSFState source, NSFState target, NSFEvent trigger, NSFBoolGuard< NSFStateMachineContext > guard, NSFVoidAction< NSFStateMachineContext > action)
 Creates an external transition. More...
 
 NSFExternalTransition (NSFString name, NSFState source, NSFState target, NSFEvent trigger, NSFBoolGuard< NSFStateMachineContext > guard, NSFVoidAction< NSFStateMachineContext > action)
 Creates an external transition. More...
 
- Public Member Functions inherited from NSFTransition
void addTrigger (NSFEvent trigger)
 Adds a trigger to the list of trigger events. 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...
 

Protected Member Functions

override void fireTransition (NSFStateMachineContext context)
 Fires the transition. More...
 
- Protected Member Functions inherited from NSFTransition
 NSFTransition (NSFString name, NSFState source, NSFState target, NSFEvent trigger, NSFBoolGuard< NSFStateMachineContext > guard, NSFVoidAction< NSFStateMachineContext > action)
 Creates a transition. More...
 

Properties

override NSFState Source [set]
 
- Properties inherited from NSFTransition
virtual NSFState Source [get, set]
 Gets or sets the source of the transition. More...
 
NSFState Target [get, set]
 Gets or sets the target of the transition. More...
 
List< NSFEventTriggers [get]
 Gets the list of trigger events for the transition. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from NSFUniquelyNumberedObject
static NSFId getNextUniqueId ()
 Gets the next unique id. More...
 
- Public Attributes inherited from NSFTransition
NSFVoidActions
< NSFStateMachineContext
Actions = new NSFVoidActions<NSFStateMachineContext>()
 Actions to be executed whenever the transition is taken. More...
 
NSFBoolGuards
< NSFStateMachineContext
Guards = new NSFBoolGuards<NSFStateMachineContext>()
 Guards to be evaluated to determine if the transition can be taken. More...
 

Detailed Description

Represents an external state transition.

Transitions may specify an event trigger, guards, and/or a transition actions. External transitions force exiting of their source state.

Constructor & Destructor Documentation

NSFExternalTransition ( NSFState  source,
NSFState  target,
NSFEvent  trigger,
NSFBoolGuard< NSFStateMachineContext guard,
NSFVoidAction< NSFStateMachineContext action 
)

Creates an external transition.

Parameters
sourceTransition source.
targetTransition target.
triggerTransition trigger.
guardTransition guard.
actionTransition action.

The default name for the transition is [soure.Name]To[target.Name]

NSFExternalTransition ( NSFString  name,
NSFState  source,
NSFState  target,
NSFEvent  trigger,
NSFBoolGuard< NSFStateMachineContext guard,
NSFVoidAction< NSFStateMachineContext action 
)

Creates an external transition.

Parameters
nameUser assigned name for transition.
sourceTransition source.
targetTransition target.
triggerTransition trigger.
guardTransition guard.
actionTransition action.

Member Function Documentation

override void fireTransition ( NSFStateMachineContext  context)
protectedvirtual

Fires the transition.

Parameters
contextThe state machine context associated with the transition firing.

This method is for use only by the North State Framework's internal logic.

Implements NSFTransition.

Property Documentation

override NSFState Source
set



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