#include <GaudiKernel/PropertyMgr.h>

Inheritance diagram for PropertyMgr:

Collaboration diagram for PropertyMgr:

[legend]

Public Member Functions
	PropertyMgr (IInterface *iface=nullptr)
	constructor from the interface More...

	PropertyMgr (const PropertyMgr &)=delete

PropertyMgr &	operator= (const PropertyMgr &)=delete

template<class TYPE , typename = std::enable_if_t<!std::is_base_of_v<GaudiHandleBase, TYPE> && !std::is_base_of_v<GaudiHandleArrayBase, TYPE> && !std::is_base_of_v<Gaudi::DataHandle, TYPE>>>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Declare a property (templated) More...

template<class TYPE >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE > &prop, const std::string &doc="none")
	Declare a property (specialization) More...

template<class TYPE >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE & > &prop, const std::string &doc="none")
	Declare a property (specialization) More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
	Declare a property (specialization) More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")
	Declare a property (specialization) More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::DataHandle &ref, const std::string &doc="none")
	Declare a property (specialization) More...

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...

StatusCode	setProperty (const std::string &s) override
	set the property from the property formatted string More...

StatusCode	setPropertyRepr (const std::string &n, const std::string &v) override
	set the property from name and the value More...

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name More...

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string More...

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name. More...

StatusCode	queryInterface (const InterfaceID &iid, void **pinterface) override

Public Member Functions inherited from implements< IProperty >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

	implements ()=default
	Default constructor. More...

	implements (const implements &)
	Copy constructor (zero the reference count) More...

implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...

unsigned long	addRef () override
	Reference Interface instance More...

unsigned long	release () override
	Release Interface instance More...

unsigned long	refCount () const override
	Current reference count More...

Protected Member Functions
Gaudi::Details::PropertyBase *	property (std::string_view name) const

Private Types
typedef std::vector< Gaudi::Details::PropertyBase * >	Properties

typedef std::pair< std::string, std::pair< IProperty *, std::string > >	RemProperty

typedef std::vector< RemProperty >	RemoteProperties

Private Member Functions
Gaudi::Details::PropertyBase *	property (std::string_view name, const std::vector< Gaudi::Details::PropertyBase * > &props) const
	get the property by name form the proposed list More...

void	assertUniqueName (const std::string &name) const
	Throw an exception if the name is already present in the list of properties (see GAUDI-1023). More...

Private Attributes
Properties	m_properties
	Collection of all declared properties. More...

RemoteProperties	m_remoteProperties
	Collection of all declared remote properties. More...

std::vector< std::unique_ptr< Gaudi::Details::PropertyBase > >	m_todelete
	Properties to be deleted. More...

IInterface *	m_pOuter
	Interface hub reference (ApplicationMgr) More...

Additional Inherited Members
Public Types inherited from implements< IProperty >
using	base_class = implements< Interfaces... >
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...

using	iids = typename extend_interfaces_base::ext_iids

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

Protected Attributes inherited from implements< IProperty >
std::atomic_ulong	m_refCount
	Reference counter More...

Detailed Description

Property manager helper class. This class is used by algorithms and services for helping to manage its own set of properties. It implements the IProperty interface.

Author: Paul Maley; David Quarrie

Deprecated:: will be removed in v29r0, consider using PropertyHolder instead

Definition at line 43 of file PropertyMgr.h.

Member Typedef Documentation

◆ Properties

typedef std::vector<Gaudi::Details::PropertyBase*> PropertyMgr::Properties

private

Definition at line 142 of file PropertyMgr.h.

◆ RemoteProperties

typedef std::vector<RemProperty> PropertyMgr::RemoteProperties

private

Definition at line 144 of file PropertyMgr.h.

◆ RemProperty

typedef std::pair<std::string, std::pair<IProperty*, std::string> > PropertyMgr::RemProperty

private

Definition at line 143 of file PropertyMgr.h.

Constructor & Destructor Documentation

◆ PropertyMgr() [1/2]

PropertyMgr::PropertyMgr ( IInterface * iface = nullptr )

constructor from the interface

Definition at line 51 of file PropertyMgr.cpp.

                                             : m_pOuter( iface ) {
   addRef(); // initial reference count set to 1
 }

◆ PropertyMgr() [2/2]

PropertyMgr::PropertyMgr ( const PropertyMgr & )

delete

Member Function Documentation

◆ assertUniqueName()

void PropertyMgr::assertUniqueName ( const std::string & name ) const

private

Throw an exception if the name is already present in the list of properties (see GAUDI-1023).

Definition at line 212 of file PropertyMgr.cpp.

                                                                 {
   if ( !hasProperty( name ) ) return;
   auto msgSvc = Gaudi::svcLocator()->service<IMessageSvc>( "MessageSvc" );
   if ( !msgSvc ) std::cerr << "error: cannot get MessageSvc!" << std::endl;
   auto      owner = SmartIF<INamedInterface>( m_pOuter );
   MsgStream log( msgSvc, owner ? owner->name() : "PropertyMgr" );
   log << MSG::WARNING << "duplicated property name '" << name << "', see https://its.cern.ch/jira/browse/GAUDI-1023"
       << endmsg;
 }

◆ declareProperty() [1/6]

PropertyBase * PropertyMgr::declareProperty	(	const std::string &	name,
		Gaudi::DataHandle &	ref,
		const std::string &	doc = `"none"`
	)

Declare a property (specialization)

Definition at line 89 of file PropertyMgr.cpp.

                                                                                                               {
   assertUniqueName( name );
   auto p = m_todelete.emplace_back( std::make_unique<typename Gaudi::DataHandle::PropertyType>( name, ref ) ).get();
   //
   p->setDocumentation( doc );
   m_properties.push_back( p );
   //
   return p;
 }

◆ declareProperty() [2/6]

template<class TYPE >

Gaudi::Details::PropertyBase * PropertyMgr::declareProperty	(	const std::string &	name,
		Gaudi::Property< TYPE & > &	prop,
		const std::string &	doc = `"none"`
	)

inline

Declare a property (specialization)

Declare a property.

Definition at line 190 of file PropertyMgr.h.

                                                                                                       {
   assertUniqueName( name );
   Gaudi::Details::PropertyBase* p = &prop;
   //
   p->setName( name );
   p->setDocumentation( doc );
   m_properties.push_back( p );
   //
   return p;
 }

◆ declareProperty() [3/6]

template<class TYPE >

Gaudi::Details::PropertyBase * PropertyMgr::declareProperty	(	const std::string &	name,
		Gaudi::Property< TYPE > &	prop,
		const std::string &	doc = `"none"`
	)

inline

Declare a property (specialization)

Declare a property (templated)

Definition at line 174 of file PropertyMgr.h.

                                                                                           {
   assertUniqueName( name );
   Gaudi::Details::PropertyBase* p = &prop;
   //
   p->setName( name );
   p->setDocumentation( doc );
   m_properties.push_back( p );
   //
   return p;
 }

◆ declareProperty() [4/6]

PropertyBase * PropertyMgr::declareProperty	(	const std::string &	name,
		GaudiHandleArrayBase &	ref,
		const std::string &	doc = `"none"`
	)

Declare a property (specialization)

Definition at line 77 of file PropertyMgr.cpp.

                                                                    {
   assertUniqueName( name );
   auto p = m_todelete.emplace_back( std::make_unique<typename GaudiHandleArrayBase::PropertyType>( name, ref ) ).get();
   //
   p->setDocumentation( doc );
   m_properties.push_back( p );
   //
   return p;
 }

◆ declareProperty() [5/6]

PropertyBase * PropertyMgr::declareProperty	(	const std::string &	name,
		GaudiHandleBase &	ref,
		const std::string &	doc = `"none"`
	)

Declare a property (specialization)

Definition at line 67 of file PropertyMgr.cpp.

                                                                                                               {
   assertUniqueName( name );
   auto p = m_todelete.emplace_back( std::make_unique<typename GaudiHandleBase::PropertyType>( name, ref ) ).get();
   //
   p->setDocumentation( doc );
   m_properties.push_back( p );
   //
   return p;
 }

◆ declareProperty() [6/6]

template<class TYPE , typename >

Gaudi::Details::PropertyBase * PropertyMgr::declareProperty	(	const std::string &	name,
		TYPE &	value,
		const std::string &	doc = `"none"`
	)

inline

Declare a property (templated)

Definition at line 159 of file PropertyMgr.h.

                                                                                           {
   assertUniqueName( name );
   m_todelete.emplace_back( new Gaudi::Property<TYPE&>( name, value ) );
   Gaudi::Details::PropertyBase* p = m_todelete.back().get();
   //
   p->setDocumentation( doc );
   m_properties.push_back( p );
   //
   return p;
 }

◆ declareRemoteProperty()

PropertyBase * PropertyMgr::declareRemoteProperty	(	const std::string &	name,
		IProperty *	rsvc,
		const std::string &	rname = `""`
	)

Declare a remote property.

Definition at line 57 of file PropertyMgr.cpp.

                                                                                                                  {
   if ( !rsvc ) return nullptr;
   const std::string& nam = rname.empty() ? name : rname;
   PropertyBase*      p   = property( nam, rsvc->getProperties() );
   m_remoteProperties.emplace_back( name, std::make_pair( rsvc, nam ) );
   return p;
 }

◆ getProperties()

const std::vector< PropertyBase * > & PropertyMgr::getProperties ( ) const

override

get all properties

See also: IProperty

Definition at line 194 of file PropertyMgr.cpp.

194 { return m_properties; }

◆ getProperty() [1/3]

StatusCode PropertyMgr::getProperty ( Gaudi::Details::PropertyBase * p ) const

override

get the property

See also: IProperty

Definition at line 160 of file PropertyMgr.cpp.

                                                            {
   try {
     const PropertyBase* pp = property( p->name() );
     if ( pp && pp->load( *p ) ) return StatusCode::SUCCESS; // RETURN
   } catch ( ... ) {}
   return StatusCode::FAILURE; // RETURN
 }

◆ getProperty() [2/3]

StatusCode PropertyMgr::getProperty	(	std::string_view	n,
		std::string &	v
	)		const

override

convert the property to the string

See also: IProperty

Definition at line 182 of file PropertyMgr.cpp.

                                                                           {
   // get the property
   const PropertyBase* p = property( n );
   if ( !p ) return StatusCode::FAILURE;
   // convert the value into the string
   v = p->toString();
   //
   return StatusCode::SUCCESS;
 }

◆ getProperty() [3/3]

const PropertyBase & PropertyMgr::getProperty ( std::string_view name ) const

override

get the property by name

See also: IProperty

Definition at line 172 of file PropertyMgr.cpp.

                                                                         {
   const PropertyBase* p = property( name );
   if ( !p ) throw std::out_of_range( "Property " + std::string{ name } + " not found." ); // Not found
   return *p;                                                                              // RETURN
 }

◆ hasProperty()

bool PropertyMgr::hasProperty ( std::string_view name ) const

override

Return true if we have a property with the given name.

See also: IProperty

Definition at line 208 of file PropertyMgr.cpp.

                                                          {
   return any_of( begin( m_properties ), end( m_properties ),
                  [name]( const PropertyBase* prop ) { return noCaseCmp( prop->name(), name ); } );
 }

◆ operator=()

PropertyMgr& PropertyMgr::operator= ( const PropertyMgr & )

delete

◆ property() [1/2]

PropertyBase * PropertyMgr::property ( std::string_view name ) const

protected

Definition at line 109 of file PropertyMgr.cpp.

                                                                {
   // local property ?
   PropertyBase* lp = property( name, m_properties );
   if ( lp ) return lp; // RETURN
   // look for remote property
   for ( const auto& it : m_remoteProperties ) {
     if ( !noCaseCmp( it.first, name ) ) continue; // CONTINUE
     const IProperty* p = it.second.first;
     if ( !p ) continue;
     return property( it.second.second, p->getProperties() ); // RETURN
   }
   return nullptr; // RETURN
 }

◆ property() [2/2]

PropertyBase * PropertyMgr::property	(	std::string_view	name,
		const std::vector< Gaudi::Details::PropertyBase * > &	props
	)		const

private

get the property by name form the proposed list

Definition at line 101 of file PropertyMgr.cpp.

                                                                                                       {
   auto it = std::find_if( props.begin(), props.end(),
                           [=]( const PropertyBase* p ) { return p && noCaseCmp( p->name(), name ); } );
   return ( it != props.end() ) ? *it : nullptr; // RETURN
 }

◆ queryInterface()

StatusCode PropertyMgr::queryInterface	(	const InterfaceID &	iid,
		void **	pinterface
	)

override

Definition at line 198 of file PropertyMgr.cpp.

                                                                                   {
   // try local interfaces
   StatusCode sc = base_class::queryInterface( iid, pinterface );
   if ( sc.isSuccess() ) return sc;
   // fall back on the owner
   return m_pOuter ? m_pOuter->queryInterface( iid, pinterface ) : sc; // FAILURE
 }

◆ setProperty() [1/2]

StatusCode PropertyMgr::setProperty	(	const std::string &	name,
		const Gaudi::Details::PropertyBase &	p
	)

override

set the property form another property

See also: IProperty

Definition at line 127 of file PropertyMgr.cpp.

                                                                                   {
   PropertyBase* pp = property( name );
   try {
     if ( pp && pp->assign( p ) ) return StatusCode::SUCCESS;
   } // RETURN
   catch ( ... ) {}
   //
   return StatusCode::FAILURE;
 }

◆ setProperty() [2/2]

StatusCode PropertyMgr::setProperty ( const std::string & s )

override

set the property from the property formatted string

See also: IProperty

Definition at line 141 of file PropertyMgr.cpp.

                                                         {
   std::string name, value;
   StatusCode  sc = Gaudi::Parsers::parse( name, value, i );
   return sc.isFailure() ? sc : setPropertyRepr( name, value );
 }

◆ setPropertyRepr()

StatusCode PropertyMgr::setPropertyRepr	(	const std::string &	n,
		const std::string &	v
	)

override

set the property from name and the value

See also: IProperty

Definition at line 151 of file PropertyMgr.cpp.

                                                                                 {
   PropertyBase* p = property( n );
   return ( p && p->fromString( v ) ) ? StatusCode::SUCCESS : StatusCode::FAILURE;
 }

Member Data Documentation

◆ m_pOuter

IInterface* PropertyMgr::m_pOuter

private

Interface hub reference (ApplicationMgr)

Definition at line 153 of file PropertyMgr.h.

◆ m_properties

Properties PropertyMgr::m_properties

private

Collection of all declared properties.

Definition at line 147 of file PropertyMgr.h.

◆ m_remoteProperties

RemoteProperties PropertyMgr::m_remoteProperties

private

Collection of all declared remote properties.

Definition at line 149 of file PropertyMgr.h.

◆ m_todelete

std::vector<std::unique_ptr<Gaudi::Details::PropertyBase> > PropertyMgr::m_todelete

private

Properties to be deleted.

Definition at line 151 of file PropertyMgr.h.

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

GaudiKernel/include/GaudiKernel/PropertyMgr.h
GaudiKernel/src/Lib/PropertyMgr.cpp

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Properties

◆ RemoteProperties

◆ RemProperty

Constructor & Destructor Documentation

◆ PropertyMgr() [1/2]

◆ PropertyMgr() [2/2]

Member Function Documentation

◆ assertUniqueName()

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ declareRemoteProperty()

◆ getProperties()

◆ getProperty() [1/3]

◆ getProperty() [2/3]

◆ getProperty() [3/3]

◆ hasProperty()

◆ operator=()

◆ property() [1/2]

◆ property() [2/2]

◆ queryInterface()

◆ setProperty() [1/2]

◆ setProperty() [2/2]

◆ setPropertyRepr()

Member Data Documentation

◆ m_pOuter

◆ m_properties

◆ m_remoteProperties

◆ m_todelete