fpmas::api::scheduler::Job Class Reference

#include <scheduler.h>

Inheritance diagram for fpmas::api::scheduler::Job:

Public Types
typedef std::list< Task * >::const_iterator	TaskIterator

Public Member Functions
virtual JID	id () const =0
virtual void	add (Task &task)=0
virtual void	remove (Task &task)=0
virtual std::vector< Task * >	tasks () const =0
virtual TaskIterator	begin () const =0
virtual TaskIterator	end () const =0
virtual void	setBeginTask (Task &task)=0
virtual Task &	getBeginTask () const =0
virtual void	setEndTask (Task &task)=0
virtual Task &	getEndTask () const =0

Detailed Description

Job API.

A Job is a set of task that needs to be executed in any order.

A begin and end task are also added for convenience.

Member Typedef Documentation

TaskIterator

typedef std::list<Task*>::const_iterator fpmas::api::scheduler::Job::TaskIterator

Type used to iterate on a Job, yielding job's tasks.

Member Function Documentation

id()

virtual JID fpmas::api::scheduler::Job::id ( ) const

pure virtual

Job id.

Implemented in fpmas::scheduler::Job.

add()

virtual void fpmas::api::scheduler::Job::add ( Task &  task )

pure virtual

Adds a task to this Job.

Parameters

task	task to add

Implemented in fpmas::scheduler::Job.

remove()

virtual void fpmas::api::scheduler::Job::remove ( Task &  task )

pure virtual

Removes a task from this job.

Parameters

task	task to remove

Implemented in fpmas::scheduler::Job.

tasks()

virtual std::vector< Task * > fpmas::api::scheduler::Job::tasks ( ) const

pure virtual

Returns a reference to the internal Tasks list.

Returns

current tasks list

Implemented in fpmas::scheduler::Job.

begin()

virtual TaskIterator fpmas::api::scheduler::Job::begin ( ) const

pure virtual

Returns a begin iterator to the job's tasks.

Returns

begin iterator

Implemented in fpmas::scheduler::Job.

end()

virtual TaskIterator fpmas::api::scheduler::Job::end ( ) const

pure virtual

Returns an end iterator to the job's tasks.

Returns

end iterator

Implemented in fpmas::scheduler::Job.

setBeginTask()

virtual void fpmas::api::scheduler::Job::setBeginTask ( Task &  task )

pure virtual

Sets the begin task of the job.

This task is assumed to be executed before the regular and unordered task list.

Parameters

task	begin task

Implemented in fpmas::scheduler::Job.

getBeginTask()

virtual Task & fpmas::api::scheduler::Job::getBeginTask ( ) const

pure virtual

Gets a reference to the begin task of this job.

Returns

begin task

Implemented in fpmas::scheduler::Job.

setEndTask()

virtual void fpmas::api::scheduler::Job::setEndTask ( Task &  task )

pure virtual

Sets the end task of the job.

This task is assumed to be executed after the regular and unordered task list.

Parameters

task

end task

Implemented in fpmas::scheduler::Job.

getEndTask()

virtual Task & fpmas::api::scheduler::Job::getEndTask ( ) const

pure virtual

Gets a reference to the end task of this job.

Returns

end task

Implemented in fpmas::scheduler::Job.

---

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

• src/fpmas/api/scheduler/scheduler.h