CommandProperty Class Reference

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

#include <GaudiKernel/CommandProperty.h>

Inheritance diagram for CommandProperty:

Collaboration diagram for CommandProperty:

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

Additional Inherited Members
Public Types inherited from PropertyWithValue< std::string >
typedef Gaudi::Utils::PropertyTypeTraits < std::string >	Traits
	the type-traits for properties More...
typedef Traits::PVal	PVal
	the actual storage type More...
Protected Types inherited from SimpleProperty< std::string >
typedef Gaudi::Utils::PropertyTypeTraits < std::string >	Traits
Protected Member Functions inherited from PropertyWithVerifier< std::string, VERIFIER >
	PropertyWithVerifier (const std::string &name, typename Gaudi::Utils::PropertyTypeTraits< std::string >::PVal value, const bool owner, const VERIFIER &verifier)
	the constructor with property name and value More...
virtual	~PropertyWithVerifier ()
	virtual destructor More...
Protected Member Functions inherited from PropertyWithValue< std::string >
	PropertyWithValue (const std::string &name, PVal value, const bool owner)
	the constructor with property name and value More...
	PropertyWithValue (const PropertyWithValue &rhs)
	copy constructor (don't let the compiler generate a buggy one) More...
	PropertyWithValue (const PropertyWithValue< OTHER > &right)
	copy constructor from any other type More...
virtual	~PropertyWithValue ()
	virtual destructor More...
PropertyWithValue &	operator= (const std::string &value)
	assignment operator More...
PropertyWithValue &	operator= (const PropertyWithValue &rhs)
PropertyWithValue &	operator= (const PropertyWithValue< OTHER > &right)
void	i_set (const std::string &value)
	set the value More...
PVal	i_get () const
	get the value More...
Protected Member Functions inherited from Property
	Property (const std::type_info &type, const std::string &name="")
	constructor from the property name and the type More...
	Property (const std::string &name, const std::type_info &type)
	constructor from the property name and the type More...
	Property (const Property &right)
	copy constructor More...
Property &	operator= (const Property &right)
	assignment operator More...
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:

• GaudiKernel/GaudiKernel/CommandProperty.h
• GaudiKernel/src/Lib/CommandProperty.cpp