periodicity Class Reference

Describes the scheduling characteristics of an item to be scheduled. More...

#include <periodicity.h>

Inheritance diagram for periodicity:

[legend]Collaboration diagram for periodicity:

[legend]List of all members.

Public Member Functions
	periodicity (int entry=0, const time_stamp &start=time_stamp(), int expire=0)
	creates a measure of periodicity given the bounding parameters.
istring	per_text_form () const
	returns a string containing a printout of the class data.
Public Attributes
int	entry_interval
	the time interval between entries into the scheduler.
time_stamp	start_time
	the time at which this item can be scheduled.
int	expiration_interval
	if non-zero, this is the interval between expirations of the item.

---

Detailed Description

Describes the scheduling characteristics of an item to be scheduled.

An item's schedule is specified in terms of its time of entry, its repetition interval and its expiration time. All "int" measurements here are measured in milliseconds.

Definition at line 29 of file periodicity.h.

---

Constructor & Destructor Documentation

periodicity::periodicity	(	int	entry = 0,
		const time_stamp &	start = time_stamp(),
		int	expire = 0
	)			[inline]

creates a measure of periodicity given the bounding parameters.

this creats an item with the "entry" interval, the specified "start" time, and "expire" milliseconds allowed in the schedule before expiration occurs.

Definition at line 64 of file periodicity.h.

---

Member Function Documentation

istring periodicity::per_text_form

(

)

const

returns a string containing a printout of the class data.

Definition at line 22 of file periodicity.cpp.

References entry_interval, expiration_interval, istring::SPRINTF, start_time, and time_stamp::text_form().

Referenced by schedulable::schedulable_text_form().

---

Member Data Documentation

int periodicity::entry_interval

the time interval between entries into the scheduler.

Definition at line 33 of file periodicity.h.

Referenced by per_text_form().

time_stamp periodicity::start_time

the time at which this item can be scheduled.

it will not be activated before this time. this is reset after every time the item is scheduled such that it always indicates the correct next starting time (by adding the interval amount to the time at which the last schedule activation occurred).

Definition at line 36 of file periodicity.h.

Referenced by per_text_form().

int periodicity::expiration_interval

if non-zero, this is the interval between expirations of the item.

when the item expires, its expiration_hook is called. the hook decides either that the item will remain in the schedule until the next expiration or that it gets chucked out of the schedule. whenever a scheduling activation happens successfully on the item, the expiration timer is reset to this interval. thus it is a per-activation expiration.

Definition at line 43 of file periodicity.h.

Referenced by per_text_form().

---

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

• /home/fred/hoople/source/lib_src/library/scheduling/periodicity.h
• /home/fred/hoople/source/lib_src/library/scheduling/periodicity.cpp

---