xentara::model Namespace Reference

Classes
class	Attribute
	A Xentara attribute. More...
class	Element
	A generic element within a Xentara model. More...
class	ElementAttribute
	A reference to an attribute of a specific Xentara element. More...
class	ForEachAttributeFunction
	A function object used to iterate over all the attributes of an element. More...
class	ForEachEventFunction
	A function object used to iterate over all the events of an element. More...
class	ForEachTaskFunction
	A function object used to iterate over all the tasks of an element. More...

Typedefs
using	ElementCategories = utils::core::Flags< ElementCategory >
	A combination of different element categories.
using	AttributeReference = model::ElementAttribute
	deprecated Deprecated alias for ElementAttribute
using	GenericElement = model::Element
	deprecated Deprecated alias for Element

Enumerations
enum class	ElementCategory {   RootElement , ElementGroup , DataPoint , Timer ,   ExecutionTrack , ExecutionPipeline , Device , SubDevice ,   DeviceGroup , DataPointGroup , Transaction , Microservice ,   AI , DataStorage , ExternalInterface , SpecialPurpose ,   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.
template auto	toBasicString< char > (ElementCategory category) -> std::basic_string_view< char >
template auto	toBasicString< wchar_t > (ElementCategory category) -> std::basic_string_view< wchar_t >
template auto	toBasicString< char8_t > (ElementCategory category) -> std::basic_string_view< char8_t >
template auto	toBasicString< char16_t > (ElementCategory category) -> std::basic_string_view< char16_t >
template auto	toBasicString< char32_t > (ElementCategory category) -> std::basic_string_view< char32_t >
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.
auto	operator<< (utils::cbor::Encoder &encoder, ElementCategory category) -> utils::cbor::Encoder &
	Encodes an element category to a CBOR encoder.
auto	operator>> (utils::cbor::Decoder &decoder, ElementCategory &category) -> utils::cbor::Decoder &
	Decodes an element category from a CBOR encoder.

Typedef Documentation

AttributeReference

using xentara::model::AttributeReference = typedef model::ElementAttribute

deprecated Deprecated alias for ElementAttribute

Deprecated:

Renamed to ElementAttribute

ElementCategories

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

A combination of different element categories.

Include file

#include <xentara/model/ElementCategory.hpp>

GenericElement

using xentara::model::GenericElement = typedef model::Element

deprecated Deprecated alias for Element

Deprecated:

Renamed to Element

Enumeration Type Documentation

ElementCategory

enum class xentara::model::ElementCategory

strong

Different categories of Xentara elements.

Include file

#include <xentara/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.

Function Documentation

operator<<() [1/2]

auto xentara::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

operator<<() [2/2]

auto xentara::model::operator<<	(	utils::cbor::Encoder &	encoder,
		ElementCategory	category
	)		-> utils::cbor::Encoder &

Encodes an element category to a CBOR encoder.

Parameters

encoder	The encoder
category	The element category

Returns

A reference to the encoder

operator>>()

auto xentara::model::operator>>	(	utils::cbor::Decoder &	decoder,
		ElementCategory &	category
	)		-> utils::cbor::Decoder &

Decodes an element category from a CBOR encoder.

Parameters

decoder	The decoder
category	The element category

Returns

A reference to the decoder

toBasicString()

template<utils::tools::CharType Char>

auto xentara::model::toBasicString

(

ElementCategory

category

)

-> std::basic_string_view< Char >

Converts an element category value to a string.

Parameters

category

The element category value

Returns

A string containing the element category as a UTF-8 text

toBasicString< char >()

template auto xentara::model::toBasicString< char > ( ElementCategory  category ) -> std::basic_string_view< char >

extern

toBasicString< char16_t >()

template auto xentara::model::toBasicString< char16_t > ( ElementCategory  category ) -> std::basic_string_view< char16_t >

extern

toBasicString< char32_t >()

template auto xentara::model::toBasicString< char32_t > ( ElementCategory  category ) -> std::basic_string_view< char32_t >

extern

toBasicString< char8_t >()

template auto xentara::model::toBasicString< char8_t > ( ElementCategory  category ) -> std::basic_string_view< char8_t >

extern

toBasicString< wchar_t >()

template auto xentara::model::toBasicString< wchar_t > ( ElementCategory  category ) -> std::basic_string_view< wchar_t >

extern

toString()

auto xentara::model::toString

(

ElementCategory

category

)

-> std::string_view

Converts an element category value to a string of type char

Parameters

category

The element category value

Returns

A string containing the element category

toU16String()

auto xentara::model::toU16String

(

ElementCategory

category

)

-> std::u16string_view

Converts an element category value to a string of type char16_t

Parameters

category

The element category value

Returns

A string containing the element category

toU32String()

auto xentara::model::toU32String

(

ElementCategory

category

)

-> std::u32string_view

Converts a number to a string of type char32_t

Parameters

category

The element category value

Returns

A string containing the element category

toU8String()

auto xentara::model::toU8String

(

ElementCategory

category

)

-> std::u8string_view

Converts an element category value to a string of type char8_t

Parameters

category

The element category value

Returns

A string containing the element category

toWString()

auto xentara::model::toWString

(

ElementCategory

category

)

-> std::wstring_view

Converts an element category value to a string of type wchar_t

Parameters

category

The element category value

Returns

A string containing the element category