Class SequencerBase<TSequenceable>

Inheritance

Object

SequencerBase<TSequenceable>

Loader

Implements

ISequencer<TSequenceable>

IProgressable

IInjectable

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Object.ReferenceEquals(Object, Object)

Namespace: IdleKit.Core

Assembly: cs.temp.dll.dll

Syntax

public abstract class SequencerBase<TSequenceable> : ISequencer<TSequenceable>, IProgressable, IInjectable where TSequenceable : class, ISequenceable

Type Parameters

Name	Description
TSequenceable

Fields

_asyncHelper

Declaration

protected AsyncHelper _asyncHelper

Field Value

Type	Description
AsyncHelper

_currentSequenceableIndex

Declaration

protected int _currentSequenceableIndex

Field Value

Type	Description
Int32

_isCanceled

Declaration

protected bool _isCanceled

Field Value

Type	Description
Boolean

_normalizedProgress

Declaration

protected float _normalizedProgress

Field Value

Type	Description
Single

_reportBuilder

Declaration

protected readonly StringBuilder _reportBuilder

Field Value

Type	Description
StringBuilder

_resolver

Declaration

protected IResolver _resolver

Field Value

Type	Description
IResolver

_sequenceables

Declaration

protected readonly List<TSequenceable> _sequenceables

Field Value

Type	Description
List<TSequenceable>

Properties

IsRunning

Declaration

public abstract bool IsRunning { get; }

Property Value

Type	Description
Boolean

NormalizedProgress

Declaration

public virtual float NormalizedProgress { get; protected set; }

Property Value

Type	Description
Single

Sequenceables

Declaration

public virtual List<TSequenceable> Sequenceables { get; }

Property Value

Type	Description
List<TSequenceable>

Methods

AddSequenceableListeners(ISequenceable)

Declaration

protected virtual void AddSequenceableListeners(ISequenceable sequenceable)

Parameters

Type	Name	Description
ISequenceable	sequenceable

Cancel(TSequenceable)

Declaration

public virtual void Cancel(TSequenceable sequenceable)

Parameters

Type	Name	Description
TSequenceable	sequenceable

CancelAll()

Declaration

public virtual void CancelAll()

Cleanup()

Declaration

public virtual void Cleanup()

CreateParallelSequenceableCollection(TSequenceable[])

Declaration

public abstract IParallelSequenceCollection<TSequenceable> CreateParallelSequenceableCollection(TSequenceable[] sequenceables)

Parameters

Type	Name	Description
TSequenceable[]	sequenceables

Returns

Type	Description
IParallelSequenceCollection<TSequenceable>

Enqueue(SequenceFlow, TSequenceable[])

Declaration

public virtual void Enqueue(SequenceFlow flow, params TSequenceable[] sequenceables)

Parameters

Type	Name	Description
SequenceFlow	flow
TSequenceable[]	sequenceables

GenerateReport()

Declaration

public virtual string GenerateReport()

Returns

Type	Description
String

HandleSequenceableCanceled(ISequenceable)

Declaration

protected virtual void HandleSequenceableCanceled(ISequenceable canceledSequenceable)

Parameters

Type	Name	Description
ISequenceable	canceledSequenceable

HandleSequenceableCompleted(ISequenceable)

Declaration

protected virtual void HandleSequenceableCompleted(ISequenceable completedSequenceable)

Parameters

Type	Name	Description
ISequenceable	completedSequenceable

HandleSequenceableException(ISequenceable, Exception)

Declaration

protected virtual void HandleSequenceableException(ISequenceable sequenceable, Exception exception)

Parameters

Type	Name	Description
ISequenceable	sequenceable
Exception	exception

HandleSequenceableReverted(ISequenceable)

Declaration

protected virtual void HandleSequenceableReverted(ISequenceable revertedSequenceable)

Parameters

Type	Name	Description
ISequenceable	revertedSequenceable

HandleSequenceableStarted(ISequenceable)

Declaration

protected virtual void HandleSequenceableStarted(ISequenceable startedSequenceable)

Parameters

Type	Name	Description
ISequenceable	startedSequenceable

Inject(IResolver)

Declaration

public virtual void Inject(IResolver resolver)

Parameters

Type	Name	Description
IResolver	resolver

InsertAfter(TSequenceable, SequenceFlow, TSequenceable[])

Declaration

public virtual void InsertAfter(TSequenceable existingSequenceable, SequenceFlow flow, params TSequenceable[] newSequenceables)

Parameters

Type	Name	Description
TSequenceable	existingSequenceable
SequenceFlow	flow
TSequenceable[]	newSequenceables

InsertBefore(TSequenceable, SequenceFlow, TSequenceable[])

Declaration

public virtual void InsertBefore(TSequenceable existingSequenceable, SequenceFlow flow, params TSequenceable[] newSequenceables)

Parameters

Type	Name	Description
TSequenceable	existingSequenceable
SequenceFlow	flow
TSequenceable[]	newSequenceables

MonitorProgressRoutine()

Declaration

protected virtual IEnumerator MonitorProgressRoutine()

Returns

Type	Description
IEnumerator

Remove(TSequenceable)

Declaration

public virtual bool Remove(TSequenceable sequenceable)

Parameters

Type	Name	Description
TSequenceable	sequenceable

Returns

Type	Description
Boolean

RemoveSequenceableListeners(ISequenceable)

Declaration

protected virtual void RemoveSequenceableListeners(ISequenceable sequenceable)

Parameters

Type	Name	Description
ISequenceable	sequenceable

Reset()

Declaration

public virtual void Reset()

RevertTo(TSequenceable, Boolean)

Declaration

public virtual void RevertTo(TSequenceable sequenceable, bool continueRunning)

Parameters

Type	Name	Description
TSequenceable	sequenceable
Boolean	continueRunning

Start()

Declaration

public virtual void Start()

StartMonitoringProgress()

Declaration

protected virtual void StartMonitoringProgress()

StartNextRecursively()

Declaration

protected virtual void StartNextRecursively()

StopMonitoringProgress()

Declaration

protected virtual void StopMonitoringProgress()

UpdateProgress()

Declaration

protected virtual void UpdateProgress()

Events

OnProgress

OnProgress should be used to indicate the progress of the ISequencer<TSequenceable>.

Declaration

public event Action<IProgressable, float> OnProgress

Event Type

Type	Description
Action<IProgressable, Single>

OnSequenceableCanceled

Declaration

public event Action<TSequenceable> OnSequenceableCanceled

Event Type

Type	Description
Action<TSequenceable>

OnSequenceableCompleted

Declaration

public event Action<TSequenceable> OnSequenceableCompleted

Event Type

Type	Description
Action<TSequenceable>

OnSequenceableException

Declaration

public event Action<TSequenceable, Exception> OnSequenceableException

Event Type

Type	Description
Action<TSequenceable, Exception>

OnSequenceableReverted

Declaration

public event Action<TSequenceable> OnSequenceableReverted

Event Type

Type	Description
Action<TSequenceable>

OnSequenceableStarted

Declaration

public event Action<TSequenceable> OnSequenceableStarted

Event Type

Type	Description
Action<TSequenceable>

Implements

ISequencer<TSequenceable>

IProgressable

IInjectable