Gaudi::DataHandleVectorBase Class Reference

Type-erased interface for a configurable sequence of data handles. More...

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

Inheritance diagram for Gaudi::DataHandleVectorBase:

Public Types
using	PropertyType = DataHandleVectorProperty

Public Member Functions
virtual	~DataHandleVectorBase ()=default
virtual void	setKeys (std::span< const DataObjID > keys)=0
	Replace the configured TES keys and rebuild the typed handles.
virtual const std::vector< DataObjID > &	keys () const =0
	Configured TES keys, in property order.
virtual DataHandle::Mode	mode () const =0
	Access mode shared by all handles in the vector.
virtual std::string	type () const =0
	Demangled C++ type of the data accessed by each handle.
std::string	pythonPropertyClassName () const
	Python class used to represent the property value.
std::string	semantics () const
	GaudiConfig2 semantics name including handle mode and value type.
std::string	pythonRepr () const
	Python expression reproducing the configured value.

Detailed Description

Type-erased interface for a configurable sequence of data handles.

The associated property stores the TES keys. Updating it rebuilds the typed handles owned by the concrete DataHandleVector.

Definition at line 100 of file DataHandle.h.

Member Typedef Documentation

PropertyType

using Gaudi::DataHandleVectorBase::PropertyType = DataHandleVectorProperty

Definition at line 102 of file DataHandle.h.

Constructor & Destructor Documentation

~DataHandleVectorBase()

virtual Gaudi::DataHandleVectorBase::~DataHandleVectorBase ( )

virtualdefault

Member Function Documentation

keys()

virtual const std::vector< DataObjID > & Gaudi::DataHandleVectorBase::keys ( ) const

pure virtual

Configured TES keys, in property order.

Implemented in Gaudi::DataHandleVector< Handle, T >, Gaudi::DataHandleVector< DataObjectReadHandle, Gaudi::TestSuite::Collision >, Gaudi::DataHandleVector< DataObjectWriteHandle, Gaudi::TestSuite::Collision >, Gaudi::DataHandleVector< InputHandleFor< Tr, Default >::template type, T >, and Gaudi::DataHandleVector< OutputHandleFor< Tr, Default >::template type, T >.

mode()

virtual DataHandle::Mode Gaudi::DataHandleVectorBase::mode ( ) const

pure virtual

Access mode shared by all handles in the vector.

Implemented in Gaudi::DataHandleVector< Handle, T >, Gaudi::DataHandleVector< DataObjectReadHandle, Gaudi::TestSuite::Collision >, Gaudi::DataHandleVector< DataObjectWriteHandle, Gaudi::TestSuite::Collision >, Gaudi::DataHandleVector< InputHandleFor< Tr, Default >::template type, T >, and Gaudi::DataHandleVector< OutputHandleFor< Tr, Default >::template type, T >.

pythonPropertyClassName()

std::string Gaudi::DataHandleVectorBase::pythonPropertyClassName ( ) const

inline

Python class used to represent the property value.

Definition at line 116 of file DataHandle.h.

{ return "DataHandleVector"; }

pythonRepr()

std::string Gaudi::DataHandleVectorBase::pythonRepr

(

)

const

Python expression reproducing the configured value.

Definition at line 48 of file DataHandle.cpp.

                                                   {
    std::ostringstream ost;
    ost << pythonPropertyClassName() << "([";
    const char* sep = "";
    for ( const auto& key : keys() ) {
      ost << sep << "'" << key.key() << "'";
      sep = ",";
    }
    ost << "], '";
    switch ( mode() ) {
    case DataHandle::Mode::Reader:
      ost << "R";
      break;
    case DataHandle::Mode::Writer:
      ost << "W";
      break;
    default:
      ost << "UNKNOWN";
      break;
    }
    ost << "', '" << type() << "')";
    return ost.str();
  }

semantics()

std::string Gaudi::DataHandleVectorBase::semantics

(

)

const

GaudiConfig2 semantics name including handle mode and value type.

Definition at line 37 of file DataHandle.cpp.

                                                  {
    switch ( mode() ) {
    case DataHandle::Mode::Reader:
      return "Gaudi::DataHandleVector<DataObjectReadHandle, " + type() + ">";
    case DataHandle::Mode::Writer:
      return "Gaudi::DataHandleVector<DataObjectWriteHandle, " + type() + ">";
    default:
      return "Gaudi::DataHandleVector<DataHandle, " + type() + ">";
    }
  }

setKeys()

virtual void Gaudi::DataHandleVectorBase::setKeys ( std::span< const DataObjID > keys )

pure virtual

Replace the configured TES keys and rebuild the typed handles.

Implemented in Gaudi::DataHandleVector< Handle, T >, Gaudi::DataHandleVector< DataObjectReadHandle, Gaudi::TestSuite::Collision >, Gaudi::DataHandleVector< DataObjectWriteHandle, Gaudi::TestSuite::Collision >, Gaudi::DataHandleVector< InputHandleFor< Tr, Default >::template type, T >, and Gaudi::DataHandleVector< OutputHandleFor< Tr, Default >::template type, T >.

type()

virtual std::string Gaudi::DataHandleVectorBase::type ( ) const

pure virtual

Demangled C++ type of the data accessed by each handle.

Implemented in Gaudi::DataHandleVector< Handle, T >, Gaudi::DataHandleVector< DataObjectReadHandle, Gaudi::TestSuite::Collision >, Gaudi::DataHandleVector< DataObjectWriteHandle, Gaudi::TestSuite::Collision >, Gaudi::DataHandleVector< InputHandleFor< Tr, Default >::template type, T >, and Gaudi::DataHandleVector< OutputHandleFor< Tr, Default >::template type, T >.

---

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

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