DataObjectHandleBase Class Reference

DataObjectHandleBase GaudiKernel/DataObjectHandleBase.h. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/DataObjectHandleBase.h>

Inheritance diagram for DataObjectHandleBase:

Collaboration diagram for DataObjectHandleBase:

Public Member Functions
	DataObjectHandleBase (DataObjID k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (std::string k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	~DataObjectHandleBase () override
	DataObjectHandleBase (const DataObjectHandleBase &)=delete
	DataObjectHandleBase (DataObjectHandleBase &&)
DataObjectHandleBase &	operator= (const DataObjectHandleBase &)
template<std::derived_from< IProperty > OWNER, class K >
	DataObjectHandleBase (OWNER *owner, Gaudi::DataHandle::Mode m, std::string name, K key={}, std::string doc="")
	Autodeclaring constructor with property name, mode, key and documentation. More...
bool	isOptional () const
	Check if the data object declared is optional for the algorithm. More...
void	setOptional (bool optional=true)
bool	isValid () const
Public Member Functions inherited from Gaudi::DataHandle
	DataHandle (DataObjID k, Mode a=Reader, IDataHandleHolder *owner=nullptr)
	DataHandle (DataObjID k, bool isCond, Mode a=Reader, IDataHandleHolder *owner=nullptr)
virtual	~DataHandle ()=default
virtual void	setOwner (IDataHandleHolder *o)
virtual IDataHandleHolder *	owner () const
virtual Mode	mode () const
virtual void	setKey (DataObjID key)
virtual void	updateKey (std::string key)
virtual const std::string &	objKey () const
virtual const DataObjID &	fullKey () const
virtual void	reset (bool)
virtual std::string	pythonRepr () const
virtual bool	isCondition () const

Protected Member Functions
bool	init () override
DataObject *	fetch () const

Protected Attributes
SmartIF< IDataProviderSvc >	m_EDS
SmartIF< IMessageSvc >	m_MS
bool	m_init = false
bool	m_optional = false
Protected Attributes inherited from Gaudi::DataHandle
DataObjID	m_key = { "NONE" }
	The key of the object behind this DataHandle Although it may look strange to have it mutable, this can actually change in case the object had alternative names, and it should not be visible to the end user, for which the Handle is still the same. More...
IDataHandleHolder *	m_owner = nullptr

Friends
std::ostream &	operator<< (std::ostream &str, const DataObjectHandleBase &d)

Additional Inherited Members
Public Types inherited from Gaudi::DataHandle
enum	Mode { Reader = 1 << 2, Writer = 1 << 4 }
using	PropertyType = DataHandleProperty
Static Protected Attributes inherited from Gaudi::DataHandle
static const std::string	default_type = "unknown_t"

Detailed Description

DataObjectHandleBase GaudiKernel/DataObjectHandleBase.h.

Base class for handles to Data Objects in the Event Store, to simplify access via Properties.

Author

Charles Leggett

Date

2015-09-01

Definition at line 34 of file DataObjectHandleBase.h.

Constructor & Destructor Documentation

DataObjectHandleBase() [1/5]

DataObjectHandleBase::DataObjectHandleBase	(	DataObjID	k,
		Gaudi::DataHandle::Mode	a,
		IDataHandleHolder *	owner
	)

Definition at line 47 of file DataObjectHandleBase.cpp.

    : Gaudi::DataHandle( std::move( k ), a, owner ) {
  m_owner->declare( *this );
}

DataObjectHandleBase() [2/5]

DataObjectHandleBase::DataObjectHandleBase	(	std::string	k,
		Gaudi::DataHandle::Mode	a,
		IDataHandleHolder *	owner
	)

Definition at line 54 of file DataObjectHandleBase.cpp.

    : DataObjectHandleBase( DataObjID{ std::move( k ) }, a, owner ) {}

~DataObjectHandleBase()

DataObjectHandleBase::~DataObjectHandleBase ( )

override

Definition at line 58 of file DataObjectHandleBase.cpp.

{ owner()->renounce( *this ); }

DataObjectHandleBase() [3/5]

DataObjectHandleBase::DataObjectHandleBase ( const DataObjectHandleBase &  )

delete

DataObjectHandleBase() [4/5]

DataObjectHandleBase::DataObjectHandleBase

(

DataObjectHandleBase &&

other

)

Definition at line 26 of file DataObjectHandleBase.cpp.

    : Gaudi::DataHandle( other )
    , m_EDS( std::move( other.m_EDS ) )
    , m_MS( std::move( other.m_MS ) )
    , m_init( other.m_init )
    , m_optional( other.m_optional ) {
  m_owner->declare( *this );
}

DataObjectHandleBase() [5/5]

template<std::derived_from< IProperty > OWNER, class K >

DataObjectHandleBase::DataObjectHandleBase ( OWNER *  owner, Gaudi::DataHandle::Mode  m, std::string  name, K  key = {}, std::string  doc = ""  )

inline

Autodeclaring constructor with property name, mode, key and documentation.

Note

the use of requires is required to avoid ambiguities

Definition at line 48 of file DataObjectHandleBase.h.

                                                                                            {},
                               std::string doc = "" )
      : DataObjectHandleBase( std::move( key ), m, owner ) {
    auto p = owner->declareProperty( std::move( name ), *this, std::move( doc ) );
    p->template setOwnerType<OWNER>();
  }

Member Function Documentation

fetch()

DataObject * DataObjectHandleBase::fetch ( ) const

protected

Definition at line 61 of file DataObjectHandleBase.cpp.

                                              {
  // convenience towards users -- remind them to register
  // but as m_MS is not yet set, we cannot use a MsgStream...
  if ( !m_init ) {
    std::cerr << ( owner() ? owner()->name() : "<UNKNOWN>:" ) << "DataObjectHandle: uninitialized data handle"
              << std::endl;
  }
  DataObject* p = nullptr;
  m_EDS->retrieveObject( objKey(), p ).ignore();
  return p;
}

init()

bool DataObjectHandleBase::init ( )

overrideprotectedvirtual

Reimplemented from Gaudi::DataHandle.

Definition at line 75 of file DataObjectHandleBase.cpp.

                                {
  if ( m_init ) return true; // initialization already done
 
  if ( !owner() ) return false;
 
  Gaudi::Algorithm* algorithm = dynamic_cast<Gaudi::Algorithm*>( owner() );
  if ( algorithm ) {
    // Fetch the event Data Service from the algorithm
    m_EDS = algorithm->evtSvc();
    m_MS  = algorithm->msgSvc();
  } else {
    AlgTool* tool = dynamic_cast<AlgTool*>( owner() );
    if ( tool ) {
      m_EDS = tool->evtSvc();
      m_MS  = tool->msgSvc();
    } else {
      throw GaudiException( "owner is neither AlgTool nor Gaudi::Algorithm", "Invalid Cast", StatusCode::FAILURE );
    }
  }
  m_init = true;
  return true;
}

isOptional()

bool DataObjectHandleBase::isOptional ( ) const

inline

Check if the data object declared is optional for the algorithm.

Definition at line 58 of file DataObjectHandleBase.h.

{ return m_optional; }

isValid()

bool DataObjectHandleBase::isValid

(

)

const

Definition at line 100 of file DataObjectHandleBase.cpp.

{ return fullKey() != INVALID_DATAOBJID; }

operator=()

DataObjectHandleBase & DataObjectHandleBase::operator=

(

const DataObjectHandleBase &

other

)

Definition at line 36 of file DataObjectHandleBase.cpp.

                                                                                         {
  // FIXME: operator= should not change our owner, only our 'value'
  Gaudi::DataHandle::operator=( other );
  m_EDS      = other.m_EDS;
  m_MS       = other.m_MS;
  m_init     = other.m_init;
  m_optional = other.m_optional;
  return *this;
}

setOptional()

void DataObjectHandleBase::setOptional ( bool  optional = true )

inline

Definition at line 59 of file DataObjectHandleBase.h.

{ m_optional = optional; }

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  str, const DataObjectHandleBase &  d  )

friend

Definition at line 104 of file DataObjectHandleBase.cpp.

                                                                         {
 
  str << d.fullKey() << "  m: " << d.mode();
  if ( d.owner() ) str << "  o: " << d.owner()->name();
  str << "  opt: " << d.isOptional();
  return str;
}

Member Data Documentation

m_EDS

SmartIF<IDataProviderSvc> DataObjectHandleBase::m_EDS

protected

Definition at line 69 of file DataObjectHandleBase.h.

m_init

bool DataObjectHandleBase::m_init = false

protected

Definition at line 72 of file DataObjectHandleBase.h.

m_MS

SmartIF<IMessageSvc> DataObjectHandleBase::m_MS

protected

Definition at line 70 of file DataObjectHandleBase.h.

m_optional

bool DataObjectHandleBase::m_optional = false

protected

Definition at line 73 of file DataObjectHandleBase.h.

---

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

• GaudiKernel/include/GaudiKernel/DataObjectHandleBase.h
• GaudiKernel/src/Lib/DataObjectHandleBase.cpp