Property manager helper class. More...

#include <GaudiKernel/PropertyMgr.h>

Inheritance diagram for PropertyMgr:

Collaboration diagram for PropertyMgr:

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

	PropertyMgr (const PropertyMgr &)

virtual	~PropertyMgr ()
	virtual destructor More...

PropertyMgr &	operator= (const PropertyMgr &)

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

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

StatusCode	setProperty (const Property &p)
	set the property form another property More...

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

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

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

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

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

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

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

StatusCode	queryInterface (const InterfaceID &iid, void **pinterface)
	Set the void** to the pointer to the requested interface of the instance. More...

Public Member Functions inherited from extend_interfaces1< IProperty >
virtual	~extend_interfaces1 ()
	Virtual destructor. More...

Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 1)
	InterfaceID. More...

Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...

virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...

virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...

virtual unsigned long	release ()=0
	Release Interface instance. More...

virtual unsigned long	refCount () const =0
	Current reference count. More...

virtual	~IInterface ()
	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...

Properties	m_todelete
	Properties to be deleted. More...

std::vector< bool >	m_isOwned
	Flag to decide to delete or not a propertyRef. More...

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

Additional Inherited Members
Public Types inherited from implements1< IProperty >
typedef implements1	base_class
	Typedef to this class. More...

typedef extend_interfaces1< IProperty >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from extend_interfaces1< IProperty >
typedef IProperty::iid::iids::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...

typedef Gaudi::InterfaceId< IInterface, 0, 0 >	iid
	Interface ID. More...

typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...

Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. 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 34 of file PropertyMgr.h.

Member Typedef Documentation

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

private

Definition at line 158 of file PropertyMgr.h.

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

private

Definition at line 161 of file PropertyMgr.h.

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

private

Definition at line 160 of file PropertyMgr.h.

Constructor & Destructor Documentation

PropertyMgr::PropertyMgr ( IInterface * iface = 0 )

constructor from the interface

Definition at line 54 of file PropertyMgr.cpp.

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

PropertyMgr::PropertyMgr ( const PropertyMgr & right )

Definition at line 65 of file PropertyMgr.cpp.

   : IInterface(right),
     IProperty(right),
     extend_interfaces_base(right),
     base_class(right)
   , m_properties       ( right.m_properties       )
   , m_remoteProperties ( right.m_remoteProperties )
   , m_todelete         ( right.m_todelete         )
   , m_pOuter           ( right.m_pOuter )
 {
   addRef(); // initial reference count set to 1
   std::transform
     ( m_todelete.begin() , m_todelete.end  () ,
       m_todelete.begin() , std::mem_fun(&Property::clone));
 }

PropertyMgr::~PropertyMgr ( )

virtual

virtual destructor

delete all owned properties

Definition at line 83 of file PropertyMgr.cpp.

 {
   for ( Properties::iterator ip  = m_todelete.begin() ;
         m_todelete.end() != ip ; ++ip ) { delete *ip ; }
 }

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

                                                               {
   if (UNLIKELY(hasProperty(name))) {
     // TODO: queryInterface should be const
     // Note: using SmartIF causes a segfault in genconf (wrong ref. count)
     INamedInterface* owner = nullptr;
     std::string ownerName{"PropertyMgr"};
     if (m_pOuter &&
         const_cast<IInterface*>(m_pOuter)->queryInterface(INamedInterface::interfaceID(), (void**)&owner).isSuccess()) {
       ownerName = owner->name();
     }
     auto msgSvc = Gaudi::svcLocator()->service<IMessageSvc>("MessageSvc");
     MsgStream log(msgSvc, ownerName);
     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 182 of file PropertyMgr.h.

 {
   assertUniqueName(name);
   Property* p = new SimplePropertyRef<TYPE> ( name , value ) ;
   //
   p->setDocumentation( doc );
   m_properties .push_back( p ) ;
   m_todelete   .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 201 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 220 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 239 of file PropertyMgr.h.

 {
   assertUniqueName(name);
   Property* p = new GaudiHandleProperty( name, ref );
   //
   p -> setDocumentation    ( doc ) ;
   m_properties . push_back ( p   ) ;
   m_todelete   . 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 256 of file PropertyMgr.h.

 {
   assertUniqueName(name);
   Property* p = new GaudiHandleProperty( name, ref );
   //
   p -> setDocumentation    ( doc ) ;
   m_properties . push_back ( p   ) ;
   m_todelete   . 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 273 of file PropertyMgr.h.

 {
   assertUniqueName(name);
   Property* p = new GaudiHandleArrayProperty( name, ref );
   //
   p -> setDocumentation    ( doc ) ;
   m_properties . push_back ( p   ) ;
   m_todelete   . 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 290 of file PropertyMgr.h.

 {
   assertUniqueName(name);
   Property* p = new GaudiHandleArrayProperty( name, ref );
   //
   p -> setDocumentation    ( doc ) ;
   m_properties . push_back ( p   ) ;
   m_todelete   . 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 114 of file PropertyMgr.cpp.

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

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

virtual

get all properties

See also: IProperty

Implements IProperty.

Definition at line 249 of file PropertyMgr.cpp.

249 { return m_properties; }

PropertyMgr::m_properties

Properties m_properties

Collection of all declared properties.

Definition: PropertyMgr.h:166

StatusCode PropertyMgr::getProperty ( Property * p ) const

virtual

get the property

See also: IProperty

Implements IProperty.

Definition at line 205 of file PropertyMgr.cpp.

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

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

virtual

get the property by name

See also: IProperty

Implements IProperty.

Definition at line 221 of file PropertyMgr.cpp.

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

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

virtual

convert the property to the string

See also: IProperty

Implements IProperty.

Definition at line 234 of file PropertyMgr.cpp.

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

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

virtual

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

See also: IProperty

Implements IProperty.

Definition at line 264 of file PropertyMgr.cpp.

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

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

Definition at line 92 of file PropertyMgr.cpp.

 {
   if  ( &right == this ) { return *this ; }
   //
   for ( Properties::iterator ip  = m_todelete.begin() ;
         m_todelete.end() != ip ; ++ip ) { delete *ip ; }
   //
   m_properties       = right.m_properties       ;
   m_remoteProperties = right.m_remoteProperties ;
   m_todelete         = right.m_todelete         ;
   m_pOuter           = right.m_pOuter           ;
   //
   std::transform
     ( m_todelete.begin() , m_todelete.end  () ,
       m_todelete.begin() , std::mem_fun(&Property::clone));
   //
   return *this ;
 }

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

protected

Definition at line 140 of file PropertyMgr.cpp.

 {
   // local property ?
   Property* lp = property ( name , m_properties ) ;
   if ( 0 != lp ) { return lp ; }                       // RETURN
   // look for remote property
   Nocase cmp ;
   for ( RemoteProperties::const_iterator it = m_remoteProperties.begin() ;
         m_remoteProperties.end() != it ; ++it )
   {
     if ( !cmp(it->first,name) ) { continue ; }   // CONTINUE
     const IProperty* p = it->second.first ;
     if ( 0 == p               ) { continue ; }   // CONITNUE
     return property ( it->second.second , p->getProperties() ) ; // RETURN
   }
   return 0 ;                                           // 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 128 of file PropertyMgr.cpp.

 {
   Properties::const_iterator it =
     std::find_if ( props.begin() , props.end() , PropByName( name ) ) ;
   if ( props.end() != it ) { return *it ; }                // RETURN
   return 0 ;                                               // RETURN
 }

StatusCode PropertyMgr::queryInterface	(	const InterfaceID &	ti,
		void **	pp
	)

virtual

Set the void** to the pointer to the requested interface of the instance.

Implements IInterface.

Definition at line 253 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 (0 != m_pOuter)? m_pOuter->queryInterface(iid, pinterface)
                         : sc; // FAILURE
 }

StatusCode PropertyMgr::setProperty ( const Property & p )

virtual

set the property form another property

See also: IProperty

Implements IProperty.

Definition at line 162 of file PropertyMgr.cpp.

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

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

virtual

set the property from the property formatted string

See also: IProperty

Implements IProperty.

Definition at line 179 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
	)

virtual

set the property from name and the value

See also: IProperty

Implements IProperty.

Definition at line 193 of file PropertyMgr.cpp.

 {
   Property* p = property( n ) ;
   if ( 0 == p ) { return StatusCode::FAILURE ; }  // RETURN
   bool result =  p->fromString( v ) != 0 ;
   return result ? StatusCode::SUCCESS : StatusCode::FAILURE ;
 }

Member Data Documentation

std::vector<bool> PropertyMgr::m_isOwned

private

Flag to decide to delete or not a propertyRef.

Definition at line 172 of file PropertyMgr.h.

IInterface* PropertyMgr::m_pOuter

private

Interface hub reference (ApplicationMgr)

Definition at line 174 of file PropertyMgr.h.

Properties PropertyMgr::m_properties

private

Collection of all declared properties.

Definition at line 166 of file PropertyMgr.h.

RemoteProperties PropertyMgr::m_remoteProperties

private

Collection of all declared remote properties.

Definition at line 168 of file PropertyMgr.h.

Properties PropertyMgr::m_todelete

private

Properties to be deleted.

Definition at line 170 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