| # Gaudi Framework, version v25r0 |

Home |  | Generated: Mon Feb 17 2014

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
CommandProperty Class Referenceabstract

Command property base class (abstract). More...

`#include <GaudiKernel/CommandProperty.h>`

Inheritance diagram for CommandProperty:
[legend]
Collaboration diagram for CommandProperty:
[legend]

## Public Member Functions
| CommandProperty ()
| Constructors and destructors.
| CommandProperty (const std::string &name)
| CommandProperty (const std::string &name, const std::string &value)
virtual | ~CommandProperty ()
virtual bool | set (const std::string &value)
| Set value method.
virtual void | handler (const std::string &value)=0
| User call back function.
Public Member Functions inherited from SimpleProperty< std::string >
| SimpleProperty (VERIFIER verifier=VERIFIER())
| "Almost default" constructor from verifier
| SimpleProperty (const std::string &value, VERIFIER verifier=VERIFIER())
| The constructor from the value and verifier (ATLAS needs it!)
| SimpleProperty (const std::string &name, const std::string &value, VERIFIER verifier=VERIFIER())
| The constructor from the name, value and verifier.
| SimpleProperty (const PropertyWithValue< OTHER > &right)
| constructor from other property type
| SimpleProperty (const SimpleProperty &right)
| copy constructor (must be!)
virtual | ~SimpleProperty ()
| virtual Destructor
virtual SimpleProperty * | clone () const
| implementation of Property::clone
SimpleProperty & | operator= (const std::string &value)
| assignment form the value
SimpleProperty & | operator= (const PropertyWithValue< OTHER > &right)
| assignment form the other property type
Public Member Functions inherited from PropertyWithVerifier< TYPE, VERIFIER >
VERIFIER & | verifier ()
const VERIFIER & | verifier () const
bool | set (const TYPE &value)
| update the value of the property/check the verifier
virtual bool | setValue (const TYPE &value)
| implementation of PropertyWithValue::setValue
template<class OTHER , class OTHERVERIFIER >
PropertyWithVerifier & | operator= (const PropertyWithVerifier< OTHER, OTHERVERIFIER > &right)
| templated assignment
template<class OTHER >
PropertyWithVerifier & | operator= (const PropertyWithValue< OTHER > &right)
| templated assignment
PropertyWithVerifier & | operator= (const TYPE &right)
| assignment
Public Member Functions inherited from PropertyWithValue< TYPE >
| operator const TYPE & () const
| implicit conversion to the type
const TYPE & | value () const
| explicit conversion
virtual bool | assign (const Property &source)
| get the value from another property
virtual bool | load (Property &dest) const
| set value for another property
virtual StatusCode | fromString (const std::string &s)
| string -> value
virtual std::string | toString () const
| value -> string
virtual void | toStream (std::ostream &out) const
| value -> stream
Public Member Functions inherited from Property
const std::string & | name () const
| property name
const std::string & | documentation () const
| property documentation
const std::type_info * | type_info () const
| property type-info
std::string | type () const
| property type
const PropertyCallbackFunctor * | readCallBack () const
| Call-back functor at reading: the functor is owned by property!
const PropertyCallbackFunctor * | updateCallBack () const
| Call-back functor for update: the functor is owned by property!
virtual void | declareReadHandler (PropertyCallbackFunctor *pf)
| set new callback for reading
virtual void | declareUpdateHandler (PropertyCallbackFunctor *pf)
| set new callback for update
template<class HT >
void | declareReadHandler (void(HT::*MF)(Property &), HT *instance)
template<class HT >
void | declareUpdateHandler (void(HT::*MF)(Property &), HT *instance)
virtual void | useReadHandler () const
| use the call-back function at reading
virtual bool | useUpdateHandler ()
| use the call-back function at update
virtual | ~Property ()
| virtual destructor
void | setName (const std::string &value)
| set the new value for the property name
void | setDocumentation (const std::string &documentation)
| set the documentation string
virtual std::ostream & | fillStream (std::ostream &) const
| the printout of the property value

## Additional Inherited Members
Public Types inherited from PropertyWithValue< TYPE >
typedef Gaudi::Utils::PropertyTypeTraits < TYPE > | Traits
| the type-traits for properties
typedef Traits::PVal | PVal
| the actual storage type
Protected Types inherited from SimpleProperty< std::string >
typedef Gaudi::Utils::PropertyTypeTraits < std::string > | Traits
Protected Member Functions inherited from PropertyWithVerifier< TYPE, VERIFIER >
| PropertyWithVerifier (const std::string &name, typename Gaudi::Utils::PropertyTypeTraits< TYPE >::PVal value, const bool owner, const VERIFIER &verifier)
| the constructor with property name and value
virtual | ~PropertyWithVerifier ()
| virtual destructor
Protected Attributes inherited from Property
PropertyCallbackFunctor * | m_readCallBack
PropertyCallbackFunctor * | m_updateCallBack

## Detailed Description

Command property base class (abstract).

The CommandProperty is a subclass of StringProperty that has a callback when the value is changed. Not very useful until we have a scripting language

Author
  David Quarrie

Definition at line 16 of file CommandProperty.h.

## Constructor & Destructor Documentation

CommandProperty::CommandProperty | ( |  | ) |

Constructors and destructors.

Definition at line 5 of file CommandProperty.cpp.

: StringProperty( ) {
}

CommandProperty::CommandProperty | ( | const std::string & | name | ) |

Definition at line 9 of file CommandProperty.cpp.

: StringProperty( name ) {
}

CommandProperty::CommandProperty | ( | const std::string & | name,
|  | const std::string & | value
| ) |  |

Definition at line 13 of file CommandProperty.cpp.

: StringProperty( name, value ) {
}

CommandProperty::~CommandProperty | ( |  | ) |
| virtual

Definition at line 18 of file CommandProperty.cpp.

{
}

## Member Function Documentation

virtual void CommandProperty::handler | ( | const std::string & | value | ) |
| pure virtual

User call back function.

bool CommandProperty::set | ( | const std::string & | value | ) |
| virtual

Set value method.

Definition at line 21 of file CommandProperty.cpp.

{
bool result = StringProperty::set( value );
handler( value );
return result;
}

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v25r0/GaudiKernel/GaudiKernel/CommandProperty.h
- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v25r0/GaudiKernel/src/Lib/CommandProperty.cpp