Caelum::TypeDescriptor Class Reference

Abstract interface for a type descriptor. More...

#include <TypeDescriptor.h>

Inheritance diagram for Caelum::TypeDescriptor:

Public Types
typedef std::map< String, const ValuePropertyDescriptor * >	PropertyMap

Public Member Functions
virtual const ValuePropertyDescriptor *	getPropertyDescriptor (const Ogre::String &name) const =0
	Get a property descriptor; or null if not available. More...
virtual const std::vector< String >	getPropertyNames () const =0
	Get a map of all supported properties. More...
virtual const PropertyMap	getFullPropertyMap () const =0
	Get a map of all supported properties. More...

Detailed Description

Abstract interface for a type descriptor.

A type descriptor contains informations about the properties of another object. It provides access to a map of strings to ValuePropertyDescriptor. All methods are const.

This is not a full reflection mechanism; it doesn't care about methods and parameters. It's just a way to access object properties in a uniform way.

The list of properties supported by a type descriptor is fixed.

The type descriptor is responsible for the lifetime of ValuePropertyDescriptor objects; never the user.

Member Function Documentation

virtual const ValuePropertyDescriptor* Caelum::TypeDescriptor::getPropertyDescriptor ( const Ogre::String &  name ) const

pure virtual

Get a property descriptor; or null if not available.

Parameters

name	Name of the property to request.

Returns

A pointer to a property descriptor; or null if not available.

Implemented in Caelum::DefaultTypeDescriptor.

virtual const std::vector<String> Caelum::TypeDescriptor::getPropertyNames ( ) const

pure virtual

Get a map of all supported properties.

Returns a complete list of all supported properties; by value.

Implemented in Caelum::DefaultTypeDescriptor.

virtual const PropertyMap Caelum::TypeDescriptor::getFullPropertyMap ( ) const

pure virtual

Get a map of all supported properties.

Returns a complete list of all supported properties; by value.

Implemented in Caelum::DefaultTypeDescriptor.

---

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

• /home/pavel/workspace/ogre-caelum/main/include/TypeDescriptor.h