xentara-plugin v1.2.1
The Xentara Plugin Framework
Loading...
Searching...
No Matches
xentara::model::SubReference< Attribute > Class Referencefinal

A refrence to a specific attribute of a Xentara element. More...

#include <model/AttributeReference.hpp>

Public Member Functions

internal internal auto primaryKey () const -> std::string
 Gets the primary key of the attribute.
 
auto readHandle () const -> data::ReadHandle
 Gets a read handle for the attribute.
 
auto writeHandle () const -> data::WriteHandle
 Gets a write handle for the attribute.
 
auto xentara_cat_string () const -> __opaque_type__
 This is a helper function that enables using this class with utils::string::cat()
 

Detailed Description

A refrence to a specific attribute of a Xentara element.

See also
AttributeReference

Member Function Documentation

◆ primaryKey()

internal internal auto xentara::model::SubReference< Attribute >::primaryKey ( ) const -> std::string

Gets the primary key of the attribute.

Returns
The primary key of the attribute, in UTF-8 encoding, or an empty string for a default constructed object

◆ readHandle()

auto xentara::model::SubReference< Attribute >::readHandle ( ) const -> data::ReadHandle

Gets a read handle for the attribute.

◆ writeHandle()

auto xentara::model::SubReference< Attribute >::writeHandle ( ) const -> data::WriteHandle

Gets a write handle for the attribute.

◆ xentara_cat_string()

auto xentara::model::SubReference< Attribute >::xentara_cat_string ( ) const -> __opaque_type__

This is a helper function that enables using this class with utils::string::cat()

utils::string::cat() will insert the primary key of the attribute into the string.