GaudiHandleProperty Class Reference

#include </tmp/marcocle/lhcb-release/1122/GAUDI/GAUDI_v27r0/InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/Property.h>

Inheritance diagram for GaudiHandleProperty:

Collaboration diagram for GaudiHandleProperty:

Public Member Functions
	GaudiHandleProperty (std::string name, GaudiHandleBase &ref)
GaudiHandleProperty &	operator= (const GaudiHandleBase &value)
GaudiHandleProperty *	clone () const override
	clone: "virtual constructor" More...
bool	load (Property &destination) const override
	export the property value to the destination More...
bool	assign (const Property &source) override
	import the property value form the source More...
std::string	toString () const override
	value -> string More...
void	toStream (std::ostream &out) const override
	value -> stream More...
StatusCode	fromString (const std::string &s) override
	string -> value More...
const GaudiHandleBase &	value () const
bool	setValue (const GaudiHandleBase &value)
	GaudiHandleProperty (std::string name, GaudiHandleBase &ref)
GaudiHandleProperty &	operator= (const GaudiHandleBase &value)
GaudiHandleProperty *	clone () const override
	clone: "virtual constructor" More...
bool	load (Property &destination) const override
	export the property value to the destination More...
bool	assign (const Property &source) override
	import the property value form the source More...
std::string	toString () const override
	value -> string More...
void	toStream (std::ostream &out) const override
	value -> stream More...
StatusCode	fromString (const std::string &s) override
	string -> value More...
const GaudiHandleBase &	value () const
bool	setValue (const GaudiHandleBase &value)
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 std::function< void(Property &)> &	readCallBack () const
	get a reference to the readCallBack More...
const std::function< void(Property &)> &	updateCallBack () const
	get a reference to the updateCallBack More...
virtual Property &	declareReadHandler (std::function< void(Property &)> fun)
	set new callback for reading More...
virtual Property &	declareUpdateHandler (std::function< void(Property &)> fun)
	set new callback for update More...
template<class HT >
Property &	declareReadHandler (void(HT::*MF)(Property &), HT *instance)
template<class HT >
Property &	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 ()=default
	virtual destructor More...
void	setName (std::string value)
	set the new value for the property name More...
void	setDocumentation (std::string documentation)
	set the documentation string More...
virtual std::ostream &	fillStream (std::ostream &) const
	the printout of the property value More...
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 std::function< void(Property &)> &	readCallBack () const
	get a reference to the readCallBack More...
const std::function< void(Property &)> &	updateCallBack () const
	get a reference to the updateCallBack More...
virtual Property &	declareReadHandler (std::function< void(Property &)> fun)
	set new callback for reading More...
virtual Property &	declareUpdateHandler (std::function< void(Property &)> fun)
	set new callback for update More...
template<class HT >
Property &	declareReadHandler (void(HT::*MF)(Property &), HT *instance)
template<class HT >
Property &	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 ()=default
	virtual destructor More...
void	setName (std::string value)
	set the new value for the property name More...
void	setDocumentation (std::string documentation)
	set the documentation string More...
virtual std::ostream &	fillStream (std::ostream &) const
	the printout of the property value More...

Private Attributes
GaudiHandleBase *	m_pValue
	Pointer to the real property. More...

Additional Inherited Members
Protected Member Functions inherited from Property
	Property (const std::type_info &type, std::string name="")
	constructor from the property name and the type More...
	Property (std::string name, const std::type_info &type)
	constructor from the property name and the type More...
	Property (const Property &)=default
	copy constructor More...
Property &	operator= (const Property &)=default
	assignment operator More...
	Property (const std::type_info &type, std::string name="")
	constructor from the property name and the type More...
	Property (std::string name, const std::type_info &type)
	constructor from the property name and the type More...
	Property (const Property &)=default
	copy constructor More...
Property &	operator= (const Property &)=default
	assignment operator More...
Protected Attributes inherited from Property
std::function< void(Property &)>	m_readCallBack
std::function< void(Property &)>	m_updateCallBack

Detailed Description

Definition at line 783 of file Property.h.

Constructor & Destructor Documentation

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

Definition at line 170 of file Property.cpp.

  : Property( std::move(name_), typeid( GaudiHandleBase ) ), m_pValue( &ref )
{
  m_pValue->setPropertyName( name() );
}

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

Member Function Documentation

bool GaudiHandleProperty::assign ( const Property &  source )

inlineoverridevirtual

import the property value form the source

Implements Property.

Definition at line 828 of file Property.h.

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

bool GaudiHandleProperty::assign ( const Property &  source )

overridevirtual

import the property value form the source

Implements Property.

GaudiHandleProperty * GaudiHandleProperty::clone ( ) const

inlineoverridevirtual

clone: "virtual constructor"

Implements Property.

Definition at line 820 of file Property.h.

                                                             {
  return new GaudiHandleProperty( *this );
}

GaudiHandleProperty* GaudiHandleProperty::clone ( ) const

overridevirtual

clone: "virtual constructor"

Implements Property.

StatusCode GaudiHandleProperty::fromString ( const std::string &  value )

overridevirtual

string -> value

Implements Property.

StatusCode GaudiHandleProperty::fromString ( const std::string &  value )

overridevirtual

string -> value

Implements Property.

Definition at line 191 of file Property.cpp.

                                                              {
  m_pValue->setTypeAndName( s );
  return useUpdateHandler()?StatusCode::SUCCESS:StatusCode::FAILURE;
}

bool GaudiHandleProperty::load ( Property &  dest ) const

overridevirtual

export the property value to the destination

Implements Property.

bool GaudiHandleProperty::load ( Property &  dest ) const

inlineoverridevirtual

export the property value to the destination

Implements Property.

Definition at line 824 of file Property.h.

                                                                   {
  return destination.assign( *this );
}

GaudiHandleProperty & GaudiHandleProperty::operator= ( const GaudiHandleBase &  value )

inline

Definition at line 815 of file Property.h.

                                                                                         {
      setValue( value );
      return *this;
}

GaudiHandleProperty& GaudiHandleProperty::operator=

(

const GaudiHandleBase &

value

)

bool GaudiHandleProperty::setValue

(

const GaudiHandleBase &

value

)

Definition at line 176 of file Property.cpp.

                                                                 {
  m_pValue->setTypeAndName( value.typeAndName() );
  return useUpdateHandler();
}

bool GaudiHandleProperty::setValue

(

const GaudiHandleBase &

value

)

void GaudiHandleProperty::toStream ( std::ostream &  out ) const

overridevirtual

value -> stream

Implements Property.

void GaudiHandleProperty::toStream ( std::ostream &  out ) const

overridevirtual

value -> stream

Implements Property.

Definition at line 186 of file Property.cpp.

                                                        {
  useReadHandler();
  out << m_pValue->typeAndName();
}

std::string GaudiHandleProperty::toString ( ) const

overridevirtual

value -> string

Implements Property.

Definition at line 181 of file Property.cpp.

                                               {
  useReadHandler();
  return m_pValue->typeAndName();
}

std::string GaudiHandleProperty::toString ( ) const

overridevirtual

value -> string

Implements Property.

const GaudiHandleBase & GaudiHandleProperty::value ( ) const

inline

Definition at line 832 of file Property.h.

                                                               {
  useReadHandler();
  return *m_pValue;
}

const GaudiHandleBase& GaudiHandleProperty::value

(

)

const

Member Data Documentation

GaudiHandleBase * GaudiHandleProperty::m_pValue

private

Pointer to the real property.

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

Definition at line 808 of file Property.h.

---

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

• InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/Property.h
• GaudiKernel/src/Lib/Property.cpp