The Gaudi Framework  v30r4 (9b837755)
Gaudi::DataHandleConfigurable Class Reference

Configurable entity associated with a DataHandle property. More...

#include <GaudiKernel/DataHandleConfigurable.h>

Collaboration diagram for Gaudi::DataHandleConfigurable:

Public Member Functions

 DataHandleConfigurable (const IDataHandleMetadata &metadata, DataObjID defaultKey)
 Initialize by providing access to the metadata singleton. More...
 
const IDataHandleMetadata & metadata () const
 Propagate metadata of the underlying DataHandle type. More...
 
const DataObjID & targetKey () const
 Tell what the currently configured target is. More...
 
void setTargetKey (const DataObjID &key)
 Change the target of the data handle. More...
 

Private Attributes

std::reference_wrapper< const IDataHandleMetadata > m_metadata
 
DataObjID m_key
 

Friends

std::ostream & operator<< (std::ostream &str, const DataHandleConfigurable &d)
 Boilerplate for Gaudi::Property compatibility. More...
 

Detailed Description

Configurable entity associated with a DataHandle property.

This class combines access to the IDataHandleMetadata with a configurable target DataObjID. It is what the Property machinery will eventually interact with.

Definition at line 18 of file DataHandleConfigurable.h.

Constructor & Destructor Documentation

Gaudi::DataHandleConfigurable::DataHandleConfigurable ( const IDataHandleMetadata &  metadata,
DataObjID  defaultKey 
)
inline

Initialize by providing access to the metadata singleton.

Definition at line 22 of file DataHandleConfigurable.h.

23  : m_metadata( metadata ), m_key( std::move( defaultKey ) )
24  {
25  }
std::reference_wrapper< const IDataHandleMetadata > m_metadata
T move(T...args)
const IDataHandleMetadata & metadata() const
Propagate metadata of the underlying DataHandle type.

Member Function Documentation

const IDataHandleMetadata& Gaudi::DataHandleConfigurable::metadata ( ) const
inline

Propagate metadata of the underlying DataHandle type.

Definition at line 28 of file DataHandleConfigurable.h.

28 { return m_metadata; }
std::reference_wrapper< const IDataHandleMetadata > m_metadata
void Gaudi::DataHandleConfigurable::setTargetKey ( const DataObjID &  key)
inline

Change the target of the data handle.

Definition at line 34 of file DataHandleConfigurable.h.

const DataObjID& Gaudi::DataHandleConfigurable::targetKey ( ) const
inline

Tell what the currently configured target is.

Definition at line 31 of file DataHandleConfigurable.h.

Friends And Related Function Documentation

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

Boilerplate for Gaudi::Property compatibility.

Definition at line 49 of file DataHandleConfigurable.cpp.

50 {
51  return Gaudi::Utils::toStream( dhc, str );
52 }
std::ostream & toStream(ITERATOR first, ITERATOR last, std::ostream &s, const std::string &open, const std::string &close, const std::string &delim)
the helper function to print the sequence
Definition: ToStream.h:303

Member Data Documentation

DataObjID Gaudi::DataHandleConfigurable::m_key
private

Definition at line 41 of file DataHandleConfigurable.h.

std::reference_wrapper<const IDataHandleMetadata> Gaudi::DataHandleConfigurable::m_metadata
private

Definition at line 40 of file DataHandleConfigurable.h.


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