biz.dfch.CS.StateMachine
1.2.0
See the version list below for details.
dotnet add package biz.dfch.CS.StateMachine --version 1.2.0
NuGet\Install-Package biz.dfch.CS.StateMachine -Version 1.2.0
<PackageReference Include="biz.dfch.CS.StateMachine" Version="1.2.0" />
paket add biz.dfch.CS.StateMachine --version 1.2.0
#r "nuget: biz.dfch.CS.StateMachine, 1.2.0"
// Install biz.dfch.CS.StateMachine as a Cake Addin #addin nuget:?package=biz.dfch.CS.StateMachine&version=1.2.0 // Install biz.dfch.CS.StateMachine as a Cake Tool #tool nuget:?package=biz.dfch.CS.StateMachine&version=1.2.0
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)
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET Framework | net is compatible. |
-
- Newtonsoft.Json (>= 6.0.8)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on biz.dfch.CS.StateMachine:
Package | Downloads |
---|---|
biz.dfch.CS.Entity.LifeCycleManager
biz.dfch.CS.Entity.LifeCycleManager ============================== Allows managing the lifecycle of entities. Supports pre- and post-callouts/hooks. Internally the LifeCycleManager uses the [biz.dfch.CS.StateMachine](https://github.com/dfensgmbh/biz.dfch.CS.StateMachine). ## License Information Telerik JustMock has to be licensed separately. Only the code samples (source code files) are licensed under the Apache 2.0 license. The Telerik JustMock software has to be licensed separately. See the NOTICE file for more information about this. |
GitHub repositories
This package is not used by any popular GitHub repositories.
20150926
* adjust namespace
* States and Conditions can now be retrieved by consumer
* added code contracts pre-conditions
* enabled CodeContracts assemlby