Property Class Reference

Property base class allowing Property* collections to be "homogeneous". More...

#include <GaudiKernel/Property.h>

Inheritance diagram for Property:

Collaboration diagram for Property:

Public Member Functions
const std::string &	name () const
	property name More...
const 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...
virtual bool	load (Property &dest) const =0
	export the property value to the destination More...
virtual bool	assign (const Property &source)=0
	import the property value form the source More...
virtual std::string	toString () const =0
	value -> string More...
virtual void	toStream (std::ostream &out) const =0
	value -> stream More...
virtual StatusCode	fromString (const std::string &value)=0
	string -> value More...
const std::function< void(Property &)> &	readCallBack () const
	get a reference to the readCallBack More...
const std::function< void(Property &)> &	updateCallBack () const
	get a reference to the updateCallBack More...
virtual Property &	declareReadHandler (std::function< void(Property &)> fun)
	set new callback for reading More...
virtual Property &	declareUpdateHandler (std::function< void(Property &)> fun)
	set new callback for update More...
template<class HT >
Property &	declareReadHandler (void(HT::*MF)(Property &), HT *instance)
template<class HT >
Property &	declareUpdateHandler (void(HT::*MF)(Property &), HT *instance)
virtual void	useReadHandler () const
	use the call-back function at reading More...
virtual bool	useUpdateHandler ()
	use the call-back function at update More...
virtual	~Property ()=default
	virtual destructor More...
virtual Property *	clone () const =0
	clone: "virtual constructor" More...
void	setName (std::string value)
	set the new value for the property name More...
void	setDocumentation (std::string documentation)
	set the documentation string More...
virtual std::ostream &	fillStream (std::ostream &) const
	the printout of the property value More...

Protected Member Functions
	Property (const std::type_info &type, std::string name="")
	constructor from the property name and the type More...
	Property (std::string name, const std::type_info &type)
	constructor from the property name and the type More...
	Property (const Property &)=default
	copy constructor More...
Property &	operator= (const Property &)=default
	assignment operator More...

Protected Attributes
std::function< void(Property &)>	m_readCallBack
std::function< void(Property &)>	m_updateCallBack

Private Member Functions
	Property ()

Private Attributes
std::string	m_name
std::string	m_documentation
const std::type_info *	m_typeinfo

Detailed Description

Property base class allowing Property* collections to be "homogeneous".

Author

Paul Maley

CTDay

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

Definition at line 38 of file Property.h.

Constructor & Destructor Documentation

Property::Property ( )

private

virtual Property::~Property ( )

virtualdefault

virtual destructor

Property::Property ( const std::type_info &  type, std::string  name = ""  )

protected

constructor from the property name and the type

Definition at line 42 of file Property.cpp.

  : m_name            ( std::move(name) )
  , m_documentation   ( m_name )
  , m_typeinfo        ( &type )
{}

Property::Property ( std::string  name, const std::type_info &  type  )

protected

constructor from the property name and the type

Definition at line 55 of file Property.cpp.

  : m_name            ( std::move(name) )
  , m_documentation   ( m_name )
  , m_typeinfo        ( &type )
{}

Property::Property ( const Property &  )

protecteddefault

copy constructor

Member Function Documentation

virtual bool Property::assign ( const Property &  source )

pure virtual

import the property value form the source

Implemented in GaudiHandleArrayProperty, GaudiHandleProperty, PropertyWithValue< TYPE >, PropertyWithValue< double >, PropertyWithValue< std::string >, PropertyWithValue< std::vector< std::string > >, PropertyWithValue< int >, PropertyWithValue< unsigned int >, PropertyWithValue< bool >, DataObjIDCollProperty, PropertyList, DataObjIDProperty, and DataObjectHandleProperty.

virtual Property* Property::clone ( ) const

pure virtual

clone: "virtual constructor"

Implemented in GaudiHandleArrayProperty, GaudiHandleProperty, SimplePropertyRef< TYPE, VERIFIER >, SimpleProperty< TYPE, VERIFIER >, SimpleProperty< double >, SimpleProperty< std::string >, SimpleProperty< std::vector< std::string > >, SimpleProperty< int >, SimpleProperty< unsigned int >, SimpleProperty< bool >, DataObjIDCollProperty, DataObjIDProperty, and DataObjectHandleProperty.

Property & Property::declareReadHandler ( std::function< void(Property &)>  fun )

virtual

set new callback for reading

Definition at line 64 of file Property.cpp.

{
  m_readCallBack = std::move(fun);
  return *this;
}

template<class HT >

Property& Property::declareReadHandler ( void(HT::*)(Property &)  MF, HT *  instance  )

inline

Definition at line 75 of file Property.h.

  { return declareReadHandler( [=](Property& p) { (instance->*MF)(p); } ) ; }

Property & Property::declareUpdateHandler ( std::function< void(Property &)>  fun )

virtual

set new callback for update

Definition at line 72 of file Property.cpp.

{
  m_updateCallBack = std::move(fun);
  return *this;
}

template<class HT >

Property& Property::declareUpdateHandler ( void(HT::*)(Property &)  MF, HT *  instance  )

inline

Definition at line 79 of file Property.h.

  { return declareUpdateHandler ( [=](Property& p) { (instance->*MF)(p); } ); }

const std::string& Property::documentation ( ) const

inline

property documentation

Definition at line 47 of file Property.h.

{ return m_documentation; }

std::ostream & Property::fillStream ( std::ostream &  stream ) const

virtual

the printout of the property value

Definition at line 111 of file Property.cpp.

{ return stream << " '" <<name() << "':" << toString() ; }

virtual StatusCode Property::fromString ( const std::string &  value )

pure virtual

string -> value

Implemented in GaudiHandleArrayProperty, GaudiHandleProperty, PropertyWithValue< TYPE >, PropertyWithValue< double >, PropertyWithValue< std::string >, PropertyWithValue< std::vector< std::string > >, PropertyWithValue< int >, PropertyWithValue< unsigned int >, PropertyWithValue< bool >, DataObjIDCollProperty, DataObjIDProperty, and DataObjectHandleProperty.

virtual bool Property::load ( Property &  dest ) const

pure virtual

export the property value to the destination

Implemented in GaudiHandleArrayProperty, GaudiHandleProperty, PropertyWithValue< TYPE >, PropertyWithValue< double >, PropertyWithValue< std::string >, PropertyWithValue< std::vector< std::string > >, PropertyWithValue< int >, PropertyWithValue< unsigned int >, PropertyWithValue< bool >, DataObjIDCollProperty, PropertyList, DataObjIDProperty, and DataObjectHandleProperty.

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

inline

property name

Definition at line 45 of file Property.h.

{ return m_name             ; }

Property& Property::operator= ( const Property &  )

protecteddefault

assignment operator

const std::function<void(Property&)>& Property::readCallBack ( ) const

inline

get a reference to the readCallBack

Definition at line 65 of file Property.h.

{ return m_readCallBack; }

void Property::setDocumentation ( std::string  documentation )

inline

set the documentation string

Definition at line 94 of file Property.h.

                                                   {
    m_documentation = std::move(documentation); }

void Property::setName ( std::string  value )

inline

set the new value for the property name

Definition at line 92 of file Property.h.

{ m_name = std::move(value) ; }

virtual void Property::toStream ( std::ostream &  out ) const

pure virtual

value -> stream

Implemented in GaudiHandleArrayProperty, GaudiHandleProperty, PropertyWithValue< TYPE >, PropertyWithValue< double >, PropertyWithValue< std::string >, PropertyWithValue< std::vector< std::string > >, PropertyWithValue< int >, PropertyWithValue< unsigned int >, PropertyWithValue< bool >, DataObjIDCollProperty, DataObjIDProperty, and DataObjectHandleProperty.

virtual std::string Property::toString ( ) const

pure virtual

value -> string

Implemented in GaudiHandleArrayProperty, GaudiHandleProperty, PropertyWithValue< TYPE >, PropertyWithValue< double >, PropertyWithValue< std::string >, PropertyWithValue< std::vector< std::string > >, PropertyWithValue< int >, PropertyWithValue< unsigned int >, PropertyWithValue< bool >, DataObjIDCollProperty, DataObjIDProperty, and DataObjectHandleProperty.

std::string Property::type ( ) const

inline

property type

Definition at line 51 of file Property.h.

{ return m_typeinfo->name() ; }

const std::type_info* Property::type_info ( ) const

inline

property type-info

Definition at line 49 of file Property.h.

{ return m_typeinfo         ; }

const std::function<void(Property&)>& Property::updateCallBack ( ) const

inline

get a reference to the updateCallBack

Definition at line 67 of file Property.h.

{ return m_updateCallBack; }

void Property::useReadHandler ( ) const

virtual

use the call-back function at reading

Definition at line 80 of file Property.cpp.

{
  if ( !m_readCallBack ) { return ; }               // RETURN
  // avoid infinite loop
  std::function<void(Property&)> theCallBack;
  theCallBack.swap(m_readCallBack);
  theCallBack( const_cast<Property&>(*this) ) ;
  m_readCallBack.swap(theCallBack);
}

bool Property::useUpdateHandler ( )

virtual

use the call-back function at update

Definition at line 92 of file Property.cpp.

{
  bool sc(true);
  if ( !m_updateCallBack ) { return sc; }  // RETURN
  // avoid infinite loop
  std::function<void(Property&)> theCallBack;
  theCallBack.swap(m_updateCallBack);
  try {
    theCallBack( *this ) ;
  } catch(...) {
    sc = false;
  }
  m_updateCallBack.swap(theCallBack);
  return sc;
}

Member Data Documentation

std::string Property::m_documentation

private

Definition at line 115 of file Property.h.

std::string Property::m_name

private

Definition at line 113 of file Property.h.

std::function<void(Property&)> Property::m_readCallBack

mutableprotected

Definition at line 120 of file Property.h.

const std::type_info* Property::m_typeinfo

private

Definition at line 117 of file Property.h.

std::function<void(Property&)> Property::m_updateCallBack

protected

Definition at line 122 of file Property.h.

---

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

• GaudiKernel/GaudiKernel/Property.h
• GaudiKernel/src/Lib/Property.cpp