xentara::skill::DataPoint Class Reference

Base class for data points provided by a Xentara skill. More...

#include <xentara/skill/DataPoint.hpp>

Inheritance diagram for xentara::skill::DataPoint:

Public Member Functions
Callbacks for meta information about the element
virtual auto	dataType () const -> const data::DataType &=0
	Gets the data type.
virtual auto	directions () const -> io::Directions=0
	Gets the data directions supported by the data point.
Virtual Overrides for skill::Element
auto	category () const noexcept -> model::ElementCategory final
	Virtual overide for skill::Element::category()
Public Member Functions inherited from xentara::skill::Element
virtual	~Element ()=0
	Virtual destructor.
auto	name () const -> utils::string::StringView
	Gets the name of the element.
auto	primaryKey () const -> utils::string::StringView
	Gets the primary key of the element.
auto	uuid () const -> utils::core::Uuid
	Gets the UUID of the element.
auto	elementClass () const noexcept -> const Class &
	Gets the class of this element.
virtual auto	createChildElement (const Class &elementClass, ElementFactory &factory) -> std::shared_ptr< Element >
	Called by the framework to create a new child element of this element.
virtual auto	forEachAttribute (const model::ForEachAttributeFunction &function) const -> bool
	Called by the framework to iterate over all the attributes.
virtual auto	forEachEvent (const model::ForEachEventFunction &function) -> bool
	Called by the framework to iterate over all the events.
virtual auto	forEachTask (const model::ForEachTaskFunction &function) -> bool
	Called by the framework to iterate over all the tasks.
virtual auto	makeReadHandle (const model::Attribute &attribute) const noexcept -> std::optional< data::ReadHandle >
	Called by the framework to get a read handle for a specific attribute.
virtual auto	makeWriteHandle (const model::Attribute &attribute) noexcept -> std::optional< data::WriteHandle >
	Called by the framework to get a write handle for a specific attribute.
virtual auto	resolveAttributeByName (std::string_view name) const -> std::shared_ptr< const model::Attribute >
	Optional callback for optimized attribute lookup.
virtual auto	resolveAttributeByUuid (const utils::core::Uuid &uuid) const -> std::shared_ptr< const model::Attribute >
	Optional callback for optimized attribute lookup.
virtual auto	resolveEventByName (std::string_view name) -> std::shared_ptr< process::Event >
	Optional callback for optimized event lookup.
virtual auto	resolveEventByUuid (const utils::core::Uuid &uuid) -> std::shared_ptr< process::Event >
	Optional callback for optimized event lookup.
virtual auto	resolveTaskByName (std::string_view name) -> std::shared_ptr< process::Task >
	Optional callback for optimized task lookup.
virtual auto	resolveTaskByUuid (const utils::core::Uuid &uuid) -> std::shared_ptr< process::Task >
	Optional callback for optimized task lookup.
virtual auto	isAttributePending (std::string_view name) const noexcept -> bool
	Callback for determining whether an attribute is not available yet due to unresolved references.
virtual auto	isAttributePending (const utils::core::Uuid &uuid) const noexcept -> bool
	Callback for determining whether an attribute is not available yet due to unresolved references.
virtual auto	isEventPending (std::string_view name) const noexcept -> bool
	Callback for determining whether an event is not available yet due to unresolved references.
virtual auto	isEventPending (const utils::core::Uuid &uuid) const noexcept -> bool
	Callback for determining whether an event is not available yet due to unresolved references.
virtual auto	isTaskPending (std::string_view name) const noexcept -> bool
	Callback for determining whether a task is not available yet due to unresolved references.
virtual auto	isTaskPending (const utils::core::Uuid &uuid) const noexcept -> bool
	Callback for determining whether a task is not available yet due to unresolved references.
virtual auto	isMetadataPending () const noexcept -> bool
	Callback for determining whether meta information is not available yet due to unresolved references.
Public Member Functions inherited from xentara::utils::tools::DisableCopy
constexpr	DisableCopy () noexcept=default
	DisableCopy (const DisableCopy &)=delete
DisableCopy &	operator= (const DisableCopy &)=delete

Additional Inherited Members
Protected Member Functions inherited from xentara::skill::Element
auto	element () const noexcept -> const model::Element &
	Gets the Xentara element for this skill element.
auto	element () noexcept -> model::Element &
	Gets the Xentara element for this skill element.
auto	rootElement () const -> std::shared_ptr< const model::Element >
	Returns the invisible root element of the model this element belongs to.
auto	rootElement () -> std::shared_ptr< model::Element >
	Returns the invisible root element of the model this element belongs to.
auto	findAttribute (std::string_view primaryKey) -> model::ElementAttribute
	Finds the attribute with a specific primary key in the model this element belongs to.
auto	findAttributeVerbose (std::string_view primaryKey) -> utils::eh::expected< model::ElementAttribute, std::string >
	Finds the attribute with a specific primary key in the model this element belongs to, returning an error message on error.
auto	findEvent (std::string_view primaryKey) const -> std::shared_ptr< const process::Event >
	Finds the event with a specific primary key in the model this element belongs to.
auto	findEvent (std::string_view primaryKey) -> std::shared_ptr< process::Event >
	Finds the event with a specific primary key in the model this element belongs to.
auto	findEventVerbose (std::string_view primaryKey) const -> utils::eh::expected< std::shared_ptr< const process::Event >, std::string >
	Finds the event with a specific primary key in the model this element belongs to, returning an error message on error.
auto	findEventVerbose (std::string_view primaryKey) -> utils::eh::expected< std::shared_ptr< process::Event >, std::string >
	Finds the event with a specific primary key in the model this element belongs to, returning an error message on error.
auto	findExtendedEvent (std::string_view primaryKey) const -> process::ExtendedEvent
	Finds the extended event with a specific primary key in the model this element belongs to.
auto	findExtendedEventVerbose (std::string_view primaryKey) const -> utils::eh::expected< process::ExtendedEvent, std::string >
	Finds the extended event with a specific primary key in the model this element belongs to, returning an error message on error.
auto	findTask (std::string_view primaryKey) const -> std::shared_ptr< const process::Task >
	Finds the task with a specific primary key in the model this element belongs to.
auto	findTask (std::string_view primaryKey) -> std::shared_ptr< process::Task >
	Finds the task with a specific primary key in the model this element belongs to.
auto	findTaskVerbose (std::string_view primaryKey) const -> utils::eh::expected< std::shared_ptr< const process::Task >, std::string >
	Finds the task with a specific primary key in the model this element belongs to, returning an error message on error.
auto	findTaskVerbose (std::string_view primaryKey) -> utils::eh::expected< std::shared_ptr< process::Task >, std::string >
	Finds the task with a specific primary key in the model this element belongs to, returning an error message on error.
auto	findElement (std::string_view primaryKey) const -> std::shared_ptr< const model::Element >
	Finds the element with a specific primary key in the model this element belongs to.
auto	findElement (std::string_view primaryKey) -> std::shared_ptr< model::Element >
	Finds the element with a specific primary key in the model this element belongs to.
auto	findElementVerbose (std::string_view primaryKey) const -> utils::eh::expected< std::shared_ptr< const model::Element >, std::string >
	Finds the element with a specific primary key in the model this element belongs to, returning an error message on error.
auto	findElementVerbose (std::string_view primaryKey) -> utils::eh::expected< std::shared_ptr< model::Element >, std::string >
	Finds the element with a specific primary key in the model this element belongs to, returning an error message on error.
auto	findElement (const utils::core::Uuid &uuid) const -> std::shared_ptr< const model::Element >
	Finds the element with a specific UUID in the model this element belongs to.
auto	findElement (const utils::core::Uuid &uuid) -> std::shared_ptr< model::Element >
	Finds the element with a specific UUID in the model this element belongs to.
auto	securityContext () const -> const security::Context &
	Returns the security context of the element.
auto	checkAccess (const security::Authorization &authorization, const security::Entitlement &entitlement) const -> bool
	Checks an authorization for a certain entitlement using the ACL for this element.

Detailed Description

Base class for data points provided by a Xentara skill.

See also

Elements

Skill Data Points in the Xentara user manual

Member Function Documentation

category()

auto xentara::skill::DataPoint::category ( ) const -> model::ElementCategory

finalvirtualnoexcept

Virtual overide for skill::Element::category()

This function returns model::ElementCategory::DataPoint.

Implements xentara::skill::Element.

dataType()

virtual auto xentara::skill::DataPoint::dataType ( ) const -> const data::DataType &

pure virtual

Gets the data type.

Returns

The data type. This must correspond to the data type of the value attribute.

directions()

virtual auto xentara::skill::DataPoint::directions ( ) const -> io::Directions

pure virtual

Gets the data directions supported by the data point.

Returns

The data directions (input and/or output). This must correspond to the access type of the value attribute.