XII Release 0.1.0
Loading...
Searching...
No Matches
xiiMemberProperty< Class, Type > Class Template Reference

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

#include <MemberProperty.h>

Inheritance diagram for xiiMemberProperty< Class, Type >:
[legend]

Public Types

using GetterFunc = Type (*)(const Class* pInstance)
using SetterFunc = void (*)(Class* pInstance, Type value)
using PointerFunc = void* (*)(const Class* pInstance)

Public Member Functions

 xiiMemberProperty (xiiStringView sPropertyName, GetterFunc getter, SetterFunc setter, PointerFunc pointer)
 Constructor.
virtual void * GetPropertyPointer (const void *pInstance) const override
 Returns a pointer to the member property.
virtual Type GetValue (const void *pInstance) const override
 Returns the value of the property. Pass the instance pointer to the surrounding class along.
virtual void SetValue (void *pInstance, Type value) const override
Public Member Functions inherited from xiiTypedMemberProperty< Type >
 xiiTypedMemberProperty (xiiStringView sPropertyName)
 Passes the property name through to xiiAbstractMemberProperty.
virtual const xiiRTTI * GetSpecificType () const override
virtual void GetValuePtr (const void *pInstance, void *pObject) const override
virtual void SetValuePtr (void *pInstance, const void *pObject) const override
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.
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.
virtual ~xiiAbstractProperty ()
 Copyright (c) Theophilus Eriata. All Rights Reserved.
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)
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 Class, typename Type>
class xiiMemberProperty< Class, Type >

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

Member Function Documentation

◆ GetPropertyPointer()

template<typename Class, typename Type>
virtual void * xiiMemberProperty< Class, Type >::GetPropertyPointer ( const void * pInstance) const
inlineoverridevirtual

Returns a pointer to the member property.

Implements xiiAbstractMemberProperty.

◆ GetValue()

template<typename Class, typename Type>
virtual Type xiiMemberProperty< Class, Type >::GetValue ( const void * pInstance) const
inlineoverridevirtual

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

Implements xiiTypedMemberProperty< Type >.

◆ SetValue()

template<typename Class, typename Type>
virtual void xiiMemberProperty< Class, Type >::SetValue ( void * pInstance,
Type value ) const
inlineoverridevirtual

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.

Implements xiiTypedMemberProperty< Type >.


The documentation for this class was generated from the following file:
  • /home/runner/work/XII/XII/Source/Engine/Foundation/Reflection/Implementation/MemberProperty.h