transwarp
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Friends | List of all members
transwarp::node Class Reference

A node carrying meta-data of a task. More...

#include <transwarp.h>

Public Member Functions

 node (const node &)=delete
 
nodeoperator= (const node &)=delete
 
 node (node &&)=delete
 
nodeoperator= (node &&)=delete
 
std::unique_ptr< nodeclone () const
 Clones this node.
 
std::size_t id () const noexcept
 The task ID.
 
std::size_t level () const noexcept
 The task level.
 
transwarp::task_type type () const noexcept
 The task type.
 
const std::optional
< std::string > & 
name () const noexcept
 The optional task name.
 
const std::optional
< std::string > & 
executor () const noexcept
 The optional, task-specific executor.
 
const std::vector
< std::shared_ptr< node > > & 
parents () const noexcept
 The task's parents (may be empty)
 
std::int64_t priority () const noexcept
 The task priority (defaults to 0)
 
const std::any & custom_data () const noexcept
 The custom task data (may not hold a value)
 
bool canceled () const noexcept
 Returns whether the associated task is canceled.
 
std::int64_t avg_idletime_us () const noexcept
 Returns the average idletime in microseconds (-1 if never set)
 
std::int64_t avg_waittime_us () const noexcept
 Returns the average waittime in microseconds (-1 if never set)
 
std::int64_t avg_runtime_us () const noexcept
 Returns the average runtime in microseconds (-1 if never set)
 

Friends

struct transwarp::detail::node_manip
 

Detailed Description

A node carrying meta-data of a task.


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