In This Package:

CommandProperty Class Reference

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

#include <GaudiKernel/CommandProperty.h>

Inheritance diagram for CommandProperty:

[legend]Collaboration diagram for CommandProperty:[legend]List of all members.

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.
virtual SimpleProperty *	clone () const
	implementation of Property::clone
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
	operator const TYPE & () const
const TYPE &	value () const
	get the access to the storage
virtual bool	assign (const Property &source)
	get the value from another property
template<>
bool	assign (const Property &source)
	import the property value form the source
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
template<>
std::string	toString () const
	value -> string
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 ownered by property!
const PropertyCallbackFunctor *	updateCallBack () const
	Call-back functor for update: the funtor is ownered by property!
virtual void	declareReadHandler (PropertyCallbackFunctor *pf)
	set new callback for reading
template<class HT>
void	declareReadHandler (void(HT::*MF)(Property &), HT *instance)
virtual void	declareUpdateHandler (PropertyCallbackFunctor *pf)
	set new callback for update
template<class HT>
void	declareUpdateHandler (void(HT::*MF)(Property &), HT *instance)
virtual void	useReadHandler () const
	use the call-back function at reading
virtual void	useUpdateHandler ()
	use the call-back function at update
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
Protected Member Functions
void	i_set (const TYPE &value)
TYPE *	i_get () const
Protected Attributes
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.

CommandProperty::CommandProperty

(

const std::string &

name

)

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

virtual CommandProperty::~CommandProperty

(

)

[virtual]

---

Member Function Documentation

virtual bool CommandProperty::set

(

const std::string &

value

)

[virtual]

Set value method.

virtual void CommandProperty::handler

(

const std::string &

value

)

[pure virtual]

User call back function.

template<class TYPE, class VERIFIER>

SimpleProperty< TYPE, VERIFIER > * SimpleProperty< TYPE, VERIFIER >::clone

(

)

const [inline, virtual, inherited]

implementation of Property::clone

Implements Property.

Definition at line 550 of file Property.h.

{ return new SimpleProperty(*this) ; }

template<class TYPE, class VERIFIER>

VERIFIER& PropertyWithVerifier< TYPE, VERIFIER >::verifier

(

)

[inline, inherited]

Definition at line 374 of file Property.h.

{ return m_verifier ; }

template<class TYPE, class VERIFIER>

const VERIFIER& PropertyWithVerifier< TYPE, VERIFIER >::verifier

(

)

const [inline, inherited]

Definition at line 375 of file Property.h.

{ return m_verifier ; }

template<class TYPE, class VERIFIER>

bool PropertyWithVerifier< TYPE, VERIFIER >::set

(

const TYPE &

value

)

[inline, inherited]

update the value of the property/check the verifier

use verifier!

update the value

invoke the update handler

Definition at line 402 of file Property.h.

{
  if ( !m_verifier.isValid( &value ) ) { return false ; }
  i_set( value ) ;
  this->useUpdateHandler() ;
  return true ;
}

template<class TYPE, class VERIFIER>

virtual bool PropertyWithVerifier< TYPE, VERIFIER >::setValue

(

const TYPE &

value

)

[inline, virtual, inherited]

implementation of PropertyWithValue::setValue

Implements PropertyWithValue< TYPE >.

Definition at line 379 of file Property.h.

{ return set( value ) ; }

template<class TYPE>

PropertyWithValue< TYPE >::operator const TYPE &

(

)

const [inline, inherited]

Definition at line 172 of file Property.h.

{ return value() ;}

template<class TYPE>

const TYPE & PropertyWithValue< TYPE >::value

(

)

const [inline, inherited]

get the access to the storage

Definition at line 306 of file Property.h.

{ useReadHandler() ; return *m_value ; }

template<class TYPE>

bool PropertyWithValue< TYPE >::assign

(

const Property &

source

)

[inline, virtual, inherited]

get the value from another property

Implements Property.

Definition at line 247 of file Property.h.

{
  // 1) Is the property of "the same" type?
  const PropertyWithValue<TYPE>* p =
    dynamic_cast<const PropertyWithValue<TYPE>*>       ( &source ) ;
  if ( 0 != p ) { return setValue ( p->value() ) ; }       // RETURN
  // 2) Else use the string representation
  return this->fromString( source.toString() ).isSuccess() ;
}

template<>

bool PropertyWithValue< std::string >::assign

(

const Property &

source

)

[inline, virtual, inherited]

import the property value form the source

Implements Property.

Definition at line 297 of file Property.h.

{ return this->fromString( source.toString() ).isSuccess() ; }

template<class TYPE>

bool PropertyWithValue< TYPE >::load

(

Property &

dest

)

const [inline, virtual, inherited]

set value for another property

Implements Property.

Definition at line 261 of file Property.h.

{
  // gelegate to the 'opposite' method ;
  return dest.assign( *this ) ;
}

template<class TYPE>

StatusCode PropertyWithValue< TYPE >::fromString

(

const std::string &

s

)

[inline, virtual, inherited]

string -> value

Implements Property.

Definition at line 281 of file Property.h.

{
  TYPE tmp ;
  StatusCode sc = Gaudi::Parsers::parse ( tmp , source ) ;
  if ( sc.isFailure() ) { return sc ; }
  return setValue ( tmp ) ? StatusCode::SUCCESS : StatusCode::FAILURE ;
}

template<class TYPE>

std::string PropertyWithValue< TYPE >::toString

(

)

const [inline, virtual, inherited]

value -> string

Implements Property.

Definition at line 271 of file Property.h.

{
  useReadHandler();
  return Gaudi::Utils::toString( *m_value ) ;
}

template<>

std::string PropertyWithValue< std::string >::toString

(

)

const [inline, virtual, inherited]

value -> string

Implements Property.

Definition at line 293 of file Property.h.

{ return this->value() ; }

template<class TYPE>

void PropertyWithValue< TYPE >::i_set

(

const TYPE &

value

)

[inline, protected, inherited]

Definition at line 313 of file Property.h.

{ *m_value = value ; }

template<class TYPE>

TYPE * PropertyWithValue< TYPE >::i_get

(

)

const [inline, protected, inherited]

Definition at line 318 of file Property.h.

{ return m_value ; }

const std::string& Property::name

(

)

const [inline, inherited]

property name

Definition at line 50 of file Property.h.

{ return m_name             ; } ;

const std::string& Property::documentation

(

)

const [inline, inherited]

property documentation

Definition at line 52 of file Property.h.

{ return m_documentation; };

const std::type_info* Property::type_info

(

)

const [inline, inherited]

property type-info

Definition at line 54 of file Property.h.

{ return m_typeinfo         ; } ;

std::string Property::type

(

)

const [inline, inherited]

property type

Definition at line 56 of file Property.h.

{ return m_typeinfo->name() ; } ;

const PropertyCallbackFunctor* Property::readCallBack

(

)

const [inherited]

Call-back functor at reading: the functor is ownered by property!

const PropertyCallbackFunctor* Property::updateCallBack

(

)

const [inherited]

Call-back functor for update: the funtor is ownered by property!

virtual void Property::declareReadHandler

(

PropertyCallbackFunctor *

pf

)

[virtual, inherited]

set new callback for reading

template<class HT>

void Property::declareReadHandler	(	void(HT::*)(Property &)	MF,
		HT *	instance
	)			[inline, inherited]

Definition at line 131 of file Property.h.

{ declareReadHandler ( new PropertyCallbackMemberFunctor< HT >( MF , obj ) ) ; }

virtual void Property::declareUpdateHandler

(

PropertyCallbackFunctor *

pf

)

[virtual, inherited]

set new callback for update

template<class HT>

void Property::declareUpdateHandler	(	void(HT::*)(Property &)	MF,
		HT *	instance
	)			[inline, inherited]

Definition at line 136 of file Property.h.

{ declareUpdateHandler ( new PropertyCallbackMemberFunctor< HT >( MF , obj ) ) ; }

virtual void Property::useReadHandler

(

)

const [virtual, inherited]

use the call-back function at reading

virtual void Property::useUpdateHandler

(

)

[virtual, inherited]

use the call-back function at update

void Property::setName

(

const std::string &

value

)

[inline, inherited]

set the new value for the property name

Definition at line 91 of file Property.h.

{ m_name = value ; }

void Property::setDocumentation

(

const std::string &

documentation

)

[inline, inherited]

set the documentation string

Definition at line 93 of file Property.h.

                                                          {
    m_documentation = documentation; };

virtual std::ostream& Property::fillStream

(

std::ostream &

)

const [virtual, inherited]

the printout of the property value

---

Member Data Documentation

PropertyCallbackFunctor* Property::m_readCallBack [mutable, protected, inherited]

Definition at line 122 of file Property.h.

PropertyCallbackFunctor* Property::m_updateCallBack [protected, inherited]

Definition at line 124 of file Property.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/CommandProperty.h

---