scheduling_common Class Reference

Defines values used within the scheduling library. More...

#include <scheduling_common.h>

Inheritance diagram for scheduling_common:

[legend]Collaboration diagram for scheduling_common:

[legend]List of all members.

Public Types
enum	outcomes {   OKAY = common::OKAY, UNINITIALIZED = common::UNINITIALIZED, TIME_OUT = common::TIMED_OUT, FAILURE = common::FAILURE,   NOT_FOUND = common::NOT_FOUND, BAD_INPUT = common::BAD_INPUT, NO_SPACE = common::NO_SPACE, POSTPONE,   later, CANCEL, cancelled, FINISHED,   complete, MORE_LEFT, timeslice, NO_ACTOR,   missing }
	these represent what can happen during an attempt to schedule an item. More...
Public Member Functions
	IMPLEMENT_CLASS_NAME ("scheduling_common")
Static Public Member Functions
static const char *	outcome_name (const outcome &to_name)
	returns the textual form of the outcome "to_name".

---

Detailed Description

Defines values used within the scheduling library.

Definition at line 27 of file scheduling_common.h.

---

Member Enumeration Documentation

enum scheduling_common::outcomes

these represent what can happen during an attempt to schedule an item.

Enumerator:

OKAY	the item was scheduled just fine.
UNINITIALIZED	something is not initialized properly.
TIME_OUT	the item has timed out during scheduling.
FAILURE	there was a failure during the scheduling of the item.
NOT_FOUND	the item specified was not found.
BAD_INPUT	one of the input parameters was erroneous.
NO_SPACE	there is no room left in the schedule for this item.
POSTPONE
later	the item should be skipped for now.
CANCEL
cancelled	the item should be removed from the schedule.
FINISHED
complete	the item is done being scheduled.
MORE_LEFT
timeslice	more items are left to schedule.
NO_ACTOR
missing	could not find the actor responsible for this.

Definition at line 31 of file scheduling_common.h.

---

Member Function Documentation

scheduling_common::IMPLEMENT_CLASS_NAME

(

"scheduling_common"

)

const char * scheduling_common::outcome_name

(

const outcome &

to_name

)

[static]

returns the textual form of the outcome "to_name".

Definition at line 20 of file scheduling_common.cpp.

References CANCEL, FINISHED, MORE_LEFT, NO_ACTOR, common::outcome_name(), POSTPONE, and outcome::value().

---

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

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

---