PropertyNodeInfo Class Reference

#include <serialization/PropertyNode.h>

Inheritance diagram for PropertyNodeInfo:

Public Member Functions
	PropertyNodeInfo ()
	PropertyNodeInfo (const std::string &id, const std::string &name, const std::string &comment, const Typename &type, bool isReadOnly, bool isVolatile)
	PropertyNodeInfo (const PropertyNodeInfo &info)
PropertyNodeInfo &	operator= (const PropertyNodeInfo &info)
template<typename Reflector >
void	reflectCommon (Reflector &r)
template<typename Reflector >
void	reflectRead (Reflector &r)
template<typename Reflector >
void	reflectWrite (Reflector &r)
const std::string &	id () const
	Returns the unique id of this property. More...
const std::string &	name () const
	Returns the name of this property as specified in the reflect() method. More...
const std::string &	comment () const
	Returns the comment that is associated with this property. More...
const Typename &	type () const
	Returns the type of this property as Typename. More...
template<typename T >
T	getHint (const std::string &attribute, const T &defaultValue=T()) const
	Returns the specified value for the given property hint attribute. More...
bool	hasHint (const std::string &attribute) const
	Returns true if a hint with the specified attribute exists. More...
bool	isReadOnly () const
	Returns true, if this property is read-only and hence, can not be modified. More...
bool	isVolatile () const
	Returns true, if this property is volatile and hence, must be locked for access. More...
void	setName (const std::string &name)
	For internal use by PropertySerializer only: Overrides the name of the property. More...

Protected Attributes
std::string	mID
	the unique id of the property More...
std::string	mName
	the name of the property (mostly equal to mID) More...
std::string	mComment
	the comment that is associated to the property More...
PropertyHint	mHint
	the specified property hints More...
Typename	mType
	the type of the property More...
bool	mIsReadOnly
	indicates whether the property is read-only More...
bool	mIsVolatile
	indicates whether the property is volatile More...

Constructor & Destructor Documentation

PropertyNodeInfo() [1/3]

PropertyNodeInfo ( )

inline

PropertyNodeInfo() [2/3]

PropertyNodeInfo ( const std::string &  id, const std::string &  name, const std::string &  comment, const Typename &  type, bool  isReadOnly, bool  isVolatile  )

inline

PropertyNodeInfo() [3/3]

PropertyNodeInfo ( const PropertyNodeInfo &  info )

inline

Member Function Documentation

operator=()

PropertyNodeInfo& operator= ( const PropertyNodeInfo &  info )

inline

reflectCommon()

void reflectCommon ( Reflector &  r )

inline

reflectRead()

void reflectRead ( Reflector &  r )

inline

reflectWrite()

void reflectWrite ( Reflector &  r )

inline

id()

const std::string& id ( ) const

inline

Returns the unique id of this property.

name()

const std::string& name ( ) const

inline

Returns the name of this property as specified in the reflect() method.

comment()

const std::string& comment ( ) const

inline

Returns the comment that is associated with this property.

type()

const Typename& type ( ) const

inline

Returns the type of this property as Typename.

getHint()

T getHint ( const std::string &  attribute, const T &  defaultValue = T()  ) const

inline

Returns the specified value for the given property hint attribute.

If no such attribute is set in this hint, then the defaultValue is returned.

hasHint()

bool hasHint ( const std::string &  attribute ) const

inline

Returns true if a hint with the specified attribute exists.

isReadOnly()

bool isReadOnly ( ) const

inline

Returns true, if this property is read-only and hence, can not be modified.

isVolatile()

bool isVolatile ( ) const

inline

Returns true, if this property is volatile and hence, must be locked for access.

setName()

void setName ( const std::string &  name )

inline

For internal use by PropertySerializer only: Overrides the name of the property.

Member Data Documentation

mID

std::string mID

protected

the unique id of the property

mName

std::string mName

protected

the name of the property (mostly equal to mID)

mComment

std::string mComment

protected

the comment that is associated to the property

mHint

PropertyHint mHint

protected

the specified property hints

mType

Typename mType

protected

the type of the property

mIsReadOnly

bool mIsReadOnly

protected

indicates whether the property is read-only

mIsVolatile

bool mIsVolatile

protected

indicates whether the property is volatile

---

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

• base/include/serialization/PropertyNode.h