SchedulerFrontend::JobTransaction Class Reference

#include "vault/gear/scheduler-frontend.hpp"

Description

Definition context for jobs to be scheduled.

This builder allows to specify individual jobs, and to attach a transaction for prerequisite jobs. When done, the commit operation can be used to activate all jobs defined this far.

Definition at line 75 of file scheduler-frontend.hpp.

Public Member Functions
void	commit ()
	finish this set of job definitions.
JobTransaction &	addJob (Time deadline, Job const &job)
	define a render job for time-bound calculation
JobTransaction &	addBackground (Job const &job)
	define a job for background rendering.
JobTransaction &	addFreewheeling (Job const &job)
	define a render job to be calculated as soon as resources permit.
JobTransaction &	attach (JobTransaction const &prerequisites)
	define a set of prerequisites of the current JobTransaction.
JobTransaction	startPrerequisiteTx ()

Friends
class	SchedulerFrontend

Private Member Functions
	JobTransaction (SchedulerFrontend *s)

Private Attributes
SchedulerFrontend *	sched_

Constructor & Destructor Documentation

JobTransaction()

JobTransaction ( SchedulerFrontend *  s )

inlineprivate

Definition at line 80 of file scheduler-frontend.hpp.

Member Function Documentation

commit()

void commit ( )

inline

finish this set of job definitions.

All jobs attached to this transaction thus far, and all dependent transactions will be scheduled

Note

transaction should not be used beyond this point; contents and data structures are cleared right away;

Definition at line 97 of file scheduler-frontend.hpp.

Referenced by SchedulerInterface_test::demonstrate_nested_job_specification(), SchedulerInterface_test::verify_job_specification_variations(), and SchedulerInterface_test::verify_simple_job_specification().

Here is the caller graph for this function:

addJob()

JobTransaction & addJob ( Time  deadline, Job const &  job  )

inline

define a render job for time-bound calculation

Definition at line 105 of file scheduler-frontend.hpp.

Referenced by SchedulerInterface_test::specifyJobs(), and SchedulerInterface_test::verify_simple_job_specification().

Here is the caller graph for this function:

addBackground()

JobTransaction & addBackground ( Job const &  job )

inline

define a job for background rendering.

Definition at line 113 of file scheduler-frontend.hpp.

Referenced by SchedulerInterface_test::verify_job_specification_variations().

Here is the caller graph for this function:

addFreewheeling()

JobTransaction & addFreewheeling ( Job const &  job )

inline

define a render job to be calculated as soon as resources permit.

Typically this call is used for rendering final results.

Definition at line 124 of file scheduler-frontend.hpp.

Referenced by SchedulerInterface_test::verify_job_specification_variations().

Here is the caller graph for this function:

attach()

JobTransaction & attach ( JobTransaction const &  prerequisites )

inline

define a set of prerequisites of the current JobTransaction.

Parameters

prerequisites

a set of job definitions, which need to be executed successfully before any job of the current JobTransaction may be invoked.

Note

prerequisites may be nested recursively, a prerequisite transaction might rely on further prerequisites

Definition at line 139 of file scheduler-frontend.hpp.

Referenced by SchedulerInterface_test::specifyJobs().

Here is the caller graph for this function:

startPrerequisiteTx()

JobTransaction startPrerequisiteTx ( )

inline

Definition at line 146 of file scheduler-frontend.hpp.

References SchedulerFrontend::JobTransaction::sched_.

Referenced by SchedulerInterface_test::specifyJobs().

Here is the caller graph for this function:

Member Data Documentation

sched_

SchedulerFrontend* sched_

private

Definition at line 77 of file scheduler-frontend.hpp.

Referenced by SchedulerFrontend::JobTransaction::startPrerequisiteTx().

Friends And Related Symbol Documentation

SchedulerFrontend

friend class SchedulerFrontend

friend

Definition at line 84 of file scheduler-frontend.hpp.

Collaboration diagram for SchedulerFrontend::JobTransaction:

---

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

• scheduler-frontend.hpp