All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
GaudiHandleProperty Class Reference

#include </scratch/z5/marcocle/lhcb-release/419/GAUDI/GAUDI_v26r1/InstallArea/x86_64-slc6-gcc48-opt/include/GaudiKernel/Property.h>

Inheritance diagram for GaudiHandleProperty:
Collaboration diagram for GaudiHandleProperty:

Public Member Functions

 GaudiHandleProperty (const std::string &name, GaudiHandleBase &ref)
 
GaudiHandlePropertyoperator= (const GaudiHandleBase &value)
 
virtual GaudiHandlePropertyclone () 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 GaudiHandleBasevalue () const
 
bool setValue (const GaudiHandleBase &value)
 
 GaudiHandleProperty (const std::string &name, GaudiHandleBase &ref)
 
GaudiHandlePropertyoperator= (const GaudiHandleBase &value)
 
virtual GaudiHandlePropertyclone () 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 GaudiHandleBasevalue () const
 
bool setValue (const GaudiHandleBase &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 PropertyCallbackFunctorreadCallBack () const
 Call-back functor at reading: the functor is owned by property!
 
const PropertyCallbackFunctorupdateCallBack () 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
 
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 PropertyCallbackFunctorreadCallBack () const
 Call-back functor at reading: the functor is owned by property!
 
const PropertyCallbackFunctorupdateCallBack () 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

GaudiHandleBasem_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
 
Propertyoperator= (const Property &right)
 assignment operator
 
 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
 
Propertyoperator= (const Property &right)
 assignment operator
 
- Protected Attributes inherited from Property
PropertyCallbackFunctorm_readCallBack
 
PropertyCallbackFunctorm_updateCallBack
 

Detailed Description

Definition at line 808 of file Property.h.

Constructor & Destructor Documentation

GaudiHandleProperty::GaudiHandleProperty ( const std::string &  name,
GaudiHandleBase ref 
)

Definition at line 244 of file Property.cpp.

: Property( name, typeid( GaudiHandleBase ) ), m_pValue( &ref )
{
}
GaudiHandleProperty::GaudiHandleProperty ( const std::string &  name,
GaudiHandleBase ref 
)

Member Function Documentation

bool GaudiHandleProperty::assign ( const Property source)
inlinevirtual

import the property value form the source

Implements Property.

Definition at line 853 of file Property.h.

{
return fromString( source.toString() ).isSuccess();
}
virtual bool GaudiHandleProperty::assign ( const Property source)
virtual

import the property value form the source

Implements Property.

GaudiHandleProperty * GaudiHandleProperty::clone ( ) const
inlinevirtual

clone: "virtual constructor"

Implements Property.

Definition at line 845 of file Property.h.

{
return new GaudiHandleProperty( *this );
}
virtual GaudiHandleProperty* GaudiHandleProperty::clone ( ) const
virtual

clone: "virtual constructor"

Implements Property.

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

string -> value

Implements Property.

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

string -> value

Implements Property.

Definition at line 265 of file Property.cpp.

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

export the property value to the destination

Implements Property.

bool GaudiHandleProperty::load ( Property dest) const
inlinevirtual

export the property value to the destination

Implements Property.

Definition at line 849 of file Property.h.

{
return destination.assign( *this );
}
GaudiHandleProperty & GaudiHandleProperty::operator= ( const GaudiHandleBase value)
inline

Definition at line 840 of file Property.h.

{
setValue( value );
return *this;
}
GaudiHandleProperty& GaudiHandleProperty::operator= ( const GaudiHandleBase value)
bool GaudiHandleProperty::setValue ( const GaudiHandleBase value)

Definition at line 250 of file Property.cpp.

bool GaudiHandleProperty::setValue ( const GaudiHandleBase value)
virtual void GaudiHandleProperty::toStream ( std::ostream &  out) const
virtual

value -> stream

Implements Property.

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

value -> stream

Implements Property.

Definition at line 260 of file Property.cpp.

{
out << m_pValue->typeAndName();
}
std::string GaudiHandleProperty::toString ( ) const
virtual

value -> string

Implements Property.

Definition at line 255 of file Property.cpp.

{
return m_pValue->typeAndName();
}
virtual std::string GaudiHandleProperty::toString ( ) const
virtual

value -> string

Implements Property.

const GaudiHandleBase & GaudiHandleProperty::value ( ) const
inline

Definition at line 857 of file Property.h.

{
return *m_pValue;
}
const GaudiHandleBase& GaudiHandleProperty::value ( ) const

Member Data Documentation

GaudiHandleBase * GaudiHandleProperty::m_pValue
private

Pointer to the real property.

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

Definition at line 833 of file Property.h.


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