plAbstractConstantProperty Class Reference

This is the base class for all constant properties that are stored inside the RTTI data. More...

#include <AbstractProperty.h>

Inheritance diagram for plAbstractConstantProperty:

Public Member Functions
	plAbstractConstantProperty (const char *szPropertyName)
	Passes the property name through to plAbstractProperty.
virtual plPropertyCategory::Enum	GetCategory () const override
	Returns plPropertyCategory::Constant.
virtual void *	GetPropertyPointer () const =0
	Returns a pointer to the constant data or nullptr. See plAbstractMemberProperty::GetPropertyPointer for more information.
virtual plVariant	GetConstant () const =0
	Returns the constant value as an plVariant.
Public Member Functions inherited from plAbstractProperty
	plAbstractProperty (const char *szPropertyName)
	The constructor must get the name of the property. The string must be a compile-time constant.
const char *	GetPropertyName () const
	Returns the name of the property.
virtual const plRTTI *	GetSpecificType () const =0
	Returns the type information of the constant property. Use this to cast this property to a specific version of plTypedConstantProperty.
const plBitflags< plPropertyFlags > &	GetFlags () const
	Returns the flags of the property.
plAbstractProperty *	AddFlags (plBitflags< plPropertyFlags > flags)
	Adds flags to the property. Returns itself to allow to be called during initialization.
plAbstractProperty *	AddAttributes (plPropertyAttribute *pAttrib1, plPropertyAttribute *pAttrib2=nullptr, plPropertyAttribute *pAttrib3=nullptr, plPropertyAttribute *pAttrib4=nullptr, plPropertyAttribute *pAttrib5=nullptr, plPropertyAttribute *pAttrib6=nullptr)
	Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
plArrayPtr< const plPropertyAttribute *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 plAbstractProperty
plBitflags< plPropertyFlags >	m_Flags
const char *	m_szPropertyName
plHybridArray< const plPropertyAttribute *, 2, plStaticsAllocatorWrapper >	m_Attributes

Detailed Description

This is the base class for all constant properties that are stored inside the RTTI data.

Member Function Documentation

GetCategory()

virtual plPropertyCategory::Enum plAbstractConstantProperty::GetCategory ( ) const

inlineoverridevirtual

Returns plPropertyCategory::Constant.

Implements plAbstractProperty.

GetConstant()

virtual plVariant plAbstractConstantProperty::GetConstant ( ) const

pure virtual

Returns the constant value as an plVariant.

Implemented in plConstantProperty< Type >, and plPhantomConstantProperty.

GetPropertyPointer()

virtual void * plAbstractConstantProperty::GetPropertyPointer ( ) const

pure virtual

Returns a pointer to the constant data or nullptr. See plAbstractMemberProperty::GetPropertyPointer for more information.

Implemented in plConstantProperty< Type >, and plPhantomConstantProperty.

---

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

• Code/Engine/Foundation/Reflection/Implementation/AbstractProperty.h