AxelSemrau.Chronos.IPlannerInfo Interface Reference

Some hopefully useful information about a queued planner. More...

Inheritance diagram for AxelSemrau.Chronos.IPlannerInfo:

Collaboration diagram for AxelSemrau.Chronos.IPlannerInfo:

Properties
string	Name [get]
	Name as shown to the user.
Guid	PlannerID [get]
	Unique identifier for this schedule.
ScheduleState	State [get]
	Current execution state.
string	AbortReason [get]
	If the planer was aborted: The reason why.
IReadOnlyList< IJobInfo >	Jobs [get]
	Information about the jobs in the planner.
uint	RepeatIteration [get]
	How often was this schedule started?
DateTime	StartTime [get]
	Time when the planner was started (UTC)
bool	Paused [get, set]
	Pauses the execution of the planner.
bool	CompletedWithoutErrors [get]
	True if all of the planner's jobs were done without errors.
bool	IsCalculated [get]
	Has passed the initial calculation phase.
bool	WasStarted [get]
	The planner has been started at least once.
TimeSpan	Duration [get]
	The time between start and end time - estimated for unstarted/running schedules, real value for finished schedules.
TimeSpan	Elapsed [get]
	How much time has passed between start and completion / current time.
bool	Failed [get]
	True if some job of the schedule failed or was cancelled.

Detailed Description

Some hopefully useful information about a queued planner.

Definition at line 83 of file Core.cs.

Property Documentation

AbortReason

string AxelSemrau.Chronos.IPlannerInfo.AbortReason

get

If the planer was aborted: The reason why.

Definition at line 100 of file Core.cs.

{ get; }

CompletedWithoutErrors

bool AxelSemrau.Chronos.IPlannerInfo.CompletedWithoutErrors

get

True if all of the planner's jobs were done without errors.

Definition at line 131 of file Core.cs.

{ get; }

Duration

TimeSpan AxelSemrau.Chronos.IPlannerInfo.Duration

get

The time between start and end time - estimated for unstarted/running schedules, real value for finished schedules.

Definition at line 146 of file Core.cs.

{ get; }

Elapsed

TimeSpan AxelSemrau.Chronos.IPlannerInfo.Elapsed

get

How much time has passed between start and completion / current time.

Definition at line 150 of file Core.cs.

{ get; }

Failed

bool AxelSemrau.Chronos.IPlannerInfo.Failed

get

True if some job of the schedule failed or was cancelled.

Definition at line 155 of file Core.cs.

{ get; }

IsCalculated

bool AxelSemrau.Chronos.IPlannerInfo.IsCalculated

get

Has passed the initial calculation phase.

Definition at line 136 of file Core.cs.

{ get; }

Jobs

IReadOnlyList<IJobInfo> AxelSemrau.Chronos.IPlannerInfo.Jobs

get

Information about the jobs in the planner.

Definition at line 104 of file Core.cs.

{ get; }

Name

string AxelSemrau.Chronos.IPlannerInfo.Name

get

Name as shown to the user.

Definition at line 88 of file Core.cs.

{ get; }

Paused

bool AxelSemrau.Chronos.IPlannerInfo.Paused

getset

Pauses the execution of the planner.

Use with care - in case of time critical valve switches or activated heaters which must be turned off again, this can have bad consequences if used improperly.

Definition at line 126 of file Core.cs.

{ get; set; }

PlannerID

Guid AxelSemrau.Chronos.IPlannerInfo.PlannerID

get

Unique identifier for this schedule.

Definition at line 92 of file Core.cs.

{ get; }

RepeatIteration

uint AxelSemrau.Chronos.IPlannerInfo.RepeatIteration

get

How often was this schedule started?

For infinite schedules.

Definition at line 112 of file Core.cs.

{ get; }

StartTime

DateTime AxelSemrau.Chronos.IPlannerInfo.StartTime

get

Time when the planner was started (UTC)

Definition at line 117 of file Core.cs.

{ get; }

State

ScheduleState AxelSemrau.Chronos.IPlannerInfo.State

get

Current execution state.

Definition at line 96 of file Core.cs.

{ get; }

WasStarted

bool AxelSemrau.Chronos.IPlannerInfo.WasStarted

get

The planner has been started at least once.

Definition at line 141 of file Core.cs.

{ get; }

---

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

• Core.cs