SchedulerDiagnostics Class Reference

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

Description

Render engine diagnostic facility.

Creating an instance will activate additional tracing and diagnostic facilities within the scheduler implementation; results may be investigated through SchedulerDiagnostics public functions. The object acts like a smart handle, i.e. the tracing facilities will be disabled and disconnected when going out of scope.

Warning

not reentrant, no reference-counting. At any given time, at most a single instance of SchedulerDiagnostics may be used.

Definition at line 60 of file scheduler-diagnostics.hpp.

Public Member Functions
	SchedulerDiagnostics (SchedulerFrontend &sch)
	~SchedulerDiagnostics ()
bool	is_scheduled_timebound (HashVal jobID)
bool	is_scheduled_freewheeling (HashVal jobID)
bool	is_scheduled_background (HashVal jobID)
bool	is_scheduled_timebound (Job const &job)
bool	is_scheduled_freewheeling (Job const &job)
bool	is_scheduled_background (Job const &job)
bool	has_job_scheduled_at (Time deadline)
Job const &	job_at (Time deadline)

Private Attributes
SchedulerFrontend &	scheduler_

Additional Inherited Members
Private Member Functions inherited from NonCopyable
	~NonCopyable ()=default
	NonCopyable ()=default
	NonCopyable (NonCopyable const &)=delete
NonCopyable &	operator= (NonCopyable const &)=delete

Constructor & Destructor Documentation

SchedulerDiagnostics()

SchedulerDiagnostics ( SchedulerFrontend &  sch )

inline

Definition at line 66 of file scheduler-diagnostics.hpp.

References SchedulerFrontend::activateTracing(), and SchedulerDiagnostics::scheduler_.

Here is the call graph for this function:

~SchedulerDiagnostics()

~SchedulerDiagnostics ( )

inline

Definition at line 72 of file scheduler-diagnostics.hpp.

References SchedulerFrontend::disableTracing(), and SchedulerDiagnostics::scheduler_.

Here is the call graph for this function:

Member Function Documentation

is_scheduled_timebound() [1/2]

bool is_scheduled_timebound ( HashVal  jobID )

inline

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

Referenced by SchedulerDiagnostics::is_scheduled_timebound(), SchedulerInterface_test::verify_job_specification_variations(), and SchedulerInterface_test::verify_simple_job_specification().

Here is the caller graph for this function:

is_scheduled_freewheeling() [1/2]

bool is_scheduled_freewheeling ( HashVal  jobID )

inline

Definition at line 86 of file scheduler-diagnostics.hpp.

Referenced by SchedulerDiagnostics::is_scheduled_freewheeling(), SchedulerInterface_test::verify_job_specification_variations(), and SchedulerInterface_test::verify_simple_job_specification().

Here is the caller graph for this function:

is_scheduled_background() [1/2]

bool is_scheduled_background ( HashVal  jobID )

inline

Definition at line 92 of file scheduler-diagnostics.hpp.

Referenced by SchedulerDiagnostics::is_scheduled_background(), SchedulerInterface_test::verify_job_specification_variations(), and SchedulerInterface_test::verify_simple_job_specification().

Here is the caller graph for this function:

is_scheduled_timebound() [2/2]

bool is_scheduled_timebound ( Job const &  job )

inline

Definition at line 98 of file scheduler-diagnostics.hpp.

References vault::gear::hash_value(), and SchedulerDiagnostics::is_scheduled_timebound().

Here is the call graph for this function:

is_scheduled_freewheeling() [2/2]

bool is_scheduled_freewheeling ( Job const &  job )

inline

Definition at line 104 of file scheduler-diagnostics.hpp.

References vault::gear::hash_value(), and SchedulerDiagnostics::is_scheduled_freewheeling().

Here is the call graph for this function:

is_scheduled_background() [2/2]

bool is_scheduled_background ( Job const &  job )

inline

Definition at line 110 of file scheduler-diagnostics.hpp.

References vault::gear::hash_value(), and SchedulerDiagnostics::is_scheduled_background().

Here is the call graph for this function:

has_job_scheduled_at()

bool has_job_scheduled_at ( Time  deadline )

inline

Definition at line 116 of file scheduler-diagnostics.hpp.

Referenced by SchedulerInterface_test::demonstrate_nested_job_specification().

Here is the caller graph for this function:

job_at()

Job const & job_at ( Time  deadline )

inline

Definition at line 125 of file scheduler-diagnostics.hpp.

Referenced by SchedulerInterface_test::demonstrate_nested_job_specification().

Here is the caller graph for this function:

Member Data Documentation

scheduler_

SchedulerFrontend& scheduler_

private

Definition at line 63 of file scheduler-diagnostics.hpp.

Referenced by SchedulerDiagnostics::SchedulerDiagnostics(), and SchedulerDiagnostics::~SchedulerDiagnostics().

Inheritance diagram for SchedulerDiagnostics:

Collaboration diagram for SchedulerDiagnostics:

---

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

• scheduler-diagnostics.hpp