GaudiHandleArrayProperty Class Reference

#include <Property.h>

Inheritance diagram for GaudiHandleArrayProperty:

Collaboration diagram for GaudiHandleArrayProperty:

Public Member Functions
	GaudiHandleArrayProperty (const std::string &name, GaudiHandleArrayBase &ref)
GaudiHandleArrayProperty &	operator= (const GaudiHandleArrayBase &value)
virtual GaudiHandleArrayProperty *	clone () const
	clone: "virtual constructor"
virtual bool	load (Property &destination) const
	export the property value to the destination
virtual bool	assign (const Property &source)
	import the property value form the source
virtual std::string	toString () const
	value -> string
virtual void	toStream (std::ostream &out) const
	value -> stream
virtual StatusCode	fromString (const std::string &s)
	string -> value
const GaudiHandleArrayBase &	value () const
bool	setValue (const GaudiHandleArrayBase &value)
Public Member Functions inherited from Property
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
const PropertyCallbackFunctor *	readCallBack () const
	Call-back functor at reading: the functor is owned by property!
const PropertyCallbackFunctor *	updateCallBack () const
	Call-back functor for update: the functor is owned 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 bool	useUpdateHandler ()
	use the call-back function at update
virtual	~Property ()
	virtual destructor
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

Private Attributes
GaudiHandleArrayBase *	m_pValue
	Pointer to the real property.

Additional Inherited Members
Protected Member Functions inherited from Property
	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)
	assignment operator
Protected Attributes inherited from Property
PropertyCallbackFunctor *	m_readCallBack
PropertyCallbackFunctor *	m_updateCallBack

Detailed Description

Definition at line 866 of file Property.h.

Constructor & Destructor Documentation

GaudiHandleArrayProperty::GaudiHandleArrayProperty	(	const std::string &	name,
		GaudiHandleArrayBase &	ref
	)

Definition at line 274 of file Property.cpp.

  : Property( name, typeid( GaudiHandleArrayBase ) ), m_pValue( &ref ) 
{ 
  m_pValue->setPropertyName( name );
}

Member Function Documentation

bool GaudiHandleArrayProperty::assign ( const Property &  source )

inlinevirtual

import the property value form the source

Implements Property.

Definition at line 913 of file Property.h.

                                                                     {
  return fromString( source.toString() ) != 0;
}

GaudiHandleArrayProperty * GaudiHandleArrayProperty::clone ( ) const

inlinevirtual

clone: "virtual constructor"

Implements Property.

Definition at line 905 of file Property.h.

                                                                       {
  return new GaudiHandleArrayProperty( *this );
}

StatusCode GaudiHandleArrayProperty::fromString ( const std::string &  value )

virtual

string -> value

Implements Property.

Definition at line 297 of file Property.cpp.

                                                                         {
  // treat as if a StringArrayProperty
  std::vector< std::string > tmp;
  StatusCode sc = Gaudi::Parsers::parse ( tmp , source );
  if ( sc.isFailure() ) return sc;
  if ( !m_pValue->setTypesAndNames( tmp ) ) return StatusCode::FAILURE;
  return useUpdateHandler()?StatusCode::SUCCESS:StatusCode::FAILURE;
}

bool GaudiHandleArrayProperty::load ( Property &  dest ) const

inlinevirtual

export the property value to the destination

Implements Property.

Definition at line 909 of file Property.h.

                                                                        {
  return destination.assign( *this );
}

GaudiHandleArrayProperty & GaudiHandleArrayProperty::operator= ( const GaudiHandleArrayBase &  value )

inline

Definition at line 900 of file Property.h.

                                                                                                        {
  setValue( value );
  return *this;
}

bool GaudiHandleArrayProperty::setValue

(

const GaudiHandleArrayBase &

value

)

Definition at line 280 of file Property.cpp.

                                                                           {
  m_pValue->setTypesAndNames( value.typesAndNames() );
  return useUpdateHandler();
}

void GaudiHandleArrayProperty::toStream ( std::ostream &  out ) const

virtual

value -> stream

Implements Property.

Definition at line 291 of file Property.cpp.

                                                             {
  // treat as if a StringArrayProperty
  useReadHandler();
  Gaudi::Utils::toStream( m_pValue->typesAndNames(), out );
}

std::string GaudiHandleArrayProperty::toString ( ) const

virtual

value -> string

Implements Property.

Definition at line 285 of file Property.cpp.

                                                   {
  // treat as if a StringArrayProperty
  useReadHandler();
  return Gaudi::Utils::toString( m_pValue->typesAndNames() );
}

const GaudiHandleArrayBase & GaudiHandleArrayProperty::value ( ) const

inline

Definition at line 917 of file Property.h.

                                                                         {
  useReadHandler();
  return *m_pValue;
}

Member Data Documentation

GaudiHandleArrayBase* GaudiHandleArrayProperty::m_pValue

private

Pointer to the real property.

Reference would be better, but Reflex does not support references yet

Definition at line 892 of file Property.h.

---

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

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