Public Types | Public Member Functions | Protected Attributes

Onyx::Properties::DefaultProperty Class Reference

Abstract class for Properties that have a default value. More...

#include <DefaultProperty.h>

Inheritance diagram for Onyx::Properties::DefaultProperty:
Onyx::Properties::PropertyBase Onyx::Properties::ClassProperty Onyx::Properties::SimpleDefaultProperty Onyx::Properties::ClassMemberProperty< T > Onyx::Properties::SimpleClassProperty

Public Types

typedef Poco::SharedPtr
< DefaultProperty
Ptr
 Typedef for shared pointers.

Public Member Functions

 DefaultProperty (const DefaultProperty &other)
 Copy constructor.
 DefaultProperty (const std::string &propName, const std::string &groupName="", const Poco::DynamicAny &dValue=0, const bool &validateAll=true)
 Default constructor, essentially the same as the PropertyBase constructor.
const Poco::DynamicAny & getDefaultValue () const
 Get the default value of the Property.
void resetValue ()
 Reset the Property's value to default.
void setDefaultValue (const Poco::DynamicAny &defaultValue)
 Set the Property's default value.
virtual ~DefaultProperty ()
 Simple virtual empty destructor.

Protected Attributes

Poco::DynamicAny defaultValue
 Default value of the Property.

Detailed Description

Abstract class for Properties that have a default value.


Member Typedef Documentation

Typedef for shared pointers.

Reimplemented from Onyx::Properties::PropertyBase.

Reimplemented in Onyx::Properties::ClassProperty.


Constructor & Destructor Documentation

Onyx::Properties::DefaultProperty::DefaultProperty ( const DefaultProperty other  ) 

Copy constructor.

Parameters:
other Property to copy.
Onyx::Properties::DefaultProperty::DefaultProperty ( const std::string &  propName,
const std::string &  groupName = "",
const Poco::DynamicAny &  dValue = 0,
const bool &  validateAll = true 
)

Default constructor, essentially the same as the PropertyBase constructor.

Parameters:
propName Name of the Property.
groupName Group name of the Property.
dValue Initial and default value of the Property.
validateAll Whether or not all validators should always be evaluated.
virtual Onyx::Properties::DefaultProperty::~DefaultProperty (  )  [virtual]

Simple virtual empty destructor.


Member Function Documentation

const Poco::DynamicAny& Onyx::Properties::DefaultProperty::getDefaultValue (  )  const

Get the default value of the Property.

void Onyx::Properties::DefaultProperty::setDefaultValue ( const Poco::DynamicAny &  defaultValue  ) 

Set the Property's default value.

Parameters:
defaultValue The new default value of the Property.
void Onyx::Properties::DefaultProperty::resetValue (  ) 

Reset the Property's value to default.


Field Documentation

Default value of the Property.


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