xentara::workbench::process::Event Class Reference

A description of a Xentara event. More...

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

Public Member Functions
template<std::convertible_to< std::string_view > Name>
	Event (Name &&name, io::Directions ioDirections={})
	Constructor.
	Event (std::string &&name, io::Directions ioDirections={})
	Constructor that moves a name from an existing std::string.
constexpr auto	name () const &noexcept -> std::string_view
	Gets the name.
constexpr auto	name () &&noexcept -> std::string &&
	Moves the name out of the event.
auto	ioDirections () const -> io::Directions
	Gets the relevant I/O directions.

Static Public Attributes
Standard Events
static const Event	kChanged
	The standard event for the change event of a data point.
static const Event	kConnected
	The standard event for the connection event of an I/O component.
static const Event	kDisconnected
	The standard event for the disconnection event of an I/O component.

Detailed Description

A description of a Xentara event.

Constructor & Destructor Documentation

Event() [1/2]

template<std::convertible_to< std::string_view > Name>

xentara::workbench::process::Event::Event ( Name &&  name, io::Directions  ioDirections = {}  )

explicit

Constructor.

Parameters

name	The name of the event, in UTF-8 encoding.
ioDirections	The I/O directions. The I/O directions are used for I/O events to specify whether a data point should inherit this event from its attached input and/or output.

Event() [2/2]

xentara::workbench::process::Event::Event ( std::string &&  name, io::Directions  ioDirections = {}  )

explicit

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

Parameters

name	The name of the event, in UTF-8 encoding.
ioDirections	The I/O directions. The I/O directions are used for I/O events to specify whether a data point should inherit this event from its attached input and/or output.

Member Function Documentation

ioDirections()

auto xentara::workbench::process::Event::ioDirections

(

)

const -> io::Directions

Gets the relevant I/O directions.

Returns

The I/O directions. The I/O directions are used for I/O events to specify whether a data point should inherit this event from its attached input and/or output.

name() [1/2]

constexpr auto xentara::workbench::process::Event::name ( ) && -> std::string &&

constexprnoexcept

Moves the name out of the event.

Returns

The name of the event, in UTF-8 encoding.

name() [2/2]

constexpr auto xentara::workbench::process::Event::name ( ) const & -> std::string_view

constexprnoexcept

Gets the name.

Returns

The name of the event, in UTF-8 encoding.

Member Data Documentation

kChanged

const Event xentara::workbench::process::Event::kChanged

static

The standard event for the change event of a data point.

kConnected

const Event xentara::workbench::process::Event::kConnected

static

The standard event for the connection event of an I/O component.

kDisconnected

const Event xentara::workbench::process::Event::kDisconnected

static

The standard event for the disconnection event of an I/O component.