Task graph interface for building a TaskGraphContext with Module tasks. More...

#include <TaskGraph.h>

Public Member Functions
template<std::invocable<> F>
auto	Add (size_t id, std::string_view name, F &&func, std::vector< size_t > predecessors={}, std::vector< size_t > successors={}) -> tf::Task
	Schedule a single task to run during a phase. More...

auto	Add (size_t id, std::string_view name, std::unique_ptr< tf::Taskflow > graph, std::vector< size_t > predecessors={}, std::vector< size_t > successors={}) -> tf::Task
	Schedule a tf::Taskflow to run during a phase. More...

void	StoreGraph (std::unique_ptr< tf::Taskflow > graph)
	Take ownership of a tf::Tasflow without scheduling anything. Useful for keeping alive Taskflows that are indirectly refenced in the TaskGraph.

auto	GetExceptionContext () noexcept -> ExceptionContext &
	Get the TaskGraph's ExceptionContext object.

Protected Member Functions
auto	Schedule (size_t id, tf::Task handle, std::vector< size_t > predecessors, std::vector< size_t > successors) -> tf::Task

template<std::invocable<> F>
auto	Emplace (std::string_view name, F &&func) -> tf::Task

auto	Emplace (std::string_view name, std::unique_ptr< tf::Taskflow > graph) -> tf::Task

Protected Attributes
std::unique_ptr< TaskGraphContext >	m_ctx

std::vector< Task >	m_tasks

Detailed Description

template<class Phase>
class nc::task::TaskGraph< Phase >

Task graph interface for building a TaskGraphContext with Module tasks.

Member Function Documentation

template<class Phase >

template<std::invocable<> F>

auto nc::task::TaskGraph< Phase >::Add	(	size_t	id,
		std::string_view	name,
		F &&	func,
		std::vector< size_t >	predecessors = `{}`,
		std::vector< size_t >	successors = `{}`
	)		-> tf::Task

inline

Schedule a single task to run during a phase.

Template Parameters

F	A callable of the form void(*)().

Parameters

id	A unique id for the task.
name	A user-friendly name for the task.
func	The callable to schedule.
predecessors	An optional list of task ids to be scheduled before the task.
successors	An optional list of task ids to be scheduled after the task.

Note: If func doesn't satisfy std::is_nothrow_invocable, it will be wrapped with a call to task::Guard().

template<class Phase >

auto nc::task::TaskGraph< Phase >::Add	(	size_t	id,
		std::string_view	name,
		std::unique_ptr< tf::Taskflow >	graph,
		std::vector< size_t >	predecessors = `{}`,
		std::vector< size_t >	successors = `{}`
	)		-> tf::Task

inline

Schedule a tf::Taskflow to run during a phase.

Parameters

id	A unique id for the task.
name	A user-friendly name for the task graph.
graph	The graph to be composed.
predecessors	An optional list of task ids to be scheduled before the task.
successors	An optional list of task ids to be scheduled after the task.

Note: Ensure exceptions cannot leak from the graph. Tasks may be wrapped with task::Guard() to delay throwing until execution has finished.

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