Gaudi Framework, version v20r2
	Generated: 18 Jul 2008

Property Class Reference

#include <GaudiKernel/Property.h>

Inheritance diagram for Property:

[legend]Collaboration diagram for Property:

[legend]List of all members.

---

Detailed Description

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

Author:

Paul Maley

CTDay

Vanya BELYAEV ibelyaev@physics.syr.edu

Definition at line 45 of file Property.h.

Public Member Functions
const std::string &	name () const
	property name
const std::string &	documentation () const
	property documentation
const std::type_info *	type_info () const
	property type-info
std::string	type () const
	property type
virtual bool	load (Property &dest) const =0
	export the property value to the destination
virtual bool	assign (const Property &source)=0
	import the property value form the source
virtual std::string	toString () const=0
	value -> string
virtual StatusCode	fromString (const std::string &value)=0
	string -> value
const PropertyCallbackFunctor *	readCallBack () const
	Call-back functor at reading: the functor is ownered by property!
const PropertyCallbackFunctor *	updateCallBack () const
	Call-back functor for update: the funtor is ownered by property!
virtual void	declareReadHandler (PropertyCallbackFunctor *pf)
	set new callback for reading
virtual void	declareUpdateHandler (PropertyCallbackFunctor *pf)
	set new callback for update
template<class HT>
void	declareReadHandler (void(HT::*MF)(Property &), HT *instance)
template<class HT>
void	declareUpdateHandler (void(HT::*MF)(Property &), HT *instance)
virtual void	useReadHandler () const
	use the call-back function at reading
virtual void	useUpdateHandler ()
	use the call-back function at update
virtual	~Property ()
	virtual destructor
virtual Property *	clone () const=0
	clone: "virtual constructor"
void	setName (const std::string &value)
	set the new value for the property name
void	setDocumentation (const std::string &documentation)
	set the documentation string
virtual std::ostream &	fillStream (std::ostream &) const
	the printout of the property value
Protected Member Functions
	Property (const std::type_info &type, const std::string &name="")
	constructor from the property name and the type
	Property (const std::string &name, const std::type_info &type)
	constructor from the property name and the type
	Property (const Property &right)
	copy constructor
Property &	operator= (const Property &right)
	assignement operator
Protected Attributes
PropertyCallbackFunctor *	m_readCallBack
PropertyCallbackFunctor *	m_updateCallBack
Private Member Functions
	Property ()
Private Attributes
std::string	m_name
std::string	m_documentation
const std::type_info *	m_typeinfo

---

Constructor & Destructor Documentation

Property::~Property

(

)

[virtual]

virtual destructor

Definition at line 112 of file Property.cpp.

References m_readCallBack, and m_updateCallBack.

{
  if ( 0 != m_readCallBack   ) 
  { delete m_readCallBack    ; m_readCallBack    = 0 ; }
  if ( 0 != m_updateCallBack ) 
  { delete m_updateCallBack  ; m_updateCallBack  = 0 ; }  
} 

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

constructor from the property name and the type

Definition at line 48 of file Property.cpp.

  : m_name            (  name ) 
  , m_documentation   ( name )
  , m_typeinfo        ( &type )
  , m_readCallBack    (  0  ) 
  , m_updateCallBack  (  0  )
{}  

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

constructor from the property name and the type

Definition at line 63 of file Property.cpp.

  : m_name            (  name ) 
  , m_documentation   ( name )
  , m_typeinfo        ( &type )
  , m_readCallBack    (  0  ) 
  , m_updateCallBack  (  0  )
{}  

Property::Property

(

const Property &

right

)

[protected]

copy constructor

Definition at line 75 of file Property.cpp.

References m_readCallBack, and m_updateCallBack.

  : m_name     ( right.m_name     ) 
  , m_documentation ( right.m_documentation )
  , m_typeinfo ( right.m_typeinfo )
  , m_readCallBack   ( 0 ) 
  , m_updateCallBack ( 0 )
{
  if ( 0 != right.m_readCallBack   ) 
  { m_readCallBack   = right.m_readCallBack   -> clone () ; }
  if ( 0 != right.m_updateCallBack ) 
  { m_updateCallBack = right.m_updateCallBack -> clone () ; }  
}

Property::Property

(

)

[private]

---

Member Function Documentation

const std::string& Property::name

(

)

const [inline]

property name

Definition at line 49 of file Property.h.

References m_name.

Referenced by JobOptionsCatalogue::addProperty(), JobOptionsSvc::addPropertyToCatalogue(), fillStream(), GaudiHandleArrayProperty::GaudiHandleArrayProperty(), PropertyMgr::getProperty(), GaudiCommon< PBASE >::msgLevelHandler(), configGenerator::pythonizeValue(), PropertyMgr::setProperty(), MessageSvc::setupColors(), IssueLogger::setupLevels(), MessageSvc::setupLimits(), IssueLogger::setupStreams(), and MessageSvc::setupThreshold().

{ return m_name             ; } ;

const std::string& Property::documentation

(

)

const [inline]

property documentation

Definition at line 51 of file Property.h.

References m_documentation.

Referenced by setDocumentation().

{ return m_documentation; };

const std::type_info* Property::type_info

(

)

const [inline]

property type-info

Definition at line 53 of file Property.h.

References m_typeinfo.

Referenced by configGenerator::pythonizeValue().

{ return m_typeinfo         ; } ;

std::string Property::type

(

)

const [inline]

property type

Definition at line 55 of file Property.h.

References m_typeinfo, and std::type_info::name().

{ return m_typeinfo->name() ; } ;  

virtual bool Property::load

(

Property &

dest

)

const [pure virtual]

export the property value to the destination

Implemented in PropertyWithValue< TYPE >, GaudiHandleProperty, GaudiHandleArrayProperty, PropertyList, and PropertyWithValue< std::vectorstring >.

Referenced by JobOptionsSvc::addPropertyToCatalogue(), and PropertyMgr::getProperty().

virtual bool Property::assign

(

const Property &

source

)

[pure virtual]

import the property value form the source

Implemented in PropertyWithValue< TYPE >, GaudiHandleProperty, GaudiHandleArrayProperty, PropertyList, PropertyWithValue< std::vectorstring >, and PropertyWithValue< TYPE >.

Referenced by GaudiHandleArrayProperty::load(), GaudiHandleProperty::load(), PropertyWithValue< TYPE >::load(), PropertyMgr::setProperty(), and Gaudi::Utils::setProperty().

virtual std::string Property::toString

(

)

const [pure virtual]

value -> string

Implemented in PropertyWithValue< TYPE >, GaudiHandleProperty, GaudiHandleArrayProperty, PropertyWithValue< std::vectorstring >, and PropertyWithValue< TYPE >.

Referenced by GaudiHandleArrayProperty::assign(), GaudiHandleProperty::assign(), PropertyWithValue< TYPE >::assign(), fillStream(), PropertyMgr::getProperty(), and configGenerator::pythonizeValue().

virtual StatusCode Property::fromString

(

const std::string &

value

)

[pure virtual]

string -> value

Implemented in PropertyWithValue< TYPE >, GaudiHandleProperty, GaudiHandleArrayProperty, and PropertyWithValue< std::vectorstring >.

Referenced by PropertyMgr::setProperty().

const PropertyCallbackFunctor * Property::readCallBack

(

)

const

Call-back functor at reading: the functor is ownered by property!

Definition at line 122 of file Property.cpp.

References m_readCallBack.

{ return m_readCallBack ; }  

const PropertyCallbackFunctor * Property::updateCallBack

(

)

const

Call-back functor for update: the funtor is ownered by property!

Definition at line 127 of file Property.cpp.

References m_updateCallBack.

{ return m_updateCallBack ; }

void Property::declareReadHandler

(

PropertyCallbackFunctor *

pf

)

[virtual]

set new callback for reading

Definition at line 132 of file Property.cpp.

References m_readCallBack.

{
  if ( 0 != m_readCallBack   ) 
  { delete m_readCallBack    ; m_readCallBack    = 0 ; }
  m_readCallBack = pf ;
} 

void Property::declareUpdateHandler

(

PropertyCallbackFunctor *

pf

)

[virtual]

set new callback for update

Definition at line 141 of file Property.cpp.

References m_updateCallBack.

Referenced by Algorithm::Algorithm(), AlgTool::AlgTool(), ApplicationMgr::configure(), GaudiSequencer::GaudiSequencer(), HistogramSvc::HistogramSvc(), IssueLogger::IssueLogger(), MinimalEventLoopMgr::MinimalEventLoopMgr(), PersistencySvc::PersistencySvc(), Sequencer::Sequencer(), Service::Service(), and THistSvc::THistSvc().

{
  if ( 0 != m_updateCallBack   ) 
  { delete m_updateCallBack    ; m_updateCallBack    = 0 ; }
  m_updateCallBack = pf ;
} 

template<class HT>

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

Definition at line 130 of file Property.h.

{ declareReadHandler ( new PropertyCallbackMemberFunctor< HT >( MF , obj ) ) ; }  

template<class HT>

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

Definition at line 135 of file Property.h.

{ declareUpdateHandler ( new PropertyCallbackMemberFunctor< HT >( MF , obj ) ) ; }

void Property::useReadHandler

(

)

const [virtual]

use the call-back function at reading

Definition at line 150 of file Property.cpp.

References m_readCallBack, and return.

Referenced by GaudiHandleArrayProperty::toString(), GaudiHandleProperty::toString(), PropertyWithValue< TYPE >::toString(), GaudiHandleArrayProperty::value(), GaudiHandleProperty::value(), and PropertyWithValue< TYPE >::value().

{
  if ( 0 == m_readCallBack ) { return ; }               // RETURN
  const Property& p = *this ;
  PropertyCallbackFunctor* theCallBack = m_readCallBack;
  // avoid infinite loop
  m_readCallBack = 0;
  (*theCallBack)( const_cast<Property&>(p) ) ;
  m_readCallBack = theCallBack;
} 

void Property::useUpdateHandler

(

)

[virtual]

use the call-back function at update

Definition at line 163 of file Property.cpp.

References m_updateCallBack, and return.

Referenced by GaudiHandleArrayProperty::fromString(), GaudiHandleProperty::fromString(), PropertyWithVerifier< TYPE, VERIFIER >::set(), GaudiHandleArrayProperty::setValue(), and GaudiHandleProperty::setValue().

{
  if ( 0 == m_updateCallBack ) { return ; }              // RETURN
  PropertyCallbackFunctor* theCallBack = m_updateCallBack;
  // avoid infinite loop
  m_updateCallBack = 0;
  (*theCallBack)( *this ) ;
  m_updateCallBack = theCallBack;
} 

virtual Property* Property::clone

(

)

const [pure virtual]

clone: "virtual constructor"

Implemented in SimpleProperty< TYPE, VERIFIER >, SimplePropertyRef< TYPE, VERIFIER >, GaudiHandleProperty, GaudiHandleArrayProperty, and SimpleProperty< std::vectorstring > >.

Referenced by PropertyMgr::operator=(), operator=(), and PropertyMgr::PropertyMgr().

void Property::setName

(

const std::string &

value

)

[inline]

set the new value for the property name

Definition at line 90 of file Property.h.

References m_name.

{ m_name = value ; }

void Property::setDocumentation

(

const std::string &

documentation

)

[inline]

set the documentation string

Definition at line 92 of file Property.h.

References documentation(), and m_documentation.

Referenced by PropertyMgr::declareProperty(), and Gaudi::Utils::setProperty().

                                                          { 
    m_documentation = documentation; };

std::ostream & Property::fillStream

(

std::ostream &

)

const [virtual]

the printout of the property value

Definition at line 176 of file Property.cpp.

References name(), and toString().

Referenced by HistorySvc::dumpProp(), and operator<<().

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

Property & Property::operator=

(

const Property &

right

)

[protected]

assignement operator

Definition at line 90 of file Property.cpp.

References clone(), m_documentation, m_name, m_readCallBack, m_typeinfo, and m_updateCallBack.

{
  if ( &right == this ) { return *this ; }
  //
  m_name     = right.m_name ;
  m_documentation = right.m_documentation ;
  m_typeinfo = right.m_typeinfo ;  
  //
  if ( 0 !=       m_readCallBack   ) 
  { delete m_readCallBack   ; m_readCallBack   = 0 ; }
  if ( 0 !=       m_updateCallBack ) 
  { delete m_updateCallBack ; m_updateCallBack = 0 ; }
  if ( 0 != right.m_readCallBack   ) 
  { m_readCallBack   = right.m_readCallBack   -> clone () ; }
  if ( 0 != right.m_updateCallBack ) 
  { m_updateCallBack = right.m_updateCallBack -> clone () ; }  
  // 
  return *this ;
} 

---

Member Data Documentation

std::string Property::m_name [private]

Definition at line 114 of file Property.h.

Referenced by name(), operator=(), and setName().

std::string Property::m_documentation [private]

Definition at line 116 of file Property.h.

Referenced by documentation(), operator=(), and setDocumentation().

const std::type_info* Property::m_typeinfo [private]

Definition at line 118 of file Property.h.

Referenced by operator=(), type(), and type_info().

PropertyCallbackFunctor* Property::m_readCallBack [mutable, protected]

Definition at line 121 of file Property.h.

Referenced by declareReadHandler(), operator=(), Property(), readCallBack(), useReadHandler(), and ~Property().

PropertyCallbackFunctor* Property::m_updateCallBack [protected]

Definition at line 123 of file Property.h.

Referenced by declareUpdateHandler(), operator=(), Property(), updateCallBack(), useUpdateHandler(), and ~Property().

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiKernel/v25r2/GaudiKernel/Property.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiKernel/v25r2/src/Lib/Property.cpp

---