xiiConstantProperty< Type > Class Template Reference

[internal] An implementation of xiiTypedConstantProperty that accesses the property data directly. More...

#include <ConstantProperty.h>

Inheritance diagram for xiiConstantProperty< Type >:

Public Member Functions
	xiiConstantProperty (xiiStringView sPropertyName, Type value)
	Constructor.
virtual void *	GetPropertyPointer () const override
	Returns a pointer to the member property.
virtual Type	GetValue () const override
	Returns the value of the property. Pass the instance pointer to the surrounding class along.
virtual xiiVariant	GetConstant () const override
	Returns the constant value as a xiiVariant.
Public Member Functions inherited from xiiTypedConstantProperty< Type >
	xiiTypedConstantProperty (xiiStringView sPropertyName)
	Passes the property name through to xiiAbstractMemberProperty.
virtual const xiiRTTI *	GetSpecificType () const override
	Returns the actual type of the property. You can then compare that with known types, eg. compare it to xiiGetStaticRTTI<int>() to see whether this is an int property.
Public Member Functions inherited from xiiAbstractConstantProperty
	xiiAbstractConstantProperty (xiiStringView sPropertyName)
	Passes the property name through to xiiAbstractProperty.
virtual xiiPropertyCategory::Enum	GetCategory () const override
	Returns xiiPropertyCategory::Constant.
Public Member Functions inherited from xiiAbstractProperty
	xiiAbstractProperty (xiiStringView sPropertyName)
	The constructor must get the name of the property. The string must be a compile-time constant.
xiiStringView	GetPropertyName () const
	Returns the name of the property.
const xiiBitflags< xiiPropertyFlags > &	GetFlags () const
	Returns the flags of the property.
xiiAbstractProperty *	AddFlags (xiiBitflags< xiiPropertyFlags > flags)
	Adds flags to the property. Returns itself to allow to be called during initialization.
xiiAbstractProperty *	AddAttributes (xiiPropertyAttribute *pAttrib1, xiiPropertyAttribute *pAttrib2=nullptr, xiiPropertyAttribute *pAttrib3=nullptr, xiiPropertyAttribute *pAttrib4=nullptr, xiiPropertyAttribute *pAttrib5=nullptr, xiiPropertyAttribute *pAttrib6=nullptr)
	Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
xiiArrayPtr< const xiiPropertyAttribute *const >	GetAttributes () const
	Returns the array of property attributes.
template<typename Type>
const Type *	GetAttributeByType () const
	Returns the first attribute that derives from the given type, or nullptr if nothing is found.

Additional Inherited Members
Protected Attributes inherited from xiiAbstractProperty
xiiBitflags< xiiPropertyFlags >	m_Flags
xiiStringView	m_sPropertyName
xiiHybridArray< const xiiPropertyAttribute *, 2U, xiiStaticAllocatorWrapper >	m_Attributes

Detailed Description

template<typename Type>
class xiiConstantProperty< Type >

[internal] An implementation of xiiTypedConstantProperty that accesses the property data directly.

Member Function Documentation

GetConstant()

template<typename Type>

virtual xiiVariant xiiConstantProperty< Type >::GetConstant ( ) const

inlineoverridevirtual

Returns the constant value as a xiiVariant.

Implements xiiAbstractConstantProperty.

GetPropertyPointer()

template<typename Type>

virtual void * xiiConstantProperty< Type >::GetPropertyPointer ( ) const

inlineoverridevirtual

Returns a pointer to the member property.

Implements xiiAbstractConstantProperty.

GetValue()

template<typename Type>

virtual Type xiiConstantProperty< Type >::GetValue ( ) const

inlineoverridevirtual

Returns the value of the property. Pass the instance pointer to the surrounding class along.

Implements xiiTypedConstantProperty< Type >.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/Reflection/Implementation/ConstantProperty.h