Lumiera  0.pre.03
»edityourfreedom«
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
SchedulerFrontend::JobTransaction Class Reference

#include "backend/engine/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 80 of file scheduler-frontend.hpp.

Public Member Functions

JobTransactionaddBackground (Job const &job)
 define a job for background rendering. More...
 
JobTransactionaddFreewheeling (Job const &job)
 define a render job to be calculated as soon as resources permit. More...
 
JobTransactionaddJob (Time deadline, Job const &job)
 define a render job for time-bound calculation More...
 
JobTransactionattach (JobTransaction const &prerequisites)
 define a set of prerequisites of the current JobTransaction. More...
 
void commit ()
 finish this set of job definitions. More...
 
JobTransaction startPrerequisiteTx ()
 

Friends

class SchedulerFrontend
 

Private Member Functions

 JobTransaction (SchedulerFrontend *s)
 

Private Attributes

SchedulerFrontendsched_
 

Constructor & Destructor Documentation

JobTransaction ( SchedulerFrontend s)
inlineprivate

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

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

+ Here is the caller graph for this function:

Member Function Documentation

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 102 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:

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

define a render job for time-bound calculation

Definition at line 110 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:

JobTransaction& addBackground ( Job const &  job)
inline

define a job for background rendering.

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

Referenced by SchedulerInterface_test::verify_job_specification_variations().

+ Here is the caller graph for this function:

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 129 of file scheduler-frontend.hpp.

Referenced by SchedulerInterface_test::verify_job_specification_variations().

+ Here is the caller graph for this function:

JobTransaction& attach ( JobTransaction const &  prerequisites)
inline

define a set of prerequisites of the current JobTransaction.

Parameters
prerequisitesa 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 144 of file scheduler-frontend.hpp.

Referenced by SchedulerInterface_test::specifyJobs().

+ Here is the caller graph for this function:

JobTransaction startPrerequisiteTx ( )
inline

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

References SchedulerFrontend::JobTransaction::JobTransaction().

Referenced by SchedulerInterface_test::specifyJobs().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

SchedulerFrontend* sched_
private

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

Friends And Related Function Documentation

friend class SchedulerFrontend
friend

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

+ Collaboration diagram for SchedulerFrontend::JobTransaction:

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