doubly templated class interfacing access to feature containers in StoreGate. More...

#include <TypedHolder.h>

Inheritance diagram for HLT::TypedHolder< FEATURE, CONTAINER >:

Collaboration diagram for HLT::TypedHolder< FEATURE, CONTAINER >:

Public Types
template<typename T, bool value>
using	StatusCode_if = typename std::enable_if<std::is_same<T,CONTAINER>::value == value,StatusCode>::type
	shorthand for enable_if with returning StatusCode base on comparison with CONTAINER type

Public Member Functions
	TypedHolder (const BaseHolder &baseholder, const asg::EventStoreType *store, const std::string &container_name=ClassID_traits< CONTAINER >::typeName())
	constructor from BaseHolder.
	TypedHolder (const TypelessHolder &typeless, const asg::EventStoreType *store, const std::string &container_name=ClassID_traits< CONTAINER >::typeName())
	constructor from BaseHolder.
const std::string &	key () const
	key used to access EventStore
template<typename T>
StatusCode_if< T, true >	get (const T *&destination, HLT::TriggerElement::ObjectIndex idx)
	method creates a new VIEW container containing pointers to the elements pointed to by the ObjectIndex.
template<typename T>
StatusCode_if< T, false >	get (const T *&destination, HLT::TriggerElement::ObjectIndex idx)
	method retrieves container from storegated and returns pointer at passed ObjectIndex Only enabled for ELEMENT holders (i.e.
virtual class_id_type	typeClid () const
virtual const std::string &	label () const
virtual sub_index_type	subTypeIndex () const
virtual bool	serialize (std::vector< uint32_t > &data) const
void	setLevel (MSG::Level lvl)
	Change the current logging level.
Functions providing the same interface as AthMessaging
bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.

Static Public Member Functions
static bool	enquireSerialized (std::vector< uint32_t >::const_iterator &fromHere, const std::vector< uint32_t >::const_iterator &end, class_id_type &c, std::string &label, sub_index_type &subtypeIndex)

Protected Attributes
class_id_type	m_clid
std::string	m_label
sub_index_type	m_sub

Private Member Functions
StatusCode	syncWithStore ()
	cache container retrieved from StoreGate
	TypedHolder ()
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
const asg::EventStoreType *	m_store = nullptr
const CONTAINER *	m_cont = nullptr
std::string	m_key
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

template<typename FEATURE, typename CONTAINER>
class HLT::TypedHolder< FEATURE, CONTAINER >

doubly templated class interfacing access to feature containers in StoreGate.

Definition at line 55 of file TypedHolder.h.

Member Typedef Documentation

◆ StatusCode_if

template<typename FEATURE, typename CONTAINER>

template<typename T, bool value>

using HLT::TypedHolder< FEATURE, CONTAINER >::StatusCode_if = typename std::enable_if<std::is_same<T,CONTAINER>::value == value,StatusCode>::type

shorthand for enable_if with returning StatusCode base on comparison with CONTAINER type

Definition at line 60 of file TypedHolder.h.

Constructor & Destructor Documentation

◆ TypedHolder() [1/3]

template<typename FEATURE, typename CONTAINER>

HLT::TypedHolder< FEATURE, CONTAINER >::TypedHolder	(	const BaseHolder &	baseholder,
		const asg::EventStoreType *	store,
		const std::string &	container_name = ClassID_traits<CONTAINER>::typeName() )

inline

constructor from BaseHolder.

Throws runtime exception if clids of BaseHolder and FEATURE type don't match

Definition at line 66 of file TypedHolder.h.

      : TypelessHolder(baseholder.typeClid(),baseholder.label(),baseholder.subTypeIndex()), 
    asg::AsgMessaging("TypedHolder"),
    m_store(store),
    m_cont(0) {
      //      if(!clidCheck<FEATURE>())
      //throw std::runtime_error("attempted construction with CLID mismatch! Check template parameter and passed typeless holder");
      m_key = HLTNavDetails::formatSGkey("HLT",container_name,this->label());
    }

◆ TypedHolder() [2/3]

template<typename FEATURE, typename CONTAINER>

HLT::TypedHolder< FEATURE, CONTAINER >::TypedHolder	(	const TypelessHolder &	typeless,
		const asg::EventStoreType *	store,
		const std::string &	container_name = ClassID_traits<CONTAINER>::typeName() )

inline

constructor from BaseHolder.

Throws runtime exception if clids of BaseHolder and FEATURE type don't match

Definition at line 79 of file TypedHolder.h.

      : TypelessHolder(typeless),
    asg::AsgMessaging("TypedHolder"),
    m_store(store),
    m_cont(0) {
      //if(!clidCheck<FEATURE>())
      //    throw std::runtime_error("attempted construction with CLID mismatch! Check template parameter and passed typeless holder");
      m_key = HLTNavDetails::formatSGkey("HLT",container_name,this->label());
    }

◆ TypedHolder() [3/3]

template<typename FEATURE, typename CONTAINER>

HLT::TypedHolder< FEATURE, CONTAINER >::TypedHolder ( )

inlineprivate

Definition at line 171 of file TypedHolder.h.

171{;}

Member Function Documentation

◆ enquireSerialized()

bool BaseHolder::enquireSerialized	(	std::vector< uint32_t >::const_iterator &	fromHere,
		const std::vector< uint32_t >::const_iterator &	end,
		class_id_type &	c,
		std::string &	label,
		sub_index_type &	subtypeIndex )

staticinherited

Definition at line 12 of file BaseHolder.cxx.

                                                  {
  using namespace std;
  if ( fromHere == end )  return false;  
 
  c = *fromHere++;
  if ( fromHere == end )  return false;
 
  subtypeIndex = *fromHere++;
  if ( fromHere == end ) return false;
  
  unsigned labelSize = *fromHere++;
  if ( fromHere == end ) return false;
  if ( fromHere+labelSize > end ) return false;
  
  std::vector<uint32_t>::const_iterator stringEnd = fromHere+labelSize;
  HLT::StringSerializer::deserialize(fromHere, stringEnd, label);
 
  //advance iterator to end of label
  std::advance(fromHere,labelSize);
 
  return true;
}

◆ get() [1/2]

template<typename FEATURE, typename CONTAINER>

template<typename T>

StatusCode_if< T, true > HLT::TypedHolder< FEATURE, CONTAINER >::get	(	const T *&	destination,
		HLT::TriggerElement::ObjectIndex	idx )

inline

method creates a new VIEW container containing pointers to the elements pointed to by the ObjectIndex.

Caller owns the VIEW container. Only enabled for CONTAINER holders

Definition at line 99 of file TypedHolder.h.

                                                                                                           {
      if(syncWithStore().isFailure()){
    ATH_MSG_ERROR("accessing holder with key: " << key() << " sync with store failed ");
    return StatusCode::FAILURE;
      }
      if(m_cont->size() < idx.objectsEnd()){
    ATH_MSG_ERROR("accessing holder with key: " << key() << " index past range " << "idx range is: " << idx.objectsBegin() << ":" << idx.objectsEnd() << " container size: " << m_cont->size());
    return StatusCode::FAILURE;
      };
 
      // make sure we get a fresh pointer as were about to set it to a newly created one
      if(destination){
    //ATH_MSG_ERROR("reference pointe provided is already set");
    return StatusCode::FAILURE;
      }
 
      CONTAINER* nonConstDestination = new CONTAINER(SG::VIEW_ELEMENTS);
 
       // need to cast to be able to use non const iterators
      CONTAINER* src = const_cast<CONTAINER*>(m_cont);
      typename CONTAINER::iterator beg = src->begin();
      typename CONTAINER::iterator end = src->begin();
      
      std::advance(beg, idx.objectsBegin());
      std::advance(end, idx.objectsEnd());
      nonConstDestination->insert(nonConstDestination->end(), beg, end);
 
      // from now own we don't want anybody modifying the container
      destination = nonConstDestination;
      return StatusCode::SUCCESS;
    }

◆ get() [2/2]

template<typename FEATURE, typename CONTAINER>

template<typename T>

StatusCode_if< T, false > HLT::TypedHolder< FEATURE, CONTAINER >::get	(	const T *&	destination,
		HLT::TriggerElement::ObjectIndex	idx )

inline

method retrieves container from storegated and returns pointer at passed ObjectIndex Only enabled for ELEMENT holders (i.e.

non CONTAINER)

Definition at line 135 of file TypedHolder.h.

                                                                                                            {
      if((idx.objectsEnd() - idx.objectsBegin())!=1){
    //ATH_MSG_ERROR("accessing holder with key: " << key() << "index is not single element: " << idx.objectsBegin() << ":" << idx.objectsEnd());
    return StatusCode::FAILURE;
      }
      if(syncWithStore().isFailure()){
    //ATH_MSG_ERROR("accessing holder with key: " << key() << " sync with store failed ");
    return StatusCode::FAILURE;
      }
      if(m_cont->size() < idx.objectsBegin()){
    //ATH_MSG_ERROR("accessing holder with key: " << key() << " index past range " << "indexBegin is: " << idx.objectsBegin() << " container size: " << m_cont->size() << std::endl;
    return StatusCode::FAILURE;
      };
 
      //everything went fine
      destination = m_cont->at(idx.objectsBegin());
      return StatusCode::SUCCESS;
    }

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

◆ key()

template<typename FEATURE, typename CONTAINER>

const std::string & HLT::TypedHolder< FEATURE, CONTAINER >::key ( ) const

inline

key used to access EventStore

Definition at line 92 of file TypedHolder.h.

92{return m_key;}

◆ label()

virtual const std::string & HLT::TypelessHolder::label ( ) const

inlinevirtualinherited

Implements HLT::BaseHolder.

Definition at line 15 of file TypelessHolder.h.

15{ return m_label; }

HLT::TypelessHolder::m_label

std::string m_label

Definition TypelessHolder.h:20

◆ msg() [1/2]

MsgStream & asg::AsgMessaging::msg ( ) const

inherited

The standard message stream.

Returns: A reference to the default message stream of this object.

Definition at line 49 of file AsgMessaging.cxx.

                                      {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg();
#else // not XAOD_STANDALONE
      return m_msg;
#endif // not XAOD_STANDALONE
   }

◆ msg() [2/2]

MsgStream & asg::AsgMessaging::msg ( const MSG::Level lvl ) const

inherited

The standard message stream.

Parameters

lvl	The message level to set the stream to

Returns: A reference to the default message stream, set to level "lvl"

Definition at line 57 of file AsgMessaging.cxx.

                                                          {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg( lvl );
#else // not XAOD_STANDALONE
      m_msg << lvl;
      return m_msg;
#endif // not XAOD_STANDALONE
   }

◆ msgLvl()

bool asg::AsgMessaging::msgLvl ( const MSG::Level lvl ) const

inherited

Test the output level of the object.

Parameters

lvl	The message level to test against

Returns: boolean Indicting if messages at given level will be printed; true If messages at level "lvl" will be printed

Definition at line 41 of file AsgMessaging.cxx.

                                                       {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msgLvl( lvl );
#else // not XAOD_STANDALONE
      return m_msg.msgLevel( lvl );
#endif // not XAOD_STANDALONE
   }

◆ serialize()

bool BaseHolder::serialize ( std::vector< uint32_t > & data ) const

virtualinherited

Reimplemented in HLTNavDetails::HolderImp< STORED, CONTAINER >, HLTNavDetails::IHolder, and HolderImp< STORED, CONTAINER >.

Definition at line 38 of file BaseHolder.cxx.

                                                            {  
  output.push_back( typeClid() );
  output.push_back( subTypeIndex() );
 
  const size_t labelSizeIndex = output.size();
  output.push_back( 0 );
  const size_t beforeSS = output.size(); 
  StringSerializer::serialize(label(), output);
  output[labelSizeIndex] = output.size() - beforeSS;  
  return true;
}

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

◆ subTypeIndex()

virtual sub_index_type HLT::TypelessHolder::subTypeIndex ( ) const

inlinevirtualinherited

Implements HLT::BaseHolder.

Definition at line 16 of file TypelessHolder.h.

16{ return m_sub; }

HLT::TypelessHolder::m_sub

sub_index_type m_sub

Definition TypelessHolder.h:21

◆ syncWithStore()

template<typename FEATURE, typename CONTAINER>

StatusCode HLT::TypedHolder< FEATURE, CONTAINER >::syncWithStore ( )

inlineprivate

cache container retrieved from StoreGate

Definition at line 159 of file TypedHolder.h.

                              {
      if(m_cont) return StatusCode::SUCCESS;
 
      StatusCode sc = m_store->retrieve(m_cont,key());
      
      //sanity checks
      if(sc.isFailure()) return StatusCode::FAILURE;
      if(!m_cont) return StatusCode::FAILURE;
 
      return StatusCode::SUCCESS;
    }

◆ typeClid()

virtual class_id_type HLT::TypelessHolder::typeClid ( ) const

inlinevirtualinherited

Implements HLT::BaseHolder.

Definition at line 14 of file TypelessHolder.h.

14{ return m_clid; }

HLT::TypelessHolder::m_clid

class_id_type m_clid

Definition TypelessHolder.h:19

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_clid

class_id_type HLT::TypelessHolder::m_clid

protectedinherited

Definition at line 19 of file TypelessHolder.h.

◆ m_cont

template<typename FEATURE, typename CONTAINER>

const CONTAINER* HLT::TypedHolder< FEATURE, CONTAINER >::m_cont = nullptr

private

Definition at line 173 of file TypedHolder.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_key

template<typename FEATURE, typename CONTAINER>

std::string HLT::TypedHolder< FEATURE, CONTAINER >::m_key

private

Definition at line 174 of file TypedHolder.h.

◆ m_label

std::string HLT::TypelessHolder::m_label

protectedinherited

Definition at line 20 of file TypelessHolder.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ MSG::NIL };

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_store

template<typename FEATURE, typename CONTAINER>

const asg::EventStoreType* HLT::TypedHolder< FEATURE, CONTAINER >::m_store = nullptr

private

Definition at line 172 of file TypedHolder.h.

◆ m_sub

sub_index_type HLT::TypelessHolder::m_sub

protectedinherited

Definition at line 21 of file TypelessHolder.h.

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

TypedHolder.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StatusCode_if

Constructor & Destructor Documentation

◆ TypedHolder() [1/3]

◆ TypedHolder() [2/3]

◆ TypedHolder() [3/3]

Member Function Documentation

◆ enquireSerialized()

◆ get() [1/2]

◆ get() [2/2]

◆ initMessaging()

◆ key()

◆ label()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ serialize()

◆ setLevel()

◆ subTypeIndex()

◆ syncWithStore()

◆ typeClid()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_clid

◆ m_cont

◆ m_imsg

◆ m_key

◆ m_label

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_store

◆ m_sub