Implementation of property with value of concrete type. More...

#include <GaudiKernel/Property.h>

Inheritance diagram for Gaudi::Property< TYPE, VERIFIER, HANDLERS >:

Collaboration diagram for Gaudi::Property< TYPE, VERIFIER, HANDLERS >:

Public Types
using	StorageType = TYPE
	Hosted type. More...

using	ValueType = typename std::remove_reference< StorageType >::type

using	VerifierType = VERIFIER

using	HandlersType = HANDLERS

Public Member Functions
template<class T = StorageType>
	Property (std::string name, T &&value, std::string doc="")
	the constructor with property name, value and documentation. More...

template<typename OWNER , typename T = ValueType, typename = std::enable_if_t<std::is_base_of<IProperty, OWNER>::value>, typename = std::enable_if_t<std::is_default_constructible<T>::value>>
	Property (OWNER *owner, std::string name)
	Autodeclaring constructor with property name, value and documentation. More...

template<class OWNER , class T = StorageType, typename = std::enable_if_t<std::is_base_of<IProperty, OWNER>::value>>
	Property (OWNER *owner, std::string name, T &&value, std::string doc="")
	Autodeclaring constructor with property name, value and documentation. More...

template<typename T , typename = not_copying<T>>
	Property (T &&v)
	Construct an anonymous property from a value. More...

template<typename T = StorageType, typename = std::enable_if_t<!std::is_reference<T>::value>>
	Property ()
	Construct an anonymous property with default constructed value. More...

Details::PropertyBase &	declareReadHandler (std::function< void(Details::PropertyBase &)> fun) override
	set new callback for reading More...

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

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

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

bool	useUpdateHandler () override
	manual trigger for callback for update More...

	operator const ValueType & () const
	Automatic conversion to value (const reference). More...

template<class T >
bool	operator== (const T &other) const
	equality comparison More...

template<class T >
bool	operator!= (const T &other) const
	inequality comparison More...

template<class T >
bool	operator< (const T &other) const
	"less" comparison More...

template<class T = ValueType>
Property &	operator= (T &&v)
	Assignment from value. More...

const VerifierType &	verifier () const
	Accessor to verifier. More...

VerifierType &	verifier ()
	Accessor to verifier. More...

template<class... Args>
decltype(	operator() (Args &&...args) const noexcept(noexcept(std::declval< ValueType >()(std::declval< Args && >()...))) std::declval< ValueType >()(std::declval< Args && >()...))

bool	assign (const Details::PropertyBase &source) override
	get the value from another property More...

bool	load (Details::PropertyBase &dest) const override
	set value to another property More...

StatusCode	fromString (const std::string &source) override
	string -> value More...

std::string	toString () const override
	value -> string More...

void	toStream (std::ostream &out) const override
	value -> stream More...


const ValueType &	value () const
	Backward compatibility (. More...

ValueType &	value ()

bool	setValue (const ValueType &v)

bool	set (const ValueType &v)

Details::PropertyBase *	clone () const override
	clones the current property More...

Helpers for easy use of string and vector properties.
They are instantiated only if they are implemented in the wrapped class.
template<class = ValueType>
Property &	operator++ ()

template<class = ValueType>
ValueType	operator++ (int)

template<class = ValueType>
Property &	operator-- ()

template<class = ValueType>
ValueType	operator-- (int)

template<class T = ValueType>
Property &	operator+= (const T &other)

template<class T = ValueType>
Property &	operator-= (const T &other)

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

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

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

std::string	type () const
	property type 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 ()=default
	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...

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 Types

template<class T >
using	is_this_type = std::is_same< Property, std::remove_reference_t< T >>
	helper typedefs for SFINAE More...

template<class T >
using	not_copying = std::enable_if_t<!is_this_type< T >::value >

Private Attributes
StorageType	m_value
	Storage. More...

VerifierType	m_verifier

HandlersType	m_handlers

Additional Inherited Members
Protected Member Functions inherited from Gaudi::Details::PropertyBase
	PropertyBase (const std::type_info &type, std::string name="", std::string doc="")
	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

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>
class Gaudi::Property< TYPE, VERIFIER, HANDLERS >

Implementation of property with value of concrete type.

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2006-02-27

Author: Marco Clemencic

Date: 2016-06-16

Definition at line 381 of file Property.h.

Member Typedef Documentation

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

using Gaudi::Property< TYPE, VERIFIER, HANDLERS >::HandlersType = HANDLERS

Definition at line 389 of file Property.h.

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class T >

using Gaudi::Property< TYPE, VERIFIER, HANDLERS >::is_this_type = std::is_same<Property, std::remove_reference_t<T>>

private

helper typedefs for SFINAE

Definition at line 399 of file Property.h.

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class T >

using Gaudi::Property< TYPE, VERIFIER, HANDLERS >::not_copying = std::enable_if_t<!is_this_type<T>::value>

private

Definition at line 401 of file Property.h.

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

using Gaudi::Property< TYPE, VERIFIER, HANDLERS >::StorageType = TYPE

Hosted type.

Definition at line 386 of file Property.h.

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

using Gaudi::Property< TYPE, VERIFIER, HANDLERS >::ValueType = typename std::remove_reference<StorageType>::type

Definition at line 387 of file Property.h.

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

using Gaudi::Property< TYPE, VERIFIER, HANDLERS >::VerifierType = VERIFIER

Definition at line 388 of file Property.h.

Constructor & Destructor Documentation

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class T = StorageType>

Gaudi::Property< TYPE, VERIFIER, HANDLERS >::Property	(	std::string	name,
		T &&	value,
		std::string	doc = `""`
	)

inline

the constructor with property name, value and documentation.

Definition at line 407 of file Property.h.

         : Details::PropertyBase( typeid( ValueType ), std::move( name ), std::move( doc ) )
         , m_value( std::forward<T>( value ) )
     {
       m_verifier( m_value );
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<typename OWNER , typename T = ValueType, typename = std::enable_if_t<std::is_base_of<IProperty, OWNER>::value>, typename = std::enable_if_t<std::is_default_constructible<T>::value>>

Gaudi::Property< TYPE, VERIFIER, HANDLERS >::Property	(	OWNER *	owner,
		std::string	name
	)

inline

Autodeclaring constructor with property name, value and documentation.

Note: the use std::enable_if is required to avoid ambiguities

Definition at line 418 of file Property.h.

                                                     : Property( std::move( name ), ValueType{}, "" )
     {
       owner->declareProperty( *this );
       setOwnerType<OWNER>();
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class OWNER , class T = StorageType, typename = std::enable_if_t<std::is_base_of<IProperty, OWNER>::value>>

Gaudi::Property< TYPE, VERIFIER, HANDLERS >::Property	(	OWNER *	owner,
		std::string	name,
		T &&	value,
		std::string	doc = `""`
	)

inline

Autodeclaring constructor with property name, value and documentation.

Note: the use std::enable_if is required to avoid ambiguities

Definition at line 427 of file Property.h.

         : Property( std::move( name ), std::forward<T>( value ), std::move( doc ) )
     {
       owner->declareProperty( *this );
       setOwnerType<OWNER>();
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<typename T , typename = not_copying<T>>

Gaudi::Property< TYPE, VERIFIER, HANDLERS >::Property ( T && v )

inline

Construct an anonymous property from a value.

This constructor is not generated if T is the current type, so that the compiler picks up the copy constructor instead of this one.

Definition at line 438 of file Property.h.

                       : Details::PropertyBase( typeid( ValueType ), "", "" ), m_value( std::forward<T>( v ) )
     {
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<typename T = StorageType, typename = std::enable_if_t<!std::is_reference<T>::value>>

Gaudi::Property< TYPE, VERIFIER, HANDLERS >::Property ( )

inline

Construct an anonymous property with default constructed value.

Can be used only if StorageType is default constructible.

Definition at line 445 of file Property.h.

                : Details::PropertyBase( typeid( ValueType ), "", "" ), m_value()
     {
     }

Member Function Documentation

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

bool Gaudi::Property< TYPE, VERIFIER, HANDLERS >::assign ( const Details::PropertyBase & source )

inlineoverridevirtual

get the value from another property

Implements Gaudi::Details::PropertyBase.

Definition at line 701 of file Property.h.

     {
       // Check if the property of is of "the same" type, except for strings
       const Property* p =
           ( std::is_same<ValueType, std::string>::value ) ? nullptr : dynamic_cast<const Property*>( &source );
       if ( p ) {
         *this = p->value();
       } else {
         this->fromString( source.toString() ).ignore();
       }
       return true;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

Details::PropertyBase* Gaudi::Property< TYPE, VERIFIER, HANDLERS >::clone ( ) const

inlineoverridevirtual

clones the current property

Implements Gaudi::Details::PropertyBase.

Definition at line 552 of file Property.h.

552 { return new Property( *this ); }

Gaudi::Property::Property

Property()

Construct an anonymous property with default constructed value.

Definition: Property.h:445

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

Details::PropertyBase& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::declareReadHandler ( std::function< void(Details::PropertyBase &)> fun )

inlineoverridevirtual

set new callback for reading

Implements Gaudi::Details::PropertyBase.

Definition at line 453 of file Property.h.

     {
       m_handlers.setReadHandler( std::move( fun ) );
       return *this;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

Details::PropertyBase& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::declareUpdateHandler ( std::function< void(Details::PropertyBase &)> fun )

inlineoverridevirtual

set new callback for update

Implements Gaudi::Details::PropertyBase.

Definition at line 459 of file Property.h.

     {
       m_handlers.setUpdateHandler( std::move( fun ) );
       return *this;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

StatusCode Gaudi::Property< TYPE, VERIFIER, HANDLERS >::fromString ( const std::string & source )

inlineoverridevirtual

string -> value

Implements Gaudi::Details::PropertyBase.

Definition at line 720 of file Property.h.

     {
       using Converter = Details::Property::StringConverter<ValueType>;
       *this           = Converter().fromString( m_value, source );
       return StatusCode::SUCCESS;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

bool Gaudi::Property< TYPE, VERIFIER, HANDLERS >::load ( Details::PropertyBase & dest ) const

inlineoverridevirtual

set value to another property

Implements Gaudi::Details::PropertyBase.

Definition at line 714 of file Property.h.

     {
       // delegate to the 'opposite' method
       return dest.assign( *this );
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator const ValueType & ( ) const

inline

Automatic conversion to value (const reference).

Definition at line 484 of file Property.h.

     {
       m_handlers.useReadHandler( *this );
       return m_value;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class T >

bool Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator!= ( const T & other ) const

inline

inequality comparison

Definition at line 504 of file Property.h.

     {
       return m_value != other;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class... Args>

decltype( Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator() ( Args &&... args ) const

inlinenoexcept

Definition at line 693 of file Property.h.

     {
       return value()( std::forward<Args>( args )... );
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class = ValueType>

Property& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator++ ( )

inline

Definition at line 624 of file Property.h.

     {
       ++value();
       return *this;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class = ValueType>

ValueType Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator++ ( int )

inline

Definition at line 630 of file Property.h.

     {
       return m_value++;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class T = ValueType>

Property& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator+= ( const T & other )

inline

Definition at line 646 of file Property.h.

     {
       m_value += other;
       return *this;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class = ValueType>

Property& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator-- ( )

inline

Definition at line 635 of file Property.h.

     {
       --value();
       return *this;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class = ValueType>

ValueType Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator-- ( int )

inline

Definition at line 641 of file Property.h.

     {
       return m_value--;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class T = ValueType>

Property& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator-= ( const T & other )

inline

Definition at line 652 of file Property.h.

     {
       m_value -= other;
       return *this;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class T >

bool Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator< ( const T & other ) const

inline

"less" comparison

Definition at line 511 of file Property.h.

     {
       return m_value < other;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class T = ValueType>

Property& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator= ( T && v )

inline

Assignment from value.

Definition at line 525 of file Property.h.

     {
       m_verifier( v );
       m_value = std::forward<T>( v );
       m_handlers.useUpdateHandler( *this );
       return *this;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

template<class T >

bool Gaudi::Property< TYPE, VERIFIER, HANDLERS >::operator== ( const T & other ) const

inline

equality comparison

Definition at line 497 of file Property.h.

     {
       return m_value == other;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

const std::function<void( Details::PropertyBase& )> Gaudi::Property< TYPE, VERIFIER, HANDLERS >::readCallBack ( ) const

inlineoverridevirtual

get a reference to the readCallBack

Implements Gaudi::Details::PropertyBase.

Definition at line 466 of file Property.h.

     {
       return m_handlers.getReadHandler();
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

bool Gaudi::Property< TYPE, VERIFIER, HANDLERS >::set ( const ValueType & v )

inline

Definition at line 547 of file Property.h.

     {
       *this = v;
       return true;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

bool Gaudi::Property< TYPE, VERIFIER, HANDLERS >::setValue ( const ValueType & v )

inline

Definition at line 542 of file Property.h.

     {
       *this = v;
       return true;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

void Gaudi::Property< TYPE, VERIFIER, HANDLERS >::toStream ( std::ostream & out ) const

inlineoverridevirtual

value -> stream

Implements Gaudi::Details::PropertyBase.

Definition at line 733 of file Property.h.

     {
       m_handlers.useReadHandler( *this );
       using Utils::toStream;
       toStream( m_value, out );
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

std::string Gaudi::Property< TYPE, VERIFIER, HANDLERS >::toString ( ) const

inlineoverridevirtual

value -> string

Implements Gaudi::Details::PropertyBase.

Definition at line 727 of file Property.h.

     {
       using Converter = Details::Property::StringConverter<ValueType>;
       return Converter().toString( *this );
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

const std::function<void( Details::PropertyBase& )> Gaudi::Property< TYPE, VERIFIER, HANDLERS >::updateCallBack ( ) const

inlineoverridevirtual

get a reference to the updateCallBack

Implements Gaudi::Details::PropertyBase.

Definition at line 471 of file Property.h.

     {
       return m_handlers.getUpdateHandler();
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

bool Gaudi::Property< TYPE, VERIFIER, HANDLERS >::useUpdateHandler ( )

inlineoverridevirtual

manual trigger for callback for update

Implements Gaudi::Details::PropertyBase.

Definition at line 477 of file Property.h.

     {
       m_handlers.useUpdateHandler( *this );
       return true;
     }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

const ValueType& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::value ( ) const

inline

Backward compatibility (.

Deprecated:: will be removed)

Definition at line 540 of file Property.h.

540 { return *this; }

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

ValueType& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::value ( )

inline

Definition at line 541 of file Property.h.

541 { return const_cast<ValueType&>( (const ValueType&)*this ); }

Gaudi::Property::ValueType

typename std::remove_reference< StorageType >::type ValueType

Definition: Property.h:387

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

const VerifierType& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::verifier ( ) const

inline

Accessor to verifier.

Definition at line 534 of file Property.h.

534 { return m_verifier; }

Gaudi::Property::m_verifier

VerifierType m_verifier

Definition: Property.h:394

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

VerifierType& Gaudi::Property< TYPE, VERIFIER, HANDLERS >::verifier ( )

inline

Accessor to verifier.

Definition at line 536 of file Property.h.

536 { return m_verifier; }

Gaudi::Property::m_verifier

VerifierType m_verifier

Definition: Property.h:394

Member Data Documentation

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

HandlersType Gaudi::Property< TYPE, VERIFIER, HANDLERS >::m_handlers

private

Definition at line 395 of file Property.h.

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

StorageType Gaudi::Property< TYPE, VERIFIER, HANDLERS >::m_value

private

Storage.

Definition at line 393 of file Property.h.

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>

VerifierType Gaudi::Property< TYPE, VERIFIER, HANDLERS >::m_verifier

private

Definition at line 394 of file Property.h.

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

GaudiKernel/GaudiKernel/Property.h

Public Types

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler> class Gaudi::Property< TYPE, VERIFIER, HANDLERS >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TYPE, class VERIFIER = Details::Property::NullVerifier, class HANDLERS = Details::Property::UpdateHandler>
class Gaudi::Property< TYPE, VERIFIER, HANDLERS >