PersistentClass::DescriptionHelper

template<typename T> class PersistentClass::DescriptionHelper : public Class::DescriptionHelper<T>

Helper class for Persistent reflection definitions.

Functions

ReflectConstructor

inline void ReflectConstructor() const

This function is available in the reflection definition. to register the default constructor as a factory. If this is not called, the class will be considered <Class.Abstract> for the purposes of reflection.

Calling this function requires (at compile time) a default constructor for the class.

Members

Properties

PropertyCollector Properties

Used to help register properties in a reflection definition.

For example, the following sample shows how to register three member variables, the first two are plain data such as ints or floats, the third has to be an array or a class that acts like std::vector.

The reflection definition is friended in DECLARE_REFLECTION to have private access to members.

Usage

namespace example {

class MyClass : public reflect::Persistent
{
    DECLARE_REFLECTION(reflect::Persistent)
private:
    int mX;
    reflect::String mY;
    std::vector<int> mThingVector;
};

}

DEFINE_REFLECTION(example::MyClass, "example::MyClass")
{
    ReflectConstructor();

    Properties
       ("x", &example::MyClass::mX)
           ["tooltip"]("left-right location")
       ("y", &example::MyClass::mY)
       ("things", &example::MyClass::mThingVector, Array)
           ["tooltip"]("up-down location")
           ["tooltip"]("up-down location")
       ;
    ...etc...
}

The [“key”](“value”) syntax can be used to register metadata about properties. They are not used by anything in reflect itself. They can be accessed by PropertyPath::Annotation.

The following is a list of the types of registration with the type of Property created.

(“name”, &MyClass::mVar)	DirectDataProperty
(“name”, &MyClass::GetVar, &MyClass::SetVar)	AccessorProperty
(“name”, &MyClass::GetVarRef, &MyClass::SetVarRef)	AccessorDirectProperty
(“name”, &MyClass::ReadVar, &MyClass::WriteVar)	AccessorIndirectProperty
(“name”, &MyClass::VarConst, &MyClass::Var)	AccessorAccessProperty
(“name”, &MyClass::mArrayVar, Array)	DirectArrayProperty
(“name”, &MyClass::mVectorVar, Array)	DirectVectorProperty
(“name”, &MyClass::mVar, Map)	DirectMapProperty
(“name”, &MyClass::ser_fun, &MyClass::deser_fun, Variant)	VariantProperty