GaudiHandleProperty Class Reference

#include </builds/gaudi/Gaudi/GaudiKernel/include/Gaudi/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
	clones the current property
bool	load (PropertyBase &destination) const override
bool	assign (const PropertyBase &source) override
std::string	toString () const override
	value -> string
void	toStream (std::ostream &out) const override
	value -> stream
StatusCode	fromString (const std::string &s) override
	string -> value
const GaudiHandleBase &	value () const
bool	setValue (const GaudiHandleBase &value)
Public Member Functions inherited from PropertyWithHandlers< Handler >
PropertyBase &	declareReadHandler (std::function< void(PropertyBase &)> fun) override
	set new callback for reading
PropertyBase &	declareUpdateHandler (std::function< void(PropertyBase &)> fun) override
	set new callback for update
const std::function< void(PropertyBase &)>	readCallBack () const override
	get a reference to the readCallBack
const std::function< void(PropertyBase &)>	updateCallBack () const override
	get a reference to the updateCallBack
void	useReadHandler () const
	use the call-back function at reading, if available
bool	useUpdateHandler () override
	use the call-back function at update, if available
Public Member Functions inherited from Gaudi::Details::PropertyBase
const std::string	name () const
	property name
std::string	documentation () const
	property documentation
std::string	semantics () const
	property semantics
const std::type_info *	type_info () const
	property type-info
std::string	type () const
	property type
virtual bool	load (PropertyBase &dest) const =0
	export the property value to the destination
virtual bool	assign (const PropertyBase &source)=0
	import the property value form the source
virtual PropertyBase &	declareReadHandler (std::function< void(PropertyBase &)> fun)=0
	set new callback for reading
virtual PropertyBase &	declareUpdateHandler (std::function< void(PropertyBase &)> fun)=0
	set new callback for update
template<class HT>
PropertyBase &	declareReadHandler (void(HT::*MF)(PropertyBase &), HT *instance)
template<class HT>
PropertyBase &	declareUpdateHandler (void(HT::*MF)(PropertyBase &), HT *instance)
virtual	~PropertyBase ()
	virtual destructor
void	setName (std::string value)
	set the new value for the property name
void	setDocumentation (std::string value)
	set the documentation string
void	setSemantics (std::string value)
	set the semantics string
virtual std::ostream &	fillStream (std::ostream &) const
	the printout of the property value
void	setOwnerType (const std::type_info &ownerType)
	set the type of the owner class (used for documentation)
template<class OWNER>
void	setOwnerType ()
	set the type of the owner class (used for documentation)
const std::type_info *	ownerType () const
	get the type of the owner class (used for documentation)
std::string	ownerTypeName () const
	get the string for the type of the owner class (used for documentation)

Private Attributes
GaudiHandleBase *	m_pValue
	Pointer to the real property.

Additional Inherited Members
Protected Member Functions inherited from Gaudi::Details::PropertyBase
	PropertyBase (const std::type_info &type, std::string name="", std::string doc="", std::string semantics="")
	constructor from the property name and the type
	PropertyBase (std::string name, const std::type_info &type)
	constructor from the property name and the type
	PropertyBase (const PropertyBase &)=default
	copy constructor
PropertyBase &	operator= (const PropertyBase &)=default
	assignment operator

Detailed Description

Definition at line 569 of file Property.h.

Constructor & Destructor Documentation

GaudiHandleProperty()

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

Definition at line 94 of file Property.cpp.

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

Member Function Documentation

assign()

bool GaudiHandleProperty::assign ( const PropertyBase & source )

inlineoverride

Definition at line 582 of file Property.h.

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

clone()

GaudiHandleProperty * GaudiHandleProperty::clone ( ) const

inlineoverridevirtual

clones the current property

Implements Gaudi::Details::PropertyBase.

Definition at line 578 of file Property.h.

{ return new GaudiHandleProperty( *this ); }

fromString()

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

overridevirtual

string -> value

\fixme strip optional quotes around the string

Implements Gaudi::Details::PropertyBase.

Definition at line 114 of file Property.cpp.

                                                               {
  if ( s.size() > 1 && ( s.front() == '\'' || s.front() == '\"' ) && s.front() == s.back() ) {
    m_pValue->setTypeAndName( s.substr( 1, s.size() - 2 ) );
  } else {
    m_pValue->setTypeAndName( s );
  }
  useUpdateHandler();
  return StatusCode::SUCCESS;
}

load()

bool GaudiHandleProperty::load ( PropertyBase & destination ) const

inlineoverride

Definition at line 580 of file Property.h.

{ return destination.assign( *this ); }

operator=()

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

inline

Definition at line 573 of file Property.h.

                                                                 {
    setValue( value );
    return *this;
  }

setValue()

bool GaudiHandleProperty::setValue

(

const GaudiHandleBase &

value

)

Definition at line 99 of file Property.cpp.

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

toStream()

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

overridevirtual

value -> stream

Implements Gaudi::Details::PropertyBase.

Definition at line 109 of file Property.cpp.

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

toString()

std::string GaudiHandleProperty::toString ( ) const

overridevirtual

value -> string

Implements Gaudi::Details::PropertyBase.

Definition at line 104 of file Property.cpp.

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

value()

const GaudiHandleBase & GaudiHandleProperty::value ( ) const

inline

Definition at line 590 of file Property.h.

                                       {
    useReadHandler();
    return *m_pValue;
  }

Member Data Documentation

m_pValue

GaudiHandleBase* GaudiHandleProperty::m_pValue

private

Pointer to the real property.

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

Definition at line 600 of file Property.h.

---

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

• GaudiKernel/include/Gaudi/Property.h
• GaudiKernel/src/Lib/Property.cpp