DataObjID Class Reference

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

Collaboration diagram for DataObjID:

Public Member Functions
	DataObjID ()=default
	DataObjID (const DataObjID &other)
	DataObjID (std::string key)
	DataObjID (const CLID &clid, std::string key)
	DataObjID (std::string className, std::string key)
DataObjID &	operator= (const DataObjID &other)
const std::string &	key () const
	only return the last part of the key
const std::string &	className () const
	return the ClassName (if available)
std::string	fullKey () const
	combination of the key and the ClassName, mostly for debugging
CLID	clid () const
std::size_t	hash () const
void	updateKey (std::string key)

Public Attributes
friend	DataObjID_Hasher

Private Member Functions
void	hashGen ()
void	setClid ()

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

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

Detailed Description

Definition at line 47 of file DataObjID.h.

Constructor & Destructor Documentation

DataObjID() [1/5]

DataObjID::DataObjID ( )

default

DataObjID() [2/5]

DataObjID::DataObjID ( const DataObjID & other )

inline

Definition at line 52 of file DataObjID.h.

      : m_clid( other.m_clid ), m_hash( other.m_hash ), m_key( other.m_key ), m_className( other.m_className ) {}

DataObjID() [3/5]

DataObjID::DataObjID ( std::string key )

inline

Definition at line 100 of file DataObjID.h.

: m_key( std::move( key ) ) { hashGen(); }

DataObjID() [4/5]

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

inline

Definition at line 102 of file DataObjID.h.

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

DataObjID() [5/5]

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

inline

Definition at line 106 of file DataObjID.h.

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

Member Function Documentation

className()

const std::string & DataObjID::className

(

)

const

return the ClassName (if available)

Definition at line 90 of file DataObjID.cpp.

                                            {
 
  // Set class name once if not done already
  if ( m_clid != 0 && m_className.empty() ) {
    std::call_once( m_setClassName, [&]() {
      if ( !getClidSvc() || getClidSvc()->getTypeNameOfID( m_clid, m_className ).isFailure() ) {
        m_className = "UNKNOWN_CLID:" + std::to_string( m_clid );
      }
    } );
  }
  return m_className;
}

clid()

CLID DataObjID::clid ( ) const

inline

Definition at line 76 of file DataObjID.h.

{ return m_clid; }

fullKey()

std::string DataObjID::fullKey

(

)

const

combination of the key and the ClassName, mostly for debugging

Definition at line 103 of file DataObjID.cpp.

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

hash()

std::size_t DataObjID::hash ( ) const

inline

Definition at line 77 of file DataObjID.h.

{ return m_hash; }

hashGen()

void DataObjID::hashGen ( )

private

Definition at line 76 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 );
  }
}

key()

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

inline

only return the last part of the key

Definition at line 68 of file DataObjID.h.

{ return m_key; }

operator=()

DataObjID & DataObjID::operator= ( const DataObjID & other )

inline

Definition at line 59 of file DataObjID.h.

                                                 {
    m_clid      = other.m_clid;
    m_hash      = other.m_hash;
    m_key       = other.m_key;
    m_className = other.m_className;
    return *this;
  }

setClid()

void DataObjID::setClid ( )

private

Definition at line 68 of file DataObjID.cpp.

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

updateKey()

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

inline

Definition at line 112 of file DataObjID.h.

                                                {
  m_key = std::move( key );
  hashGen();
}

Friends And Related Symbol Documentation

operator<

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

friend

Definition at line 81 of file DataObjID.h.

{ return lhs.m_hash < rhs.m_hash; }

operator<<

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

friend

Definition at line 86 of file DataObjID.h.

{ return toStream( d, os ); }

operator==

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

friend

Definition at line 82 of file DataObjID.h.

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

parse

StatusCode parse ( DataObjID & dest, std::string_view src )

friend

Definition at line 58 of file DataObjID.cpp.

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

toStream

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

friend

Definition at line 84 of file DataObjID.cpp.

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

Member Data Documentation

DataObjID_Hasher

friend DataObjID::DataObjID_Hasher

Definition at line 49 of file DataObjID.h.

m_className

std::string DataObjID::m_className

mutableprivate

Definition at line 96 of file DataObjID.h.

m_clid

CLID DataObjID::m_clid { 0 }

private

Definition at line 92 of file DataObjID.h.

{ 0 };

m_hash

std::size_t DataObjID::m_hash { 0 }

private

Definition at line 93 of file DataObjID.h.

{ 0 };

m_key

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

private

Definition at line 95 of file DataObjID.h.

{ "INVALID" };

m_setClassName

std::once_flag DataObjID::m_setClassName

mutableprivate

Definition at line 97 of file DataObjID.h.

---

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

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