Functionality for accessing the Xentara model tree. More...

Classes
class	Attribute
	A description of a Xentara attribute. More...

class	AttributeReference
	A reference to an attribute of a Xentara element. More...

class	ChildElementAccessor
	A class that provides access to the child elements of an element. More...

class	Element
	A generic element within a Xentara model. More...

class	ElementReference
	A reference to a Xentara element. More...

Typedefs
using	ElementCategories = utils::core::Flags< ElementCategory >
	A combination of different element categories.

Enumerations
enum class	ElementCategory { RootElement , ElementGroup , DataPoint , Timer , ExecutionTrack , ExecutionPipeline , Device , SubDevice , DeviceGroup , DataPointGroup , Transaction , Microservice , AI , DataStorage , ExternalInterface , SpecialPurpose , CustomElement , internal }
	Different categories of Xentara elements. More...

Functions
template<utils::tools::CharType Char>
auto	toBasicString (ElementCategory category) -> std::basic_string_view< Char >
	Converts an element category value to a string.

auto	toString (ElementCategory category) -> std::string_view
	Converts an element category value to a string of type char

auto	toWString (ElementCategory category) -> std::wstring_view
	Converts an element category value to a string of type wchar_t

auto	toU8String (ElementCategory category) -> std::u8string_view
	Converts an element category value to a string of type char8_t

auto	toU16String (ElementCategory category) -> std::u16string_view
	Converts an element category value to a string of type char16_t

auto	toU32String (ElementCategory category) -> std::u32string_view
	Converts a number to a string of type char32_t

auto	operator<< (std::ostream &stream, ElementCategory category) -> std::ostream &
	Stream insertion operator for element categories.

Detailed Description

Functionality for accessing the Xentara model tree.

This namespace contains functionality for accessing Xentara elements in the Xentara model tree.

Typedef Documentation

◆ ElementCategories

using xentara::workbench::model::ElementCategories = typedef utils::core::Flags<ElementCategory>

A combination of different element categories.

Include file: #include <xentara/workbench/model/ElementCategory.hpp>

Enumeration Type Documentation

◆ ElementCategory

enum class xentara::workbench::model::ElementCategory

strong

Different categories of Xentara elements.

Include file: #include <xentara/workbench/model/ElementCategory.hpp>

Enumerator
RootElement	The invisible root element. The invisible root element is the parent element of all top-level elements in the model.
ElementGroup	An element group.
DataPoint	A data point or a skill data point.
Timer	A timer.
ExecutionTrack	An execution track.
ExecutionPipeline	An execution pipeline.
Device	A skill element representing a physical or virtual device. This includes external and internal hardware devices, and virtual devices like System health services or a Xentara Signal Generator.
SubDevice	A skill element representing a sub device of another device.
DeviceGroup	A skill element representing a group of related devices, like a serial port or network interface that can have multiple attached devices.
DataPointGroup	A skill element containing a group of related skill data points, like a structured variable in a PLC.
Transaction	A skill element representing a southbound or northbound data transcation, like for example an I/O transaction.
Microservice	A skill element representing a microservice, like an FMU or soft-PLC runtime, or any other sort of control logic.
AI	A skill element representing an artificial intelligence model or engine. This can be either an AI model running directly in the plugin, or an interface to an external AI system.
DataStorage	A skill element representing a data storage service, like an InfluxDB or clarify.io database.
ExternalInterface	A skill element providing a northbound interface, like a Xentara Web Service or a Xentara OPC UA Server. This also includes interfaces to other data services, like an MQTT broker, a Sparkplug application, or a UI or visualization tool.
SpecialPurpose	A skill element representing anything that does not fit into any of the other categories.
CustomElement	A custom element with unknown type.

Function Documentation

◆ operator<<()

auto xentara::workbench::model::operator<<	(	std::ostream &	stream,
		ElementCategory	category
	)		-> std::ostream &

Stream insertion operator for element categories.

Parameters

stream	The stream
category	The element category value

Returns: The stream

◆ toBasicString()

template<utils::tools::CharType Char>

auto xentara::workbench::model::toBasicString ( ElementCategory category ) -> std::basic_string_view< Char >

Converts an element category value to a string.

Parameters