DataObjID Class Reference

#include <GaudiKernel/DataObjID.h>

Collaboration diagram for DataObjID:

Public Member Functions
	DataObjID ()=default
	DataObjID (const DataObjID &)=default
	DataObjID (const std::string &key)
	DataObjID (const CLID &clid, const std::string &key)
	DataObjID (const std::string &className, const std::string &key)
const std::string &	key () const
bool	empty () const
	Tell if this DataObjID is has an empty key. More...
std::string	fullKey () const
CLID	clid () const
void	updateKey (const std::string &key)

Public Attributes
friend	DataObjID_Hasher

Private Member Functions
void	hashGen ()
void	setClid ()
void	setClassName ()

Private Attributes
CLID	m_clid {0}
std::size_t	m_hash {0}
std::string	m_key {"INVALID"}
std::string	m_className

Static Private Attributes
static IClassIDSvc *	p_clidSvc
static std::once_flag	m_ip

Friends
bool	operator< (const DataObjID &lhs, const DataObjID &rhs)
bool	operator== (const DataObjID &lhs, const DataObjID &rhs)
bool	operator!= (const DataObjID &lhs, const DataObjID &rhs)
StatusCode	parse (DataObjID &dest, const std::string &src)
std::ostream &	toStream (const DataObjID &v, std::ostream &o)
std::ostream &	operator<< (std::ostream &os, const DataObjID &d)

Detailed Description

Definition at line 37 of file DataObjID.h.

Constructor & Destructor Documentation

DataObjID::DataObjID ( )

default

DataObjID::DataObjID ( const DataObjID &  )

default

DataObjID::DataObjID ( const std::string &  key )

inline

Definition at line 85 of file DataObjID.h.

: m_key( key ) { hashGen(); }

DataObjID::DataObjID ( const CLID &  clid, const std::string &  key  )

inline

Definition at line 87 of file DataObjID.h.

                                                                    : m_clid( clid ), m_key( key )
{
  setClassName();
  hashGen();
}

DataObjID::DataObjID ( const std::string &  className, const std::string &  key  )

inline

Definition at line 93 of file DataObjID.h.

    : m_key( key ), m_className( className )
{
  setClid();
  hashGen();
}

Member Function Documentation

CLID DataObjID::clid ( ) const

inline

Definition at line 58 of file DataObjID.h.

{ return m_clid; }

bool DataObjID::empty ( ) const

inline

Tell if this DataObjID is has an empty key.

This is used as a configuration-time convention for optional inputs and outputs.

Definition at line 53 of file DataObjID.h.

{ return m_key.empty(); }

std::string DataObjID::fullKey

(

)

const

Definition at line 99 of file DataObjID.cpp.

{
  return ( m_clid == 0 && m_className.empty() ) ? m_key : ( m_className + '/' + m_key );
}

void DataObjID::hashGen ( )

private

Definition at line 82 of file DataObjID.cpp.

{
  m_hash = ( std::hash<std::string>()( m_key ) );
  if ( m_clid != 0 ) {
    // this is a bit redundant since hash<int> is a pass-through
    m_hash ^= ( std::hash<CLID>()( m_clid ) << 1 );
  }
}

const std::string& DataObjID::key ( ) const

inline

Definition at line 49 of file DataObjID.h.

{ return m_key; }

void DataObjID::setClassName ( )

private

Definition at line 73 of file DataObjID.cpp.

{
  std::call_once( m_ip, getClidSvc, std::ref( p_clidSvc ) );

  if ( !p_clidSvc || p_clidSvc->getTypeNameOfID( m_clid, m_className ).isFailure() ) {
    m_className = "UNKNOW_CLID:" + std::to_string( m_clid );
  }
}

void DataObjID::setClid ( )

private

Definition at line 63 of file DataObjID.cpp.

{
  std::call_once( m_ip, getClidSvc, std::ref( p_clidSvc ) );

  if ( !p_clidSvc || p_clidSvc->getIDOfTypeName( m_className, m_clid ).isFailure() ) {
    m_clid      = 0;
    m_className = "UNKNOWN_CLASS:" + m_className;
  }
}

void DataObjID::updateKey ( const std::string &  key )

inline

Definition at line 100 of file DataObjID.h.

{
  m_key = key;
  hashGen();
}

Friends And Related Function Documentation

bool operator!= ( const DataObjID &  lhs, const DataObjID &  rhs  )

friend

Definition at line 64 of file DataObjID.h.

{ return !( lhs == rhs ); }

bool operator< ( const DataObjID &  lhs, const DataObjID &  rhs  )

friend

Definition at line 62 of file DataObjID.h.

{ return lhs.m_hash < rhs.m_hash; }

std::ostream& operator<< ( std::ostream &  os, const DataObjID &  d  )

friend

Definition at line 68 of file DataObjID.h.

{ return toStream( d, os ); }

bool operator== ( const DataObjID &  lhs, const DataObjID &  rhs  )

friend

Definition at line 63 of file DataObjID.h.

{ return lhs.m_hash == rhs.m_hash; }

StatusCode parse ( DataObjID &  dest, const std::string &  src  )

friend

Definition at line 52 of file DataObjID.cpp.

{ return Gaudi::Parsers::parse_( dest, quote( src ) ); }

std::ostream& toStream ( const DataObjID &  v, std::ostream &  o  )

friend

Definition at line 92 of file DataObjID.cpp.

{
  using Gaudi::Utils::toStream;
  return ( d.m_clid != 0 || !d.m_className.empty() ) ? toStream( std::tie( d.m_className, d.m_key ), os )
                                                     : toStream( d.m_key, os );
}

Member Data Documentation

friend DataObjID::DataObjID_Hasher

Definition at line 40 of file DataObjID.h.

std::string DataObjID::m_className

private

Definition at line 79 of file DataObjID.h.

CLID DataObjID::m_clid {0}

private

Definition at line 75 of file DataObjID.h.

std::size_t DataObjID::m_hash {0}

private

Definition at line 76 of file DataObjID.h.

std::once_flag DataObjID::m_ip

staticprivate

Definition at line 82 of file DataObjID.h.

std::string DataObjID::m_key {"INVALID"}

private

Definition at line 78 of file DataObjID.h.

IClassIDSvc * DataObjID::p_clidSvc

staticprivate

Definition at line 81 of file DataObjID.h.

---

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

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