Class State

Namespace

Acuit.Pinpoint.Workflows.Activities

Assembly

Acuit.Pinpoint.Workflows.dll

A state machine state.

public class State

Inheritance

object

State

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

CancelExitCondition

Gets or sets an optional condition that can be used to cancel an exit in process from this state due to a transition.

public ValueSource<bool?> CancelExitCondition { get; set; }

Property Value

ValueSource<bool?>

Remarks

This is evaluated after Exiting is executed and before Exit is executed. If this is set and evaluates to true, the transition is canceled and the state machine state will not change; otherwise, the transition will be allowed to occur.

For final states, this is not used and must be left null.

DisplayName

Gets or sets the display name of the state.

public string DisplayName { get; set; }

Property Value

string

Remarks

This is used by debug log messages.

Entry

Gets or sets an optional entry action of the state. It is executed when the state machine enters the state.

public IActivity Entry { get; set; }

Property Value

IActivity

Exit

Gets or sets an optional exit action of the state. It is executed when the state machine leaves the state.

public IActivity Exit { get; set; }

Property Value

IActivity

Exiting

Gets or sets an optional exiting action of the state.

public IActivity Exiting { get; set; }

Property Value

IActivity

Remarks

This is executed when the state machine is about to leave the state, so that the state can do anything necessary that might affect CancelExitCondition.

For final states, this is not used and must be left null.

IsFinal

Gets or sets whether the state is a final state.

public bool IsFinal { get; set; }

Property Value

bool

Remarks

Only root states in the hierarchy can be final states.

Substates

Gets the collection of substates to this state.

public Collection<State> Substates { get; }

Property Value

Collection<State>

Remarks

For final states, this is not used and must be left empty.

Transitions

Gets the collection of outgoing transitions from the state.

public Collection<Transition> Transitions { get; }

Property Value

Collection<Transition>

Remarks

For final states, this is not used and must be left empty.

Methods

EnumerateStateHierarchy()

public IEnumerable<State> EnumerateStateHierarchy()

Returns

IEnumerable<State>

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.