Engine²
Open-source game engine written in C++.
Loading...
Searching...
No Matches
Engine::Scheduler::IScheduler Class Referenceabstract

Interface for the schedulers. A scheduler is responsible for running systems according to a specific policy. Schedulers also manage how logic (system) should be handled. More...

#include <IScheduler.hpp>

Inheritance diagram for Engine::Scheduler::IScheduler:
Engine::Scheduler::AScheduler Engine::Scheduler::FixedTimeUpdate Engine::Scheduler::RelativeTimeUpdate Engine::Scheduler::Shutdown Engine::Scheduler::Startup Engine::Scheduler::Update RenderingPipeline::Init RenderingPipeline::Setup SchedulerTest1 SchedulerTest2 TestSchedulerA TestSchedulerB

Public Member Functions

virtual ~IScheduler ()=default
 Virtual destructor for IScheduler.
virtual void RunSystems (void)=0
 Run the systems according to the scheduler policy.
virtual SchedulerErrorPolicy GetErrorPolicy () const =0
 Get the scheduler policy.
virtual void SetErrorPolicy (SchedulerErrorPolicy errorPolicy)=0
 Set the scheduler policy.

Detailed Description

Interface for the schedulers. A scheduler is responsible for running systems according to a specific policy. Schedulers also manage how logic (system) should be handled.

Todo
Remove this interface and merge it with the AScheduler class.

Constructor & Destructor Documentation

◆ ~IScheduler()

virtual Engine::Scheduler::IScheduler::~IScheduler ( )
virtualdefault

Virtual destructor for IScheduler.

Member Function Documentation

◆ GetErrorPolicy()

virtual SchedulerErrorPolicy Engine::Scheduler::IScheduler::GetErrorPolicy ( ) const
pure virtual

Get the scheduler policy.

Returns
The scheduler policy
See also
Engine::Scheduler::SchedulerErrorPolicy

Implemented in Engine::Scheduler::AScheduler.

◆ RunSystems()

virtual void Engine::Scheduler::IScheduler::RunSystems ( void )
pure virtual

◆ SetErrorPolicy()

virtual void Engine::Scheduler::IScheduler::SetErrorPolicy ( SchedulerErrorPolicy errorPolicy)
pure virtual

Set the scheduler policy.

Parameters
errorPolicyThe scheduler policy
See also
Engine::Scheduler::SchedulerErrorPolicy

Implemented in Engine::Scheduler::AScheduler.


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