xiiTypedMemberProperty< Type > Class Template Reference

The base class for all typed member properties. I.e. once the type of a property is determined, it can be cast to the proper version of this. More...

#include <MemberProperty.h>

Inheritance diagram for xiiTypedMemberProperty< Type >:

Public Member Functions
	xiiTypedMemberProperty (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.
virtual Type	GetValue (const void *pInstance) const =0
	Returns the value of the property. Pass the instance pointer to the surrounding class along.
virtual void	SetValue (void *pInstance, Type value) const =0
	Modifies the value of the property. Pass the instance pointer to the surrounding class along.
virtual void	GetValuePtr (const void *pInstance, void *pObject) const override
	Writes the value of this property in pInstance to pObject. pObject needs to point to an instance of this property's type.
virtual void	SetValuePtr (void *pInstance, const void *pObject) const override
	Sets the value of pObject to the property in pInstance. pObject needs to point to an instance of this property's type.
Public Member Functions inherited from xiiAbstractMemberProperty
	xiiAbstractMemberProperty (xiiStringView sPropertyName)
	Passes the property name through to xiiAbstractProperty.
virtual xiiPropertyCategory::Enum	GetCategory () const override
	Returns xiiPropertyCategory::Member.
virtual void *	GetPropertyPointer (const void *pInstance) const =0
	Returns a pointer to the property data or nullptr. If a valid pointer is returned, that pointer and the information from GetSpecificType() can be used to step deeper into the type (if required).
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 xiiTypedMemberProperty< Type >

The base class for all typed member properties. I.e. once the type of a property is determined, it can be cast to the proper version of this.

For example, when you have a pointer to a xiiAbstractMemberProperty and it returns that the property is of type 'int', you can cast the pointer to an pointer to xiiTypedMemberProperty<int> which then allows you to access its values.

Member Function Documentation

GetSpecificType()

template<typename Type>

virtual const xiiRTTI * xiiTypedMemberProperty< Type >::GetSpecificType ( ) const

inlineoverridevirtual

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.

Implements xiiAbstractProperty.

GetValue()

template<typename Type>

virtual Type xiiTypedMemberProperty< Type >::GetValue ( const void * pInstance ) const

pure virtual

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

Implemented in xiiAccessorProperty< Class, Type >, xiiMemberProperty< Class, Type >, and xiiResourceAccessorProperty< Class, Type >.

GetValuePtr()

template<typename Type>

virtual void xiiTypedMemberProperty< Type >::GetValuePtr ( const void * pInstance, void * out_pObject ) const

inlineoverridevirtual

Writes the value of this property in pInstance to pObject. pObject needs to point to an instance of this property's type.

Implements xiiAbstractMemberProperty.

SetValue()

template<typename Type>

virtual void xiiTypedMemberProperty< Type >::SetValue ( void * pInstance, Type value ) const

pure virtual

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

Note

Make sure the property is not read-only before calling this, otherwise an assert will fire.

Implemented in xiiMemberProperty< Class, Type >, and xiiResourceAccessorProperty< Class, Type >.

SetValuePtr()

template<typename Type>

virtual void xiiTypedMemberProperty< Type >::SetValuePtr ( void * pInstance, const void * pObject ) const

inlineoverridevirtual

Sets the value of pObject to the property in pInstance. pObject needs to point to an instance of this property's type.

Implements xiiAbstractMemberProperty.

---

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

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