Property manager helper class. More...

#include <GaudiKernel/PropertyMgr.h>

Inheritance diagram for PropertyMgr:

Collaboration diagram for PropertyMgr:

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

	PropertyMgr (const PropertyMgr &)=delete

PropertyMgr &	operator= (const PropertyMgr &)=delete

	~PropertyMgr () override=default
	virtual destructor More...

template<class TYPE >
Property *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Declare a property (templated) More...

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

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

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

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

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

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

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

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

StatusCode	setProperty (const Property &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	setProperty (const std::string &n, const std::string &v) override
	set the property from name and the value More...

StatusCode	getProperty (Property *p) const override
	get the property More...

const Property &	getProperty (const std::string &name) const override
	get the property by name More...

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

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

bool	hasProperty (const std::string &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...

	~implements () override=default
	Virtual destructor. 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...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Member Functions
Property *	property (const std::string &name) const

Private Types
typedef std::vector< Property * >	Properties

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

typedef std::vector< RemProperty >	RemoteProperties

Private Member Functions
Property *	property (const std::string &name, const std::vector< Property * > &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< Property > >	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

Definition at line 37 of file PropertyMgr.h.

Member Typedef Documentation

typedef std::vector<Property*> PropertyMgr::Properties

private

Definition at line 166 of file PropertyMgr.h.

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

private

Definition at line 169 of file PropertyMgr.h.

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

private

Definition at line 168 of file PropertyMgr.h.

Constructor & Destructor Documentation

PropertyMgr::PropertyMgr ( IInterface * iface = nullptr )

constructor from the interface

Definition at line 52 of file PropertyMgr.cpp.

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

PropertyMgr::PropertyMgr ( const PropertyMgr & )

delete

PropertyMgr::~PropertyMgr ( )

overridedefault

virtual destructor

Member Function Documentation

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 207 of file PropertyMgr.cpp.

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

template<class TYPE >

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

inline

Declare a property (templated)

Definition at line 186 of file PropertyMgr.h.

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

template<class TYPE >

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

inline

Declare a property (specialization)

Declare a property (templated)

Definition at line 205 of file PropertyMgr.h.

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

template<class TYPE >

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

inline

Declare a property (specialization)

Declare a property (templated)

Definition at line 224 of file PropertyMgr.h.

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

template<class TYPE >

Property * PropertyMgr::declareProperty	(	const std::string &	name,
		ToolHandle< TYPE > &	ref,
		const std::string &	doc = `"none"`
	)

inline

Declare a property (specialization)

Definition at line 243 of file PropertyMgr.h.

 {
   assertUniqueName(name);
   m_todelete   . emplace_back ( new GaudiHandleProperty( name, ref ) );
   Property* p = m_todelete.back().get();
   //
   p -> setDocumentation    ( doc ) ;
   m_properties . push_back ( p   ) ;
   //
   return p ;
 }

template<class TYPE >

Property * PropertyMgr::declareProperty	(	const std::string &	name,
		ServiceHandle< TYPE > &	ref,
		const std::string &	doc = `"none"`
	)

inline

Declare a property (specialization)

Definition at line 260 of file PropertyMgr.h.

 {
   assertUniqueName(name);
   m_todelete   . emplace_back (new GaudiHandleProperty( name, ref ));
   Property* p = m_todelete.back().get();
   //
   p -> setDocumentation    ( doc ) ;
   m_properties . push_back ( p   ) ;
   //
   return p ;
 }

template<class TYPE >

Property * PropertyMgr::declareProperty	(	const std::string &	name,
		ToolHandleArray< TYPE > &	ref,
		const std::string &	doc = `"none"`
	)

inline

Declare a property (specialization)

Definition at line 277 of file PropertyMgr.h.

 {
   assertUniqueName(name);
   m_todelete   . emplace_back ( new GaudiHandleArrayProperty( name, ref ) );
   Property* p = m_todelete.back().get();
   //
   p -> setDocumentation    ( doc ) ;
   m_properties . push_back ( p   ) ;
   //
   return p ;
 }

template<class TYPE >

Property * PropertyMgr::declareProperty	(	const std::string &	name,
		ServiceHandleArray< TYPE > &	ref,
		const std::string &	doc = `"none"`
	)

inline

Declare a property (specialization)

Definition at line 294 of file PropertyMgr.h.

 {
   assertUniqueName(name);
   m_todelete   . emplace_back ( new GaudiHandleArrayProperty( name, ref ) );
   Property* p = m_todelete.back().get();
   //
   p -> setDocumentation    ( doc ) ;
   m_properties . push_back ( p   ) ;
   //
   return p ;
 }

template<class TYPE >

Property * PropertyMgr::declareProperty	(	const std::string &	name,
		DataObjectHandle< TYPE > &	ref,
		const std::string &	doc = `"none"`
	)

inline

Declare a property (specialization)

Definition at line 312 of file PropertyMgr.h.

 {
   assertUniqueName(name);
   Property* p = new DataObjectHandleProperty( name, ref );
   //
   p -> setDocumentation    ( doc ) ;
   m_properties . push_back ( p   ) ;
   //
   return p ;
 }

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

Declare a remote property.

Definition at line 61 of file PropertyMgr.cpp.

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

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

override

get all properties

See also: IProperty

Definition at line 186 of file PropertyMgr.cpp.

186 { return m_properties; }

PropertyMgr::m_properties

Properties m_properties

Collection of all declared properties.

Definition: PropertyMgr.h:172

StatusCode PropertyMgr::getProperty ( Property * p ) const

override

get the property

See also: IProperty

Definition at line 144 of file PropertyMgr.cpp.

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

const Property & PropertyMgr::getProperty ( const std::string & name ) const

override

get the property by name

See also: IProperty

Definition at line 159 of file PropertyMgr.cpp.

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

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

override

convert the property to the string

See also: IProperty

Definition at line 171 of file PropertyMgr.cpp.

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

bool PropertyMgr::hasProperty ( const std::string & name ) const

override

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

See also: IProperty

Definition at line 201 of file PropertyMgr.cpp.

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

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

delete

Property * PropertyMgr::property ( const std::string & name ) const

protected

Definition at line 85 of file PropertyMgr.cpp.

 {
   // local property ?
   Property* 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 ; }                          // CONTINUE
     return property ( it.second.second , p->getProperties() ) ; // RETURN
   }
   return nullptr ;                                    // RETURN
 }

Property * PropertyMgr::property	(	const std::string &	name,
		const std::vector< Property * > &	props
	)		const

private

get the property by name form the proposed list

Definition at line 75 of file PropertyMgr.cpp.

 {
   auto it = std::find_if( props.begin(), props.end(), PropByName{ name } ) ;
   return ( it != props.end() ) ? *it : nullptr;            // RETURN
 }

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

override

Definition at line 190 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
 }

StatusCode PropertyMgr::setProperty ( const Property & p )

override

set the property form another property

See also: IProperty

Definition at line 105 of file PropertyMgr.cpp.

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

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

override

set the property from the property formatted string

See also: IProperty

Definition at line 120 of file PropertyMgr.cpp.

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

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

override

set the property from name and the value

See also: IProperty

Definition at line 134 of file PropertyMgr.cpp.

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

Member Data Documentation

IInterface* PropertyMgr::m_pOuter

private

Interface hub reference (ApplicationMgr)

Definition at line 178 of file PropertyMgr.h.

Properties PropertyMgr::m_properties

private

Collection of all declared properties.

Definition at line 172 of file PropertyMgr.h.

RemoteProperties PropertyMgr::m_remoteProperties

private

Collection of all declared remote properties.

Definition at line 174 of file PropertyMgr.h.

std::vector<std::unique_ptr<Property> > PropertyMgr::m_todelete

private

Properties to be deleted.

Definition at line 176 of file PropertyMgr.h.

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

GaudiKernel/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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation