pluginbase.Objects.Tasks.IterativeTask Class Reference

A task that reoccurs until TaskResult is remove. Keeps track of number of invocations Evaluates as many times within time restriction as allowable More...

Inheritance diagram for pluginbase.Objects.Tasks.IterativeTask:

Public Member Functions
	IterativeTask (Func< int, TaskResult > method)
	IterativeTask (IIterableSystem system)
TaskResult	InvokeTask (long maxMilliseconds)
override string	ToString ()

Properties
TimeSpan	Frequency [get]
Properties inherited from pluginbase.Objects.Tasks.ITask
TimeSpan	Frequency [get]

Detailed Description

A task that reoccurs until TaskResult is remove. Keeps track of number of invocations Evaluates as many times within time restriction as allowable

Constructor & Destructor Documentation

IterativeTask() [1/2]

pluginbase.Objects.Tasks.IterativeTask.IterativeTask

(

Func< int, TaskResult >

method

)

        {
            _method = method;
        }

IterativeTask() [2/2]

pluginbase.Objects.Tasks.IterativeTask.IterativeTask

(

IIterableSystem

system

)

        {
            _method = system.Iterate;
        }

Member Function Documentation

InvokeTask()

TaskResult pluginbase.Objects.Tasks.IterativeTask.InvokeTask

(

long

maxMilliseconds

)

Implements pluginbase.Objects.Tasks.ITask.

        {
            var sw = new Stopwatch();
            sw.Start();
            while (sw.ElapsedMilliseconds < maxMilliseconds)
            {
                if (_method(_runCount) == TaskResult.Remove)
                {
                    return TaskResult.Remove;
                }
                _runCount++;
            }
            sw.Stop();
            return TaskResult.Continue;
        }

ToString()

override string pluginbase.Objects.Tasks.IterativeTask.ToString

(

)

        {
            return string.Format("[IterativeTask: Frequency={0}, {1}]", Frequency, _method.Method.Name);
        }

Property Documentation

Frequency

TimeSpan pluginbase.Objects.Tasks.IterativeTask.Frequency

get

---

The documentation for this class was generated from the following file:

• pluginbase/Objects/Tasks/IterativeTask.cs