xronos::sdk::Element Class Reference

Base class for all reactor elements. More...

#include <xronos/sdk/element.hh>

Inheritance diagram for xronos::sdk::Element:

Public Member Functions
auto	name () const noexcept -> const std::string &
	The name of the current element.
auto	fqn () const noexcept -> const std::string &
	The fully qualified name of the current element.
virtual	~Element ()=default
	Virtual destructor.

Detailed Description

Base class for all reactor elements.

Reactor elements are objects that can be contained by reactors and that have special meaning to the Xronos framework.

Member Function Documentation

name()

auto xronos::sdk::Element::name ( ) const -> const std::string &

nodiscardnoexcept

The name of the current element.

A name should be unique within the current reactor and should contain only word characters (alphanumeric and underscore).

Returns

The current element's name.

fqn()

auto xronos::sdk::Element::fqn ( ) const -> const std::string &

nodiscardnoexcept

The fully qualified name of the current element.

This should be globally unique and is computed as the "."-separated concatenation of the all parent reactors, starting from the top-level environment, followed by the current element's name.

Returns

The current element's fully qualified name.

---

The documentation for this class was generated from the following file:

• sdk/element.hh