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

Represents a composite state region for nested substates. More...

Inheritance diagram for NSFRegion:
NSFTaggedObject NSFUniquelyNumberedObject INSFNamedObject

Public Member Functions

 NSFRegion (NSFString name, NSFCompositeState parentState)
 Creates a region. More...
 
bool isInState (NSFState state)
 Indicates if the region's active substate is the specified state. More...
 
bool isInState (NSFString stateName)
 Indicates if the region's active substate is 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...
 
- 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 composite state region for nested substates.

Multiple regions within a composite state indicate concurrent behaviors.

Constructor & Destructor Documentation

NSFRegion ( NSFString  name,
NSFCompositeState  parentState 
)

Creates a region.

Parameters
nameThe name of the region.
parentStateThe parent state of the region.

Member Function Documentation

bool isInState ( NSFState  state)

Indicates if the region's active substate is the specified state.

Parameters
stateThe state in question.
Returns
True if the region's active substate is the specified state, false otherwise.
bool isInState ( NSFString  stateName)

Indicates if the region's active substate is the specified state.

Parameters
stateNameThe name of the state in question.
Returns
True if the region's active substate is the specified state, false otherwise.



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