Inheritance diagram for rfk::Variable:

Public Member Functions
REFUREKU_API	Variable (char const name, std::size_t id, Type const &type, void ptr, EVarFlags flags) noexcept

REFUREKU_API	Variable (char const name, std::size_t id, Type const &type, void const constPtr, EVarFlags flags) noexcept

REFUREKU_INTERNAL	Variable (Variable &&) noexcept

template<typename ValueType >
RFK_NODISCARD ValueType	get () const
	Get the value stored in this variable. This method in not safe if you provide a wrong ValueType. More...

template<typename ValueType >
void	set (ValueType &&value) const
	Set some value in this variable. This method is not safe if you provide a wrong ValueType. More...

REFUREKU_API void	set (void const *valuePtr, std::size_t valueSize) const
	Copy dataSize bytes starting from value into the variable. More...

RFK_NODISCARD REFUREKU_API bool	isStatic () const noexcept
	Check if this variable is static. More...

RFK_NODISCARD REFUREKU_API EVarFlags	getFlags () const noexcept
	Getter for the field _flags. More...

RFK_NODISCARD REFUREKU_API void *	getPtr () const
	Get a non-const pointer to this variable. Performing non-const operations with the pointer if the variable is const is undefined behaviour. More...

RFK_NODISCARD REFUREKU_API void const *	getConstPtr () const noexcept
	Get a const pointer to this static field. More...

Public Member Functions inherited from rfk::VariableBase
REFUREKU_API Type const &	getType () const noexcept
	Get the type of this variable. More...

Public Member Functions inherited from rfk::Entity
	Entity (Entity const &)=delete

RFK_NODISCARD REFUREKU_API Property const *	getPropertyAt (std::size_t propertyIndex) const noexcept
	Retrieve the property at the given index. If propertyIndex is greater or equal to the properties count, the behaviour is undefined. More...

template<typename PropertyType , typename = std::enable_if_t<std::is_base_of_v<Property, PropertyType> && !std::is_same_v<PropertyType, Property>>>
RFK_NODISCARD PropertyType const *	getProperty (bool isChildClassValid=true) const noexcept
	Retrieve a property of a given type from this entity. More...

RFK_NODISCARD REFUREKU_API Property const *	getProperty (Struct const &archetype, bool isChildClassValid=true) const noexcept
	Retrieve the first property matching with the provided archetype. More...

RFK_NODISCARD REFUREKU_API Property const *	getPropertyByName (char const *name) const noexcept
	Retrieve the first property named with the provided name. More...

RFK_NODISCARD REFUREKU_API Property const *	getPropertyByPredicate (Predicate< Property > predicate, void *userData) const
	Retrieve a property matching with a predicate. More...

template<typename PropertyType , typename = std::enable_if_t<std::is_base_of_v<Property, PropertyType> && !std::is_same_v<PropertyType, Property>>>
RFK_NODISCARD Vector< PropertyType const * >	getProperties (bool isChildClassValid=true) const noexcept
	Retrieve all properties matching with the provided archetype. If PropertyType uses multiple inheritance, its first inherited type must be rfk::Property or derived. More...

RFK_NODISCARD REFUREKU_API Vector< Property const * >	getProperties (Struct const &archetype, bool isChildClassValid=true) const noexcept
	Retrieve all properties matching with the provided archetype. More...

RFK_NODISCARD REFUREKU_API Vector< Property const * >	getPropertiesByName (char const *name) const noexcept
	Retrieve all properties named with the provided name. More...

RFK_NODISCARD REFUREKU_API Vector< Property const * >	getPropertiesByPredicate (Predicate< Property > predicate, void *userData) const
	Retrieve all properties matching with a predicate in this entity. More...

RFK_NODISCARD REFUREKU_API std::size_t	getPropertiesCount () const noexcept
	Get the number of properties attached to this entity. More...

REFUREKU_API bool	foreachProperty (Visitor< Property > visitor, void *userData) const
	Execute the given visitor on all properties attached to this entity. More...

RFK_NODISCARD REFUREKU_API char const *	getName () const noexcept
	Get the name of the entity. More...

RFK_NODISCARD REFUREKU_API bool	hasSameName (char const *name) const noexcept
	Check that this entity has the same name as the provided string. More...

RFK_NODISCARD REFUREKU_API std::size_t	getId () const noexcept
	Get the program-unique id of the entity. More...

RFK_NODISCARD REFUREKU_API EEntityKind	getKind () const noexcept
	Get the kind of the entity. Knowing the kind allows to safely cast to child classes. Check the EEntityKind documentation for more information. More...

RFK_NODISCARD REFUREKU_API Entity const *	getOuterEntity () const noexcept
	Get the outer entity of the entity. It basically corresponds to the entity this entity was declared in from a source-code point of view. A nullptr outer entity means the entity was declared at file level. More...

REFUREKU_API bool	addProperty (Property const &property) noexcept
	Add a property to this entity. More...

REFUREKU_API void	setOuterEntity (Entity const *outerEntity) noexcept
	Setter for the field _outerEntity. More...

REFUREKU_API void	setPropertiesCapacity (std::size_t capacity) noexcept
	Set the number of properties for this entity. Useful to avoid reallocations when adding a lot of properties. If the number of properties is already >= to the provided capacity, this method has no effect. More...

Entity &	operator= (Entity const &)=delete

Entity &	operator= (Entity &&)=delete

RFK_NODISCARD REFUREKU_API bool	operator== (Entity const &other) const noexcept

RFK_NODISCARD REFUREKU_API bool	operator!= (Entity const &other) const noexcept

Additional Inherited Members
Protected Member Functions inherited from rfk::VariableBase
REFUREKU_INTERNAL	VariableBase (VariableBaseImpl *implementation) noexcept

REFUREKU_INTERNAL	VariableBase (VariableBase &&) noexcept

template<typename ValueType >
RFK_NODISCARD ValueType	get (void *ptr) const
	Get the data stored in the provided ptr. This method in not safe if you provide a wrong DataType. More...

template<typename ValueType >
RFK_NODISCARD ValueType	get (void const *ptr) const
	Get the data stored in the provided ptr. This method in not safe if you provide a wrong DataType. Overload of the same method for const pointers. More...

template<typename ValueType >
void	set (void *ptr, ValueType &&value) const
	Set the provided pointer content. This method is not safe if you provide a wrong ValueType. More...

REFUREKU_INTERNAL void	set (void target, void const source, std::size_t bytesCount) const
	Copy dataSize bytes starting from data into the variable. More...

Protected Member Functions inherited from rfk::Entity
REFUREKU_INTERNAL	Entity (Entity &&) noexcept

REFUREKU_INTERNAL	Entity (EntityImpl *implementation) noexcept

Static Protected Member Functions inherited from rfk::VariableBase
RFK_NORETURN static REFUREKU_API void	throwConstViolationException (char const *message)
	Throw a ConstViolation exception with the specified message. /!\ This method is called from template methods so it must be exported. More...

Static Protected Attributes inherited from rfk::VariableBase
template<typename T >
static constexpr bool	is_value_v = !std::is_lvalue_reference_v<T> && !std::is_rvalue_reference_v<T>

Member Function Documentation

◆ get()

template<typename ValueType >

RFK_NODISCARD ValueType rfk::Variable::get ( ) const

Get the value stored in this variable. This method in not safe if you provide a wrong ValueType.

Template Parameters

ValueType Type of the value stored in the field. If ValueType is an rvalue reference, the value is moved into the return value (so the variable is no longer safe to get). If ValueType is an lvalue reference, return a reference to the variable. If ValueType is a value type, the value is copied. If it is a struct/class, ValueType must be copy-constructible.

Returns: The value stored in the variable.

Exceptions

ConstViolation

if:

the field is const and ValueType is an RValue type (can't move a const field content);
the field is const and ValueType is a non-const reference;

◆ getConstPtr()

RFK_NODISCARD REFUREKU_API void const * rfk::Variable::getConstPtr ( ) const

noexcept

Get a const pointer to this static field.

Returns: A const pointer to this static field.

◆ getFlags()

RFK_NODISCARD REFUREKU_API EVarFlags rfk::Variable::getFlags ( ) const

noexcept

Getter for the field _flags.

Returns: _flags.

◆ getPtr()

RFK_NODISCARD REFUREKU_API void * rfk::Variable::getPtr ( ) const

Get a non-const pointer to this variable. Performing non-const operations with the pointer if the variable is const is undefined behaviour.

Returns: A pointer to this static field.

Exceptions

ConstViolation if the variable is actually const.

◆ isStatic()

RFK_NODISCARD REFUREKU_API bool rfk::Variable::isStatic ( ) const

noexcept

Check if this variable is static.

Returns: true if the variable is static, else false.

◆ set() [1/2]

template<typename ValueType >

void rfk::Variable::set ( ValueType && value ) const

Set some value in this variable. This method is not safe if you provide a wrong ValueType.

Template Parameters

ValueType Type of the value to store in the variable. If ValueType is an rvalue reference, the value is forwarded into the variable. If ValueType is an lvalue reference, the value is copied into the variable.

Exceptions

ConstViolation if the variable is actually const and therefore readonly.

◆ set() [2/2]

REFUREKU_API void rfk::Variable::set	(	void const *	valuePtr,
		std::size_t	valueSize
	)		const

Copy dataSize bytes starting from value into the variable.

Parameters

valuePtr	Pointer to the value to copy.
valueSize	Number of bytes to copy into the variable.

Exceptions

ConstViolation if the variable is actually const and therefore readonly.

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

Refureku/Library/Include/Public/Refureku/TypeInfo/Variables/Variable.h

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ get()

◆ getConstPtr()

◆ getFlags()

◆ getPtr()

◆ isStatic()

◆ set() [1/2]

◆ set() [2/2]