DataObjIDProperty Class Reference

DataObjIDProperty.h GaudiKernel/DataObjProperty.h. More...

#include <GaudiKernel/DataObjIDProperty.h>

Inheritance diagram for DataObjIDProperty:

Collaboration diagram for DataObjIDProperty:

Public Member Functions
	DataObjIDProperty (const std::string &name, DataObjID &ref)
DataObjIDProperty &	operator= (const DataObjID &value)
virtual	~DataObjIDProperty ()
virtual DataObjIDProperty *	clone () const
	clone: "virtual constructor" More...
virtual bool	load (Property &destination) const
	export the property value to the destination More...
virtual bool	assign (const Property &source)
	import the property value form the source More...
virtual std::string	toString () const
	value -> string More...
virtual void	toStream (std::ostream &out) const
	value -> stream More...
virtual StatusCode	fromString (const std::string &s)
	string -> value More...
const DataObjID &	value () const
bool	setValue (const DataObjID &value)
Public Member Functions inherited from Property
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...
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...
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...

Private Attributes
DataObjID *	m_pValue
	Pointer to the real property. More...

Additional Inherited Members
Protected Member Functions inherited from Property
	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 inherited from Property
std::function< void(Property &)>	m_readCallBack
std::function< void(Property &)>	m_updateCallBack

Detailed Description

DataObjIDProperty.h GaudiKernel/DataObjProperty.h.

Helper class to manage DataObjIDs and DataObjIDColls as properties

TODO: DataObjIDCollProperty implementation

Author

Charles Leggett

Date

2015-09-01

Definition at line 28 of file DataObjIDProperty.h.

Constructor & Destructor Documentation

DataObjIDProperty::DataObjIDProperty	(	const std::string &	name,
		DataObjID &	ref
	)

Definition at line 171 of file DataObjIDProperty.cpp.

  : Property( name, typeid( DataObjID ) ), 
    m_pValue( &ref ) 
{}

DataObjIDProperty::~DataObjIDProperty ( )

virtual

Definition at line 179 of file DataObjIDProperty.cpp.

{}

Member Function Documentation

bool DataObjIDProperty::assign ( const Property &  source )

inlinevirtual

import the property value form the source

Implements Property.

Definition at line 89 of file DataObjIDProperty.h.

{
  return fromString( source.toString() ).isSuccess();
}

DataObjIDProperty * DataObjIDProperty::clone ( ) const

inlinevirtual

clone: "virtual constructor"

Implements Property.

Definition at line 75 of file DataObjIDProperty.h.

{
  return new DataObjIDProperty( *this );
}

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

virtual

string -> value

Implements Property.

Definition at line 185 of file DataObjIDProperty.cpp.

{
  if (!Gaudi::Parsers::parse(*m_pValue, s).isSuccess()) {
    return StatusCode::FAILURE;
  }
  return useUpdateHandler()
    ? StatusCode::SUCCESS
    : StatusCode::FAILURE;
}

bool DataObjIDProperty::load ( Property &  dest ) const

inlinevirtual

export the property value to the destination

Implements Property.

Definition at line 82 of file DataObjIDProperty.h.

{
  return destination.assign( *this );
}

DataObjIDProperty & DataObjIDProperty::operator= ( const DataObjID &  value )

inline

Definition at line 67 of file DataObjIDProperty.h.

{
  setValue( value );
  return *this;
}

bool DataObjIDProperty::setValue

(

const DataObjID &

value

)

Definition at line 198 of file DataObjIDProperty.cpp.

{
  m_pValue->operator=(value);
  return useUpdateHandler();
}

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

virtual

value -> stream

Implements Property.

Definition at line 217 of file DataObjIDProperty.cpp.

{
  useReadHandler();
  out << this->toString();
}

std::string DataObjIDProperty::toString ( ) const

virtual

value -> string

Implements Property.

Definition at line 207 of file DataObjIDProperty.cpp.

{
  useReadHandler();
  std::ostringstream o;
  Gaudi::Utils::toStream(*m_pValue, o);
  return o.str();
}

const DataObjID & DataObjIDProperty::value ( ) const

inline

Definition at line 96 of file DataObjIDProperty.h.

{
  useReadHandler();
  return *m_pValue;
}

Member Data Documentation

DataObjID* DataObjIDProperty::m_pValue

private

Pointer to the real property.

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

Definition at line 48 of file DataObjIDProperty.h.

---

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

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