engine-mk1
Public Member Functions | Public Attributes | List of all members
rz::taskscheduler::Task Struct Reference

A data structure for representing a Task. More...

#include <TaskScheduler.hpp>

Public Member Functions

bool operator== (const Task &rhs) const noexcept
 Basic equality comparator. More...
 

Public Attributes

std::size_t taskID {}
 The ID of this Task. More...
 
std::size_t parentID {}
 The parents Task ID. More...
 
std::size_t dependencyID {}
 The ID of the Task that must finish as a prerequisite. More...
 
WorkFunc work {}
 The work function to run. More...
 
std::size_t openWorkItems {}
 The remaing work items equal to N+1 where N is the number of children Tasks. More...
 

Detailed Description

A data structure for representing a Task.

Member Function Documentation

bool rz::taskscheduler::Task::operator== ( const Task rhs) const
inlinenoexcept

Basic equality comparator.

Member Data Documentation

std::size_t rz::taskscheduler::Task::dependencyID {}

The ID of the Task that must finish as a prerequisite.

std::size_t rz::taskscheduler::Task::openWorkItems {}

The remaing work items equal to N+1 where N is the number of children Tasks.

std::size_t rz::taskscheduler::Task::parentID {}

The parents Task ID.

std::size_t rz::taskscheduler::Task::taskID {}

The ID of this Task.

WorkFunc rz::taskscheduler::Task::work {}

The work function to run.


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