Ntp.Common.Process.JobScheduleDescription Class Reference

A description of job schedule rules. More...

Public Member Functions
	JobScheduleDescription (bool initialRun, bool fixedRun, int frequency)
	Initializes a new instance of the JobScheduleDescription class. More...
DateTime	CalculateNextRun (DateTime start)
	Calculates the time of next run according to description parameters. More...
ScheduledJob	CreateNew (Job job, DateTime start, double offset)
	Creates a new scheduled job based on description and parameters. More...
ScheduledJob	CreatePostponed (Job job)
	Creates a postponed job schedule. More...

Public Attributes
bool	CanMove => !(InitialRun && !initialRunDone) && !FixedRun
	Gets a value indicating whether this description allow schedules to be moved. More...

Properties
bool	FixedRun [get]
	Gets a value indicating whether this JobScheduleDescription has a fixed schedule frequency, eg. cannot be moved. More...
int	Frequency [get]
	Gets the schedule frequency in minutes. More...
bool	InitialRun [get]
	Gets a value indicating whether this JobScheduleDescription should do an initial run upon first call. More...

Private Attributes
bool	initialRunDone

Detailed Description

A description of job schedule rules.

Definition at line 29 of file JobScheduleDescription.cs.

Constructor & Destructor Documentation

Ntp.Common.Process.JobScheduleDescription.JobScheduleDescription ( bool  initialRun, bool  fixedRun, int  frequency  )

inline

Initializes a new instance of the JobScheduleDescription class.

Parameters

initialRun	If set to true initial run.
fixedRun	If set to true fixed run.
frequency	Frequency in minutes.

Definition at line 37 of file JobScheduleDescription.cs.

        {
            InitialRun = initialRun || (frequency == 0);
            FixedRun = fixedRun;
            Frequency = frequency;
            initialRunDone = false;
        }

Member Function Documentation

DateTime Ntp.Common.Process.JobScheduleDescription.CalculateNextRun ( DateTime  start )

inline

Calculates the time of next run according to description parameters.

Returns

The next run.

Parameters

start

Start.

Definition at line 78 of file JobScheduleDescription.cs.

Referenced by Ntp.Common.Process.Scheduler.QueueJob().

        {
            if (Frequency == -1)
                return DateTime.MaxValue;
            if (Frequency == 0 || (InitialRun && !initialRunDone))
                return start;

            int multiplier = Convert.ToInt32(Math.Truncate((double) (start.Hour*60 + start.Minute)/Frequency));
            int startMinutes = multiplier*Frequency;

            int hour = (startMinutes + Frequency)/60;
            int minute = (startMinutes + Frequency)%60;

            if (hour >= 24)
            {
                hour -= 24;
                start = start.AddDays(1);
            }

            if (minute >= 60)
            {
                minute -= 60;
                start = start.AddHours(1);
            }

            var next = new DateTime(start.Year, start.Month, start.Day, hour, minute, 0);

            return next;
        }

Here is the caller graph for this function:

ScheduledJob Ntp.Common.Process.JobScheduleDescription.CreateNew ( Job  job, DateTime  start, double  offset  )

inline

Creates a new scheduled job based on description and parameters.

Returns

The new.

Parameters

job	Job.
start	Start.
offset	Offset.

Definition at line 115 of file JobScheduleDescription.cs.

Referenced by Ntp.Common.Process.Scheduler.QueueJob().

        {
            if (InitialRun && !initialRunDone)
            {
                initialRunDone = true;
                return new ScheduledJob(job, start);
            }

            return new ScheduledJob(job, CalculateNextRun(start).AddMinutes(offset));
        }

Here is the caller graph for this function:

ScheduledJob Ntp.Common.Process.JobScheduleDescription.CreatePostponed ( Job  job )

inline

Creates a postponed job schedule.

Returns

The postponed.

Parameters

job

Job.

Definition at line 131 of file JobScheduleDescription.cs.

Referenced by Ntp.Common.Process.Scheduler.PostponeJob().

        {
            double offset = Frequency/100.0;

            if (offset > 2)
            {
                offset = 2;
            }
            else if (offset < 0.5)
            {
                offset = 0.5;
            }

            return new ScheduledJob(job, DateTime.Now.AddMinutes(offset));
        }

Here is the caller graph for this function:

Member Data Documentation

bool Ntp.Common.Process.JobScheduleDescription.CanMove => !(InitialRun && !initialRunDone) && !FixedRun

Gets a value indicating whether this description allow schedules to be moved.

true if this instance can move; otherwise, false.

Definition at line 71 of file JobScheduleDescription.cs.

Referenced by Ntp.Common.Process.Scheduler.QueueJob().

bool Ntp.Common.Process.JobScheduleDescription.initialRunDone

private

Definition at line 45 of file JobScheduleDescription.cs.

Property Documentation

bool Ntp.Common.Process.JobScheduleDescription.FixedRun

get

Gets a value indicating whether this JobScheduleDescription has a fixed schedule frequency, eg. cannot be moved.

true if fixed run; otherwise, false.

Definition at line 59 of file JobScheduleDescription.cs.

Referenced by Ntp.Analyzer.Monitor.Server.Billboard.Jobs(), Ntp.Analyzer.Monitor.Server.Billboard.Proc(), Ntp.Analyzer.Monitor.Server.Billboard.Running(), Ntp.Analyzer.Monitor.Server.Billboard.Schedule(), and Ntp.Common.Log.LogExtensions.SchedulerJobAdded().

int Ntp.Common.Process.JobScheduleDescription.Frequency

get

Gets the schedule frequency in minutes.

The frequency.

Definition at line 65 of file JobScheduleDescription.cs.

Referenced by Ntp.Analyzer.Monitor.Server.Billboard.Jobs(), Ntp.Analyzer.Monitor.Server.Billboard.Proc(), Ntp.Common.Process.Scheduler.QueueJob(), Ntp.Analyzer.Monitor.Server.Billboard.Running(), Ntp.Common.Process.Scheduler.RunOneCycle(), Ntp.Analyzer.Monitor.Server.Billboard.Schedule(), and Ntp.Common.Log.LogExtensions.SchedulerJobAdded().

bool Ntp.Common.Process.JobScheduleDescription.InitialRun

get

Gets a value indicating whether this JobScheduleDescription should do an initial run upon first call.

true if initial run; otherwise, false.

Definition at line 52 of file JobScheduleDescription.cs.

Referenced by Ntp.Analyzer.Monitor.Server.Billboard.Jobs(), Ntp.Analyzer.Monitor.Server.Billboard.Proc(), Ntp.Analyzer.Monitor.Server.Billboard.Running(), and Ntp.Analyzer.Monitor.Server.Billboard.Schedule().

---

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

• Ntp.Common/Process/JobScheduleDescription.cs