In This Package:

GaudiHandleProperty Class Reference

#include <Property.h>

Inheritance diagram for GaudiHandleProperty:

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

Public Member Functions
	GaudiHandleProperty (const std::string &name, GaudiHandleBase &ref)
GaudiHandleProperty &	operator= (const GaudiHandleBase &value)
virtual GaudiHandleProperty *	clone () const
	clone: "virtual constructor"
virtual bool	load (Property &destination) const
	export the property value to the destination
virtual bool	assign (const Property &source)
	import the property value form the source
virtual std::string	toString () const
	value -> string
virtual StatusCode	fromString (const std::string &s)
	string -> value
const GaudiHandleBase &	value () const
bool	setValue (const GaudiHandleBase &value)
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 Attributes
PropertyCallbackFunctor *	m_readCallBack
PropertyCallbackFunctor *	m_updateCallBack
Private Attributes
GaudiHandleBase *	m_pValue
	Pointer to the real property.

---

Detailed Description

Definition at line 756 of file Property.h.

---

Constructor & Destructor Documentation

GaudiHandleProperty::GaudiHandleProperty	(	const std::string &	name,
		GaudiHandleBase &	ref
	)

---

Member Function Documentation

GaudiHandleProperty & GaudiHandleProperty::operator=

(

const GaudiHandleBase &

value

)

[inline]

Definition at line 786 of file Property.h.

                                                                                         {
      setValue( value );
      return *this;
}

GaudiHandleProperty * GaudiHandleProperty::clone

(

)

const [inline, virtual]

clone: "virtual constructor"

Implements Property.

Definition at line 791 of file Property.h.

                                                             {
  return new GaudiHandleProperty( *this );
}

bool GaudiHandleProperty::load

(

Property &

destination

)

const [inline, virtual]

export the property value to the destination

Implements Property.

Definition at line 795 of file Property.h.

                                                                   {
  return destination.assign( *this );
}

bool GaudiHandleProperty::assign

(

const Property &

source

)

[inline, virtual]

import the property value form the source

Implements Property.

Definition at line 799 of file Property.h.

                                                                {
  return fromString( source.toString() ).isSuccess();
}

virtual std::string GaudiHandleProperty::toString

(

)

const [virtual]

value -> string

Implements Property.

virtual StatusCode GaudiHandleProperty::fromString

(

const std::string &

s

)

[virtual]

string -> value

Implements Property.

const GaudiHandleBase & GaudiHandleProperty::value

(

)

const [inline]

Definition at line 803 of file Property.h.

                                                               {
  useReadHandler();
  return *m_pValue;
}

bool GaudiHandleProperty::setValue

(

const GaudiHandleBase &

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

GaudiHandleBase* GaudiHandleProperty::m_pValue [private]

Pointer to the real property.

Reference would be better, but Reflex does not support references yet

Definition at line 779 of file Property.h.

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/Property.h

---