plConstantProperty< Type > Class Template Reference

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

#include <ConstantProperty.h>

Inheritance diagram for plConstantProperty< Type >:

Public Member Functions
	plConstantProperty (const char *szPropertyName, 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 plVariant	GetConstant () const override
	Returns the constant value as an plVariant.
Public Member Functions inherited from plTypedConstantProperty< Type >
	plTypedConstantProperty (const char *szPropertyName)
	Passes the property name through to plAbstractMemberProperty.
virtual const plRTTI *	GetSpecificType () const override
	Returns the actual type of the property. You can then compare that with known types, eg. compare it to plGetStaticRTTI<int>() to see whether this is an int property.
Public Member Functions inherited from plAbstractConstantProperty
	plAbstractConstantProperty (const char *szPropertyName)
	Passes the property name through to plAbstractProperty.
virtual plPropertyCategory::Enum	GetCategory () const override
	Returns plPropertyCategory::Constant.
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.
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

template<typename Type>
class plConstantProperty< Type >

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

Member Function Documentation

GetConstant()

template<typename Type >

virtual plVariant plConstantProperty< Type >::GetConstant ( ) const

inlineoverridevirtual

Returns the constant value as an plVariant.

Implements plAbstractConstantProperty.

GetPropertyPointer()

template<typename Type >

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

inlineoverridevirtual

Returns a pointer to the member property.

Implements plAbstractConstantProperty.

GetValue()

template<typename Type >

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

inlineoverridevirtual

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

Implements plTypedConstantProperty< Type >.

---

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

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