xentara-plugin v1.2.1
The Xentara Plugin Framework
|
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... | |
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.
| 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.
| virtual |
Gets the name of the element class.
| noexcept |
Gets an array handle to the name of an element.
| noexcept |
Gets an array handle to the primary key of an element.
| virtual |
Gets the UUID of the element class.
| noexcept |
Gets an array handle to the UUID of an element.