xentara-plugin v1.2.1
The Xentara Plugin Framework
Loading...
Searching...
No Matches
Plugin Element Classes

Common interface shared by all plugin element class classes. More...

Public Member Functions

virtual auto  name() const -> std::string_view
 Gets the name of the element class. More...
 
virtual auto  uuid() const -> xentara::utils::core::Uuid
 Gets the UUID of the element class. More...
 
auto  nameHandle() const noexcept -> xentara::memory::Array::ObjectHandle< std::string >
 Gets an array handle to the name of an element. More...
 
auto  primaryKeyHandle() const noexcept -> xentara::memory::Array::ObjectHandle< std::string >
 Gets an array handle to the primary key of an element. More...
 
auto  uuidHandle() const noexcept -> xentara::memory::Array::ObjectHandle< xentara::utils::core::Uuid >
 Gets an array handle to the UUID of an element. More...
 

Protected Member Functions

auto  config () -> xentara::memory::Array &
 Called by the framework to load the element's configuration from a JSON object. More...
 

Detailed Description

Common interface shared by all plugin element class classes.

This documentation describes the common interface shared by all plugin element class classes. See the individual classes for more detailed information.

Versions
xentara::io::ComponentClass
xentara::io::IoClass
xentara::io::IoBatchClass
xentara::process::MicroserviceClass
See also
Plugin Entities

Member Function Documentation

◆  config()

auto ElementClass::config ( ) -> xentara::memory::Array &
protected

Gets the array object used for the configuration attributes.

This function returns the object that the framework will be using to allocate the memory block that contains the configuration attributes. You can call this function in the constructor to add confioguration attributes of your own.

You do not need to add the entire configuration of the entities to this array, only the configuration parameters you intend to publish as Xentara attributes.

Versions
xentara::io::ComponentClass::config()
xentara::io::IoClass::config()
xentara::io::IoBatchClass::config()
xentara::process::MicroserviceClass::config()
See also
Publishing Config Parameters as Xentara Attributes

◆  name()

virtual auto ElementClass::name ( ) const -> std::string_view
virtual

Gets the name of the element class.

Returns
The name of the class, in UTF-8 encoding.
Versions
xentara::io::ComponentClass::name()
xentara::io::IoClass::name()
xentara::io::IoBatchClass::name()
xentara::process::MicroserviceClass::name()

◆  nameHandle()

auto ElementClass::nameHandle ( ) const -> xentara::memory::Array::ObjectHandle< std::string >
noexcept

Gets an array handle to the name of an element.

Note
Since the name of the element is part of its configuration, the returned handle should only be used once the element’s configuration has been fully loaded.
Returns
A handle to the element’s name in UTF-8 encoding.
Versions
xentara::io::ComponentClass::nameHandle()
xentara::io::IoClass::nameHandle()
xentara::io::IoBatchClass::nameHandle()
xentara::process::MicroserviceClass::nameHandle()

◆  primaryKeyHandle()

auto ElementClass::primaryKeyHandle ( ) const -> xentara::memory::Array::ObjectHandle< std::string >
noexcept

Gets an array handle to the primary key of an element.

Note
Since the primary key is only fully known once the configuration has been completely loaded, the returned handle should not be used to get the element’s key during loading. Specifically, the returned handle should not be used from within loadConfig().
Returns
A handle to the element’s primary key in UTF-8 encoding.
Versions
xentara::io::ComponentClass::primaryKeyHandle()
xentara::io::IoClass::primaryKeyHandle()
xentara::io::IoBatchClass::primaryKeyHandle()
xentara::process::MicroserviceClass::primaryKeyHandle()

◆  uuid()

◆  uuidHandle()

auto ElementClass::uuidHandle ( ) const -> xentara::memory::Array::ObjectHandle< xentara::utils::core::Uuid >
noexcept

Gets an array handle to the UUID of an element.

Note
Since the UUID of the element is part of its configuration, this function should only be called once the element’s configuration has been fully loaded.
Versions
xentara::io::ComponentClass::uuidHandle()
xentara::io::IoClass::uuidHandle()
xentara::io::IoBatchClass::uuidHandle()
xentara::process::MicroserviceClass::uuidHandle()