#include </builds/gaudi/Gaudi/GaudiKernel/include/Gaudi/Property.h>

Inheritance diagram for GaudiHandleProperty:

Collaboration diagram for GaudiHandleProperty:

[legend]

Public Member Functions
	GaudiHandleProperty (std::string name, GaudiHandleBase &ref)

GaudiHandleProperty &	operator= (const GaudiHandleBase &value)

GaudiHandleProperty *	clone () const override
	clones the current property More...

bool	load (PropertyBase &destination) const override

bool	assign (const PropertyBase &source) override

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 PropertyWithHandlers<>
PropertyBase &	declareReadHandler (std::function< void(PropertyBase &)> fun) override
	set new callback for reading More...

PropertyBase &	declareUpdateHandler (std::function< void(PropertyBase &)> fun) override
	set new callback for update More...

const std::function< void(PropertyBase &)>	readCallBack () const override
	get a reference to the readCallBack More...

const std::function< void(PropertyBase &)>	updateCallBack () const override
	get a reference to the updateCallBack More...

void	useReadHandler () const
	use the call-back function at reading, if available More...

bool	useUpdateHandler () override
	use the call-back function at update, if available More...

Public Member Functions inherited from Gaudi::Details::PropertyBase
const std::string	name () const
	property name More...

std::string	documentation () const
	property documentation More...

std::string	semantics () const
	property semantics More...

const std::type_info *	type_info () const
	property type-info More...

std::string	type () const
	property type More...

virtual bool	load (PropertyBase &dest) const =0
	export the property value to the destination More...

virtual bool	assign (const PropertyBase &source)=0
	import the property value form the source More...

virtual PropertyBase &	declareReadHandler (std::function< void(PropertyBase &)> fun)=0
	set new callback for reading More...

virtual PropertyBase &	declareUpdateHandler (std::function< void(PropertyBase &)> fun)=0
	set new callback for update More...

virtual const std::function< void(PropertyBase &)>	readCallBack () const =0
	get a reference to the readCallBack More...

virtual const std::function< void(PropertyBase &)>	updateCallBack () const =0
	get a reference to the updateCallBack More...

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 More...

void	setName (std::string value)
	set the new value for the property name More...

void	setDocumentation (std::string value)
	set the documentation string More...

void	setSemantics (std::string value)
	set the semantics string More...

virtual std::ostream &	fillStream (std::ostream &) const
	the printout of the property value More...

void	setOwnerType (const std::type_info &ownerType)
	set the type of the owner class (used for documentation) More...

template<class OWNER >
void	setOwnerType ()
	set the type of the owner class (used for documentation) More...

const std::type_info *	ownerType () const
	get the type of the owner class (used for documentation) More...

std::string	ownerTypeName () const
	get the string for the type of the owner class (used for documentation) More...

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

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 More...

	PropertyBase (std::string name, const std::type_info &type)
	constructor from the property name and the type More...

	PropertyBase (const PropertyBase &)=default
	copy constructor More...

PropertyBase &	operator= (const PropertyBase &)=default
	assignment operator More...

Detailed Description

Definition at line 585 of file Property.h.

Constructor & Destructor Documentation

◆ GaudiHandleProperty()

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

Definition at line 114 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 598 of file Property.h.

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

◆ clone()

GaudiHandleProperty* GaudiHandleProperty::clone ( ) const

inlineoverridevirtual

clones the current property

Implements Gaudi::Details::PropertyBase.

Definition at line 594 of file Property.h.

594 { 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 134 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 596 of file Property.h.

596 { return destination.assign( *this ); }

◆ operator=()

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

inline

Definition at line 589 of file Property.h.

                                                                  {
     setValue( value );
     return *this;
   }

◆ setValue()

bool GaudiHandleProperty::setValue ( const GaudiHandleBase & value )

Definition at line 119 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 129 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 124 of file Property.cpp.

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

◆ value()

const GaudiHandleBase& GaudiHandleProperty::value ( ) const

inline

Definition at line 606 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 616 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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GaudiHandleProperty()

Member Function Documentation

◆ assign()

◆ clone()

◆ fromString()

◆ load()

◆ operator=()

◆ setValue()

◆ toStream()

◆ toString()

◆ value()

Member Data Documentation

◆ m_pValue