Radium Engine  1.5.20
Loading...
Searching...
No Matches
Ra::Core::Task Class Referenceabstract

#include <Core/Tasks/Task.hpp>

+ Inheritance diagram for Ra::Core::Task:
+ Collaboration diagram for Ra::Core::Task:

Public Member Functions

virtual ~Task ()
 Destructor.
 
virtual std::string getName () const =0
 Return the name of the task.
 
virtual void process ()=0
 Do the task job. Will be called from the task queue threads.
 

Detailed Description

An interface class representing a basic task. Tasks are basic processing units of the engine. Tasks are run in parallel on separate threads by the engine. The work of a task is defined by overriding its process() function.

Definition at line 13 of file Task.hpp.

Constructor & Destructor Documentation

◆ ~Task()

virtual Ra::Core::Task::~Task ( )
inlinevirtual

Destructor.

Definition at line 17 of file Task.hpp.

Member Function Documentation

◆ getName()

virtual std::string Ra::Core::Task::getName ( ) const
pure virtual

Return the name of the task.

Implemented in Ra::Core::FunctionTask.

◆ process()

virtual void Ra::Core::Task::process ( )
pure virtual

Do the task job. Will be called from the task queue threads.

Implemented in Ra::Core::FunctionTask.


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