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<class OWNER , class K , typename = std::enable_if_t<std::is_base_of_v<IProperty, OWNER>>>
	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) const
virtual void	updateKey (std::string key) const
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
std::atomic< bool >	m_searchDone = false
	Whether the search part of the fetch method (so dealing with alt names was already executed or not. More...
std::mutex	m_searchMutex
	A Mutex protecting the calls to the search part of the fetch method, so that we are sure that we only call it once. More...
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 35 of file DataObjectHandleBase.h.

Constructor & Destructor Documentation

DataObjectHandleBase() [1/5]

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

Definition at line 51 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 58 of file DataObjectHandleBase.cpp.

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

~DataObjectHandleBase()

DataObjectHandleBase::~DataObjectHandleBase ( )

override

Definition at line 62 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_searchDone( other.m_searchDone.load() ) {
  m_owner->declare( *this );
}

DataObjectHandleBase() [5/5]

template<class OWNER , class K , typename = std::enable_if_t<std::is_base_of_v<IProperty, OWNER>>>

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 std::enable_if is required to avoid ambiguities

Definition at line 49 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 65 of file DataObjectHandleBase.cpp.

                                              {
  DataObject* p = nullptr;
  if ( m_searchDone ) { // fast path: searchDone, objKey is in its final state
    m_EDS->retrieveObject( objKey(), p ).ignore();
    return p;
  }
 
  // slow path -- move into seperate function to improve code generation?
 
  // as m_searchDone is not true yet, objKey may change... so in this
  // branch we _first_ grab the mutex, to avoid objKey changing while we use it
 
  // take a lock to be sure we only execute this one at a time
  auto guard = std::scoped_lock{ m_searchMutex };
 
  // 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;
  }
 
  // note: if no seperator is found, this returns a range of one with the  input as the single token
  // so if the search was done while we were waiting on the mutex, this (also) does the right thing
  auto tokens = boost::tokenizer<boost::char_separator<char>>{ objKey(), boost::char_separator<char>{ ":" } };
  // let's try our alternatives (if any)
  auto alt = std::find_if( tokens.begin(), tokens.end(),
                           [&]( const std::string& n ) { return m_EDS->retrieveObject( n, p ).isSuccess(); } );
  if ( alt != tokens.end() && *alt != objKey() ) {
    MsgStream log( m_MS, owner()->name() + ":DataObjectHandle" );
    log << MSG::DEBUG << ": could not find \"" << objKey() << "\" -- using alternative source: \"" << *alt
        << "\" instead" << endmsg;
    // found something -- set it as default; this is not atomic, but
    // at least in `fetch` there is no use of `objKey` that races with
    // this assignment... (but there may be others!)
    setKey( *alt ); // if there was one token, this is an unnecessary write... but who cares...
  }
 
  bool expected = false;                                  // but could be true (already)...
  m_searchDone.compare_exchange_strong( expected, true ); // if not yet true, set it to true...
  return p;
}

init()

bool DataObjectHandleBase::init ( )

overrideprotectedvirtual

Reimplemented from Gaudi::DataHandle.

Definition at line 110 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 59 of file DataObjectHandleBase.h.

{ return m_optional; }

isValid()

bool DataObjectHandleBase::isValid

(

)

const

Definition at line 135 of file DataObjectHandleBase.cpp.

{ return fullKey() != INVALID_DATAOBJID; }

operator=()

DataObjectHandleBase & DataObjectHandleBase::operator=

(

const DataObjectHandleBase &

other

)

Definition at line 37 of file DataObjectHandleBase.cpp.

                                                                                         {
  // avoid modification of searchDone in other while we are copying
  auto guard = std::scoped_lock{ other.m_searchMutex };
  // 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;
  m_searchDone               = other.m_searchDone.load();
  return *this;
}

setOptional()

void DataObjectHandleBase::setOptional ( bool  optional = true )

inline

Definition at line 60 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 139 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 70 of file DataObjectHandleBase.h.

m_init

bool DataObjectHandleBase::m_init = false

protected

Definition at line 73 of file DataObjectHandleBase.h.

m_MS

SmartIF<IMessageSvc> DataObjectHandleBase::m_MS

protected

Definition at line 71 of file DataObjectHandleBase.h.

m_optional

bool DataObjectHandleBase::m_optional = false

protected

Definition at line 74 of file DataObjectHandleBase.h.

m_searchDone

std::atomic<bool> DataObjectHandleBase::m_searchDone = false

mutableprotected

Whether the search part of the fetch method (so dealing with alt names was already executed or not.

On subsequent calls (when this is true), it will be skipped.

Definition at line 81 of file DataObjectHandleBase.h.

m_searchMutex

std::mutex DataObjectHandleBase::m_searchMutex

mutableprotected

A Mutex protecting the calls to the search part of the fetch method, so that we are sure that we only call it once.

Definition at line 87 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