xiiAbstractArrayProperty Class Reference

The base class for a property that represents an array of values. More...

#include <AbstractProperty.h>

Inheritance diagram for xiiAbstractArrayProperty:

Public Member Functions
	xiiAbstractArrayProperty (xiiStringView sPropertyName)
	Passes the property name through to xiiAbstractProperty.
virtual xiiPropertyCategory::Enum	GetCategory () const override
	Returns xiiPropertyCategory::Array.
virtual xiiUInt32	GetCount (const void *pInstance) const =0
	Returns number of elements.
virtual void	GetValue (const void *pInstance, xiiUInt32 uiIndex, void *pObject) const =0
	Writes element at index uiIndex to the target of pObject.
virtual void	SetValue (void *pInstance, xiiUInt32 uiIndex, const void *pObject) const =0
	Writes the target of pObject to the element at index uiIndex.
virtual void	Insert (void *pInstance, xiiUInt32 uiIndex, const void *pObject) const =0
	Inserts the target of pObject into the array at index uiIndex.
virtual void	Remove (void *pInstance, xiiUInt32 uiIndex) const =0
	Removes the element in the array at index uiIndex.
virtual void	Clear (void *pInstance) const =0
	Clears the array.
virtual void	SetCount (void *pInstance, xiiUInt32 uiCount) const =0
	Resizes the array to uiCount.
virtual void *	GetValuePointer (void *pInstance, xiiUInt32 uiIndex) const
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.
virtual const xiiRTTI *	GetSpecificType () const =0
	Returns the type information of the constant property. Use this to cast this property to a specific version of xiiTypedConstantProperty.
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

The base class for a property that represents an array of values.

Member Function Documentation

Clear()

virtual void xiiAbstractArrayProperty::Clear ( void * pInstance ) const

pure virtual

Clears the array.

Implemented in xiiAccessorArrayProperty< Class, Type >, xiiMemberArrayProperty< Class, Container, Type >, xiiMemberArrayReadOnlyProperty< Class, Container, Type >, and xiiPhantomArrayProperty.

GetCategory()

virtual xiiPropertyCategory::Enum xiiAbstractArrayProperty::GetCategory ( ) const

inlineoverridevirtual

Returns xiiPropertyCategory::Array.

Implements xiiAbstractProperty.

GetCount()

virtual xiiUInt32 xiiAbstractArrayProperty::GetCount ( const void * pInstance ) const

pure virtual

Returns number of elements.

Implemented in xiiAccessorArrayProperty< Class, Type >, xiiMemberArrayProperty< Class, Container, Type >, xiiMemberArrayReadOnlyProperty< Class, Container, Type >, and xiiPhantomArrayProperty.

GetValue()

virtual void xiiAbstractArrayProperty::GetValue ( const void * pInstance, xiiUInt32 uiIndex, void * pObject ) const

pure virtual

Writes element at index uiIndex to the target of pObject.

Implemented in xiiAccessorArrayProperty< Class, Type >, xiiMemberArrayProperty< Class, Container, Type >, xiiMemberArrayReadOnlyProperty< Class, Container, Type >, and xiiPhantomArrayProperty.

Insert()

virtual void xiiAbstractArrayProperty::Insert ( void * pInstance, xiiUInt32 uiIndex, const void * pObject ) const

pure virtual

Inserts the target of pObject into the array at index uiIndex.

Implemented in xiiAccessorArrayProperty< Class, Type >, xiiMemberArrayProperty< Class, Container, Type >, xiiMemberArrayReadOnlyProperty< Class, Container, Type >, and xiiPhantomArrayProperty.

Remove()

virtual void xiiAbstractArrayProperty::Remove ( void * pInstance, xiiUInt32 uiIndex ) const

pure virtual

Removes the element in the array at index uiIndex.

Implemented in xiiAccessorArrayProperty< Class, Type >, xiiMemberArrayProperty< Class, Container, Type >, xiiMemberArrayReadOnlyProperty< Class, Container, Type >, and xiiPhantomArrayProperty.

SetCount()

virtual void xiiAbstractArrayProperty::SetCount ( void * pInstance, xiiUInt32 uiCount ) const

pure virtual

Resizes the array to uiCount.

Implemented in xiiAccessorArrayProperty< Class, Type >, xiiMemberArrayProperty< Class, Container, Type >, xiiMemberArrayReadOnlyProperty< Class, Container, Type >, and xiiPhantomArrayProperty.

SetValue()

virtual void xiiAbstractArrayProperty::SetValue ( void * pInstance, xiiUInt32 uiIndex, const void * pObject ) const

pure virtual

Writes the target of pObject to the element at index uiIndex.

Implemented in xiiAccessorArrayProperty< Class, Type >, xiiMemberArrayProperty< Class, Container, Type >, xiiMemberArrayReadOnlyProperty< Class, Container, Type >, and xiiPhantomArrayProperty.

---

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

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