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

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

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

[legend]

Public Types
using	StorageType = TYPE(&)[N]
	Hosted type. More...

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

using	VerifierType = VERIFIER

using	HandlersType = HANDLERS

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

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

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

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

Property &	operator= (const ValueType &v)
	Assignment from value. More...

const VerifierType &	verifier () const
	Copy constructor. More...

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

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

bool	load (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)

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.
size_t	size () const

bool	empty () const

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

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
StorageType	m_value
	Storage. More...

VerifierType	m_verifier

HandlersType	m_handlers

template<class T >
using	not_copying = std::enable_if<!is_this_type_v< T > >

template<class T >
static constexpr bool	is_this_type_v = std::is_same_v<Property, typename std::remove_reference_t<T>>
	helper typedefs for SFINAE 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

template<class TYPE, size_t N, class VERIFIER, class HANDLERS>
class Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >

Definition at line 20 of file CArrayAsProperty.h.

Member Typedef Documentation

◆ HandlersType

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

Definition at line 27 of file CArrayAsProperty.h.

◆ not_copying

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

template<class T >

using Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::not_copying = std::enable_if<!is_this_type_v<T> >

private

Definition at line 39 of file CArrayAsProperty.h.

◆ StorageType

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

using Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::StorageType = TYPE ( & )[N]

Hosted type.

Definition at line 24 of file CArrayAsProperty.h.

◆ ValueType

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

Definition at line 25 of file CArrayAsProperty.h.

◆ VerifierType

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

Definition at line 26 of file CArrayAsProperty.h.

Constructor & Destructor Documentation

◆ Property()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::Property	(	std::string	name,
		StorageType	value,
		std::string	doc = `""`
	)

inline

the constructor with property name, value and documentation.

Definition at line 44 of file CArrayAsProperty.h.

         : PropertyBase( typeid( ValueType ), std::move( name ), std::move( doc ) ), m_value( value ) {
       m_verifier( m_value );
     }

Member Function Documentation

◆ assign()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inlineoverride

get the value from another property

Definition at line 134 of file CArrayAsProperty.h.

                                                        {
       // Is the property of "the same" type?
       const Property* p = dynamic_cast<const Property*>( &source );
       if ( p ) {
         *this = p->value();
       } else {
         this->fromString( source.toString() ).ignore();
       }
       return true;
     }

◆ clone()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

PropertyBase* Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::clone ( ) const

inlineoverridevirtual

clones the current property

Implements Gaudi::Details::PropertyBase.

Definition at line 114 of file CArrayAsProperty.h.

114 { return new Property( *this ); }

◆ declareReadHandler()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inlineoverride

set new callback for reading

Definition at line 53 of file CArrayAsProperty.h.

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

◆ declareUpdateHandler()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inlineoverride

set new callback for update

Definition at line 58 of file CArrayAsProperty.h.

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

◆ empty()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

bool Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::empty ( ) const

inline

Definition at line 121 of file CArrayAsProperty.h.

121 { return false; }

◆ fromString()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inlineoverridevirtual

string -> value

Implements Gaudi::Details::PropertyBase.

Definition at line 150 of file CArrayAsProperty.h.

                                                               {
       ValueType tmp;
       if ( Parsers::parse( tmp, source ).isSuccess() ) {
         *this = tmp;
       } else {
         throw std::invalid_argument( "cannot parse '" + source + "' to " + this->type() );
       }
       return StatusCode::SUCCESS;
     }

◆ load()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inlineoverride

set value to another property

Definition at line 145 of file CArrayAsProperty.h.

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

◆ operator const ValueType &()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inline

Automatic conversion to value (const reference).

Definition at line 75 of file CArrayAsProperty.h.

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

◆ operator=()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

Property& Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::operator= ( const ValueType & v )

inline

Assignment from value.

Definition at line 86 of file CArrayAsProperty.h.

                                               {
       m_verifier( v );
       for ( size_t i = 0; i != N; ++i ) { m_value[i] = v[i]; }
       m_handlers.useUpdateHandler( *this );
       return *this;
     }

◆ readCallBack()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inlineoverridevirtual

get a reference to the readCallBack

Implements Gaudi::Details::PropertyBase.

Definition at line 64 of file CArrayAsProperty.h.

64 { return m_handlers.getReadHandler(); }

◆ set()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inline

Definition at line 110 of file CArrayAsProperty.h.

                                    {
       *this = v;
       return true;
     }

◆ setValue()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inline

Definition at line 106 of file CArrayAsProperty.h.

                                                     {
       *this = v;
       return true;
     }

◆ size()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

size_t Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::size ( ) const

inline

Definition at line 120 of file CArrayAsProperty.h.

120 { return N; }

◆ toStream()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inlineoverridevirtual

value -> stream

Implements Gaudi::Details::PropertyBase.

Definition at line 165 of file CArrayAsProperty.h.

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

◆ toString()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inlineoverridevirtual

value -> string

Implements Gaudi::Details::PropertyBase.

Definition at line 160 of file CArrayAsProperty.h.

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

◆ updateCallBack()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inlineoverridevirtual

get a reference to the updateCallBack

Implements Gaudi::Details::PropertyBase.

Definition at line 66 of file CArrayAsProperty.h.

66 { return m_handlers.getUpdateHandler(); }

◆ useUpdateHandler()

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inlineoverridevirtual

manual trigger for callback for update

Implements Gaudi::Details::PropertyBase.

Definition at line 69 of file CArrayAsProperty.h.

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

◆ value() [1/2]

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inline

Definition at line 105 of file CArrayAsProperty.h.

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

◆ value() [2/2]

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inline

Backward compatibility.

Deprecated:: will be removed in v29r0

Definition at line 104 of file CArrayAsProperty.h.

104 { return *this; }

◆ verifier() [1/2]

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inline

Accessor to verifier.

Definition at line 100 of file CArrayAsProperty.h.

100 { return m_verifier; }

◆ verifier() [2/2]

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

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

inline

Copy constructor.

Accessor to verifier.

Definition at line 98 of file CArrayAsProperty.h.

98 { return m_verifier; }

Member Data Documentation

◆ is_this_type_v

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

template<class T >

constexpr bool Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::is_this_type_v = std::is_same_v<Property, typename std::remove_reference_t<T>>

inlinestaticconstexprprivate

helper typedefs for SFINAE

Definition at line 37 of file CArrayAsProperty.h.

◆ m_handlers

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

HandlersType Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::m_handlers

private

Definition at line 33 of file CArrayAsProperty.h.

◆ m_value

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

StorageType Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::m_value

private

Storage.

Definition at line 31 of file CArrayAsProperty.h.

◆ m_verifier

template<class TYPE , size_t N, class VERIFIER , class HANDLERS >

VerifierType Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >::m_verifier

private

Definition at line 32 of file CArrayAsProperty.h.

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

GaudiKernel/include/GaudiKernel/CArrayAsProperty.h

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class TYPE, size_t N, class VERIFIER, class HANDLERS> class Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >

Member Typedef Documentation

◆ HandlersType

◆ not_copying

◆ StorageType

◆ ValueType

◆ VerifierType

Constructor & Destructor Documentation

◆ Property()

Member Function Documentation

◆ assign()

◆ clone()

◆ declareReadHandler()

◆ declareUpdateHandler()

◆ empty()

◆ fromString()

◆ load()

◆ operator const ValueType &()

◆ operator=()

◆ readCallBack()

◆ set()

◆ setValue()

◆ size()

◆ toStream()

◆ toString()

◆ updateCallBack()

◆ useUpdateHandler()

◆ value() [1/2]

◆ value() [2/2]

◆ verifier() [1/2]

◆ verifier() [2/2]

Member Data Documentation

◆ is_this_type_v

◆ m_handlers

◆ m_value

◆ m_verifier

template<class TYPE, size_t N, class VERIFIER, class HANDLERS>
class Gaudi::Property< TYPE[N], VERIFIER, HANDLERS >