biz.dfch.CS.StateMachine 1.2.2

biz.dfch.CS.StateMachine
========================

A simple C# based State Machine that can be configured via State Transitions based on an idea by [Juliet](http://stackoverflow.com/users/40516/juliet) "[Simple state machine example in C#?](http://stackoverflow.com/questions/5923767/simple-state-machine-example-in-c)"

# DESCRIPTION

The project contains an extendable StateMachine that defines a few simple states and two conditions ("Continue", "Cancel") that can be used to advance (transition) through that state machine.

When instatiating the StateMachine with the default constructor the following states, conditions and transitions will be set up per default

## States

* Running
* InternalErrorState
* Completed
* Cancelled
* Disposed


## Conditions

* Continue
* Cancel


## Transitions

Source state | Condition | Target state
:-----|:-----|:------
Created | Continue | Running
Created | Cancel | InternalErrorState
Running | Continue | Completed
Running | Cancel | Cancelled
Completed | Continue | Disposed
Completed | Cancel | InternalErrorState
Cancelled | Continue | Disposed
Cancelled | Cancel | InternalErrorState
InternalErrorState | Continue | Disposed


## Basic functionalities

1. The [`Continue`](./biz.dfch.CS.StateMachine/StateMachine.cs#L94) condition makes a transition from an arbitrary state to the next state as the "good case"
1. The [`Cancel`](./biz.dfch.CS.StateMachine/StateMachine.cs#L02) condition makes a transition from an arbitrary state to the next state as the "bad case"
1. Furthermore there is the [`GetNext`](./biz.dfch.CS.StateMachine/StateMachine.cs#L306) method to transit to the next state based on a given condition.

There are as well methods for exporting and importing the configuration along with the states:

* [`GetStringRepresentation()`](https://github.com/dfensgmbh/biz.dfch.CS.StateMachine/blob/master/biz.dfch.CS.StateMachine/StateMachine.cs#L345)
* [`SetupStateMachine(String configuration, String currentState = null, String previousState = null)`](https://github.com/dfensgmbh/biz.dfch.CS.StateMachine/blob/master/biz.dfch.CS.StateMachine/StateMachine.cs#L135)

Install-Package biz.dfch.CS.StateMachine -Version 1.2.2
dotnet add package biz.dfch.CS.StateMachine --version 1.2.2
<PackageReference Include="biz.dfch.CS.StateMachine" Version="1.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add biz.dfch.CS.StateMachine --version 1.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Release Notes

20160104
* Changed default value of InitialState property to 'InitialState' (Was 'Created')

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.2.2 518 1/4/2016
1.2.1 373 12/21/2015
1.2.0 400 9/26/2015
1.1.0 358 9/23/2015
1.0.3 391 8/21/2015
1.0.2 366 8/11/2015
1.0.1 389 8/3/2015
1.0.0 449 7/31/2015