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

Represents a fork-join state. More...

Inheritance diagram for NSFForkJoin:
NSFState NSFTaggedObject NSFUniquelyNumberedObject INSFNamedObject

Public Member Functions

 NSFForkJoin (NSFString name, NSFCompositeState parentState)
 Creates a fork-join state. More...
 
bool isActive (NSFRegion region)
 Indicates if the fork-join is the active substate within the specified region. 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 fork-join state.

Fork-join states are used to provide synchronization and branching across multiple regions.

Constructor & Destructor Documentation

NSFForkJoin ( NSFString  name,
NSFCompositeState  parentState 
)

Creates a fork-join state.

Parameters
nameThe name of the fork-join state.
parentStateThe parent state of the fork-join state.

Member Function Documentation

bool isActive ( NSFRegion  region)

Indicates if the fork-join is the active substate within the specified region.

Parameters
regionThe region in question.
Returns
True if the fork-join is the active substate, otherwise false.



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