xentara::model::Attribute::Role Class Reference

A built-in attribute role. More...

#include <xentara/model/Attribute.hpp>

Inheritance diagram for xentara::model::Attribute::Role:

Public Member Functions
	Role ()=delete
	Deleted constructor.
constexpr auto	name () const -> const std::string_view &
	Gets the name.
constexpr auto	uuid () const -> const utils::core::Uuid &
	Gets the UUID.
constexpr auto	ioDirections () const -> io::Directions
	Gets the relevant I/O directions.
template<utils::tools::EqualityComparableWithExcept< std::string_view, Role > String>
auto	operator== (const String &rhs) const -> bool
	Checks the name of the attribute role.
template<utils::tools::EqualityComparableWithExcept< utils::core::Uuid, Role > Uuid>
auto	operator== (const Uuid &rhs) const -> bool
	Checks the UUID of the attribute role.

Detailed Description

A built-in attribute role.

Attribute roles are used for attributes whose access and data type vary, but whose meaning is the same across elements.

Constructor & Destructor Documentation

Role()

xentara::model::Attribute::Role::Role ( )

delete

Deleted constructor.

This class is not user constructible.

Member Function Documentation

ioDirections()

constexpr auto xentara::model::Attribute::Role::ioDirections ( ) const -> io::Directions

constexpr

Gets the relevant I/O directions.

Returns

The I/O directions. The I/O directions are used for I/O attributes to specify whether a data point should inherit this attribute from its attached input and/or output.

name()

constexpr auto xentara::model::Attribute::Role::name ( ) const -> const std::string_view &

constexpr

Gets the name.

Returns

The name, in UTF-8 encoding

operator==() [1/2]

template<utils::tools::EqualityComparableWithExcept< std::string_view, Role > String>

auto xentara::model::Attribute::Role::operator==

(

const String &

rhs

)

const -> bool

Checks the name of the attribute role.

This is a convenience operator you can use to check the name of an attribute role. It is equivalent to name() == rhs.

Returns

Returns true if the attribute role has the given name.

operator==() [2/2]

template<utils::tools::EqualityComparableWithExcept< utils::core::Uuid, Role > Uuid>

auto xentara::model::Attribute::Role::operator==

(

const Uuid &

rhs

)

const -> bool

Checks the UUID of the attribute role.

This is a convenience operator you can use to check the UUID of an attribute role. It is equivalent to uuid() == rhs.

Returns

Returns true if the attribute role has the given UUID.

uuid()

constexpr auto xentara::model::Attribute::Role::uuid ( ) const -> const utils::core::Uuid &

constexpr

Gets the UUID.