xentara-workbench-plugin v1.0.1
The Xentara Workbench Plugin Framework
Loading...
Searching...
No Matches
xentara::workbench::process::Task Class Referencefinal

A description of a Xentara element task. More...

#include <xentara/workbench/process/Task.hpp>

Public Member Functions

template<std::convertible_to< std::string_view > Name>
 Task (Name &&name)
 Constructor.
 
 Task (std::string &&name)
 Constructor that moves a name from an existing std::string.
 
constexpr auto name () const noexcept -> std::string_view
 Gets the name.
 

Static Public Attributes

Standard Tasks
static const Task kReconnect
 The standard task for the reconnect task of an I/O component.
 

Detailed Description

A description of a Xentara element task.

Constructor & Destructor Documentation

◆ Task() [1/2]

template<std::convertible_to< std::string_view > Name>
xentara::workbench::process::Task::Task ( Name &&  name)
explicit

Constructor.

Parameters
nameThe name of the task, in UTF-8 encoding.

◆ Task() [2/2]

xentara::workbench::process::Task::Task ( std::string &&  name)
explicit

Constructor that moves a name from an existing std::string.

Parameters
nameThe name of the task, in UTF-8 encoding.

Member Function Documentation

◆ name()

constexpr auto xentara::workbench::process::Task::name ( ) const -> std::string_view
constexprnoexcept

Gets the name.

Returns
The name of the task, in UTF-8 encoding.

Member Data Documentation

◆ kReconnect

const Task xentara::workbench::process::Task::kReconnect
static

The standard task for the reconnect task of an I/O component.