LArConditionsContainerDB template class Author: Walter Lampl Initial Version: April, 22nd 2005. More...

#include <LArConditionsContainerDB.h>

Collaboration diagram for LArConditionsContainerDB< T >:

Classes
class	iteratorT
	Declaration of const iterator. More...

Public Types
typedef LArConditionsSubsetTraits< T >	Traits
typedef Traits::FebId	FebId
typedef Traits::ChannelVector	ChannelVector
typedef Traits::ConstChannelVector	ConstChannelVector
typedef Traits::ChannelVectorPointer	ChannelVectorPointer
typedef std::map< FebId, ChannelVectorPointer >	ConditionsMap
typedef std::unordered_map< FebId, ChannelVectorPointer >	ConditionsHashMap
typedef ChannelVector::const_iterator	ConstChannelIt
typedef ChannelVector::iterator	ChannelIt
typedef ConditionsMap::const_iterator	ConstConditionsMapIterator
typedef ConditionsMap::iterator	ConditionsMapIterator
typedef ConditionsMap::size_type	size_type
typedef std::vector< FebId >	FebIdVec
typedef Traits::Reference	Reference
typedef Traits::ConstReference	ConstReference
typedef Traits::Pointer	Pointer
typedef Traits::ConstPointer	ConstPointer
typedef iteratorT< ConditionsMapIterator, ChannelIt, Pointer, Reference >	iterator
typedef iteratorT< ConstConditionsMapIterator, ConstChannelIt, ConstPointer, ConstReference >	const_iterator

Public Member Functions
	LArConditionsContainerDB (unsigned int gain=0)
	Constructor with gain.
void	set (const FebId id, const int channel, const T &payload)
	Setter.
ConstReference	get (const FebId id, const int channel) const
	Getter.
Reference	getNonConst (const FebId id, const int channel)
	non-const get function (might extend FEB map)
bool	exist (FebId id) const
	Do conditions for FebId?
const_iterator	begin (const LArOnlineID_Base *onlineHelper) const
	Iterator over all channels.
const_iterator	end (const LArOnlineID_Base *onlineHelper) const
iterator	begin (const LArOnlineID_Base *onlineHelper)
iterator	end (const LArOnlineID_Base *onlineHelper)
const_iterator	begin (const LArOnlineID_Base *onlineHelper, const FebIdVec &febIds) const
	Iterator over all channels of selected FEBs.
iterator	begin (const LArOnlineID_Base *onlineHelper, const FebIdVec &febIds)
size_type	size () const
	Size of map.
int	getGain () const
	access to gain
void	setGain (int g)
	set gain
void	add (const LArConditionsContainerDB< T > *p)
	const ConditionsMap& getConditionsMap()const { return m_febMap ;} ;
void	add (FebId id, ChannelVectorPointer channelVec)
	add pointer to vector of (febid/channel vector)
void	erase (FebId id)
	erase element for this FebId

Protected Attributes
ConditionsMap	m_febMap
ConditionsHashMap	m_febHashMap
unsigned int	m_gain

Private Attributes
const iterator	m_dummyIt
const const_iterator	m_dummyConstIt

Detailed Description

template<class T>
class LArConditionsContainerDB< T >

LArConditionsContainerDB template class Author: Walter Lampl Initial Version: April, 22nd 2005.

Container class to store any kind of data object that is organized by FEB and FEB-channel number.

The data object stored in this container has to have a sensible default constructor. A default instance is returned by Get-function if the requested channel is not known. Furthermore, the data object must have a operator= because this operator is used by the set function.

About the iterator: The iterator-class holds internally a iterator over the FEB map and a iterator over the channels inside this FEB as well as an interator pointing to the last feb (NOT the end()!). begin() points to the first channel of the first FEB, end() to the 129th channel of the last FEB. The operator++ jumps form a last channel of FEB n to the first channel of FEB n+1 except we are already at the last FEB. The operator-- jumps from the first channel of FEB n to the last one of FEB n-1. It will try to do this even if FEB n is the first one and thus cause a segfault.

Definition at line 47 of file LArConditionsContainerDB.h.

Member Typedef Documentation

◆ ChannelIt

template<class T>

typedef ChannelVector::iterator LArConditionsContainerDB< T >::ChannelIt

Definition at line 59 of file LArConditionsContainerDB.h.

◆ ChannelVector

template<class T>

typedef Traits::ChannelVector LArConditionsContainerDB< T >::ChannelVector

Definition at line 53 of file LArConditionsContainerDB.h.

◆ ChannelVectorPointer

template<class T>

typedef Traits::ChannelVectorPointer LArConditionsContainerDB< T >::ChannelVectorPointer

Definition at line 55 of file LArConditionsContainerDB.h.

◆ ConditionsHashMap

template<class T>

typedef std::unordered_map<FebId, ChannelVectorPointer > LArConditionsContainerDB< T >::ConditionsHashMap

Definition at line 57 of file LArConditionsContainerDB.h.

◆ ConditionsMap

template<class T>

typedef std::map<FebId, ChannelVectorPointer > LArConditionsContainerDB< T >::ConditionsMap

Definition at line 56 of file LArConditionsContainerDB.h.

◆ ConditionsMapIterator

template<class T>

typedef ConditionsMap::iterator LArConditionsContainerDB< T >::ConditionsMapIterator

Definition at line 61 of file LArConditionsContainerDB.h.

◆ const_iterator

template<class T>

typedef iteratorT<ConstConditionsMapIterator, ConstChannelIt, ConstPointer, ConstReference> LArConditionsContainerDB< T >::const_iterator

Definition at line 116 of file LArConditionsContainerDB.h.

◆ ConstChannelIt

template<class T>

typedef ChannelVector::const_iterator LArConditionsContainerDB< T >::ConstChannelIt

Definition at line 58 of file LArConditionsContainerDB.h.

◆ ConstChannelVector

template<class T>

typedef Traits::ConstChannelVector LArConditionsContainerDB< T >::ConstChannelVector

Definition at line 54 of file LArConditionsContainerDB.h.

◆ ConstConditionsMapIterator

template<class T>

typedef ConditionsMap::const_iterator LArConditionsContainerDB< T >::ConstConditionsMapIterator

Definition at line 60 of file LArConditionsContainerDB.h.

◆ ConstPointer

template<class T>

typedef Traits::ConstPointer LArConditionsContainerDB< T >::ConstPointer

Definition at line 67 of file LArConditionsContainerDB.h.

◆ ConstReference

template<class T>

typedef Traits::ConstReference LArConditionsContainerDB< T >::ConstReference

Definition at line 65 of file LArConditionsContainerDB.h.

◆ FebId

template<class T>

typedef Traits::FebId LArConditionsContainerDB< T >::FebId

Definition at line 52 of file LArConditionsContainerDB.h.

◆ FebIdVec

template<class T>

typedef std::vector<FebId> LArConditionsContainerDB< T >::FebIdVec

Definition at line 63 of file LArConditionsContainerDB.h.

◆ iterator

template<class T>

typedef iteratorT<ConditionsMapIterator, ChannelIt, Pointer, Reference> LArConditionsContainerDB< T >::iterator

Definition at line 111 of file LArConditionsContainerDB.h.

◆ Pointer

template<class T>

typedef Traits::Pointer LArConditionsContainerDB< T >::Pointer

Definition at line 66 of file LArConditionsContainerDB.h.

◆ Reference

template<class T>

typedef Traits::Reference LArConditionsContainerDB< T >::Reference

Definition at line 64 of file LArConditionsContainerDB.h.

◆ size_type

template<class T>

typedef ConditionsMap::size_type LArConditionsContainerDB< T >::size_type

Definition at line 62 of file LArConditionsContainerDB.h.

◆ Traits

template<class T>

typedef LArConditionsSubsetTraits<T> LArConditionsContainerDB< T >::Traits

Definition at line 51 of file LArConditionsContainerDB.h.

Constructor & Destructor Documentation

◆ LArConditionsContainerDB()

template<class T>

LArConditionsContainerDB< T >::LArConditionsContainerDB ( unsigned int gain = 0 )

inline

Constructor with gain.

Definition at line 186 of file LArConditionsContainerDB.h.

    :
    m_gain(gain)
{}

Member Function Documentation

◆ add() [1/2]

template<class T>

void LArConditionsContainerDB< T >::add ( const LArConditionsContainerDB< T > * p )

inline

const ConditionsMap& getConditionsMap()const { return m_febMap ;} ;

Definition at line 657 of file LArConditionsContainerDB.h.

{ 
  // copy the data to this container. FEB by FEB. 
  //  if FEB id exist, the old data will be overwritten. 
 
  for (const auto& pp : p->m_febMap) {
    m_febMap[pp.first] = pp.second;
    m_febHashMap[pp.first] = pp.second;
  }
} 

◆ add() [2/2]

template<class T>

void LArConditionsContainerDB< T >::add	(	FebId	id,
		ChannelVectorPointer	channelVec )

inline

add pointer to vector of (febid/channel vector)

Definition at line 671 of file LArConditionsContainerDB.h.

{
    m_febMap[id]   = channelVec;
    m_febHashMap[id]   = channelVec;
}

◆ begin() [1/4]

template<class T>

LArConditionsContainerDB< T >::iterator LArConditionsContainerDB< T >::begin ( const LArOnlineID_Base * onlineHelper )

inline

Definition at line 210 of file LArConditionsContainerDB.h.

{
    if (m_febMap.size()==0) { //no elements yet, begin() and end() have to be identical
    return m_dummyIt;
    }
    else {
    return iterator(m_febMap.begin(),
                        m_febMap.begin()->second->begin(),
                        m_febMap.end(),
                        onlineHelper);    }
}

◆ begin() [2/4]

template<class T>

LArConditionsContainerDB< T >::const_iterator LArConditionsContainerDB< T >::begin ( const LArOnlineID_Base * onlineHelper ) const

inline

Iterator over all channels.

Definition at line 195 of file LArConditionsContainerDB.h.

{
    if (m_febMap.size()==0) { //no elements yet, begin() and end() have to be identical
    return m_dummyConstIt;
    }
    else {
    return const_iterator(m_febMap.begin(),
                  m_febMap.begin()->second->begin(),
                  m_febMap.end(),
                  onlineHelper);    }
}

◆ begin() [3/4]

template<class T>

LArConditionsContainerDB< T >::iterator LArConditionsContainerDB< T >::begin	(	const LArOnlineID_Base *	onlineHelper,
		const FebIdVec &	febIds )

inline

Definition at line 253 of file LArConditionsContainerDB.h.

{
    if (m_febMap.size()==0) { //no elements yet, begin() and end() have to be identical
    return m_dummyIt;
    }
    else {
      if(febIds.size()==0) return end(onlineHelper);
 
      ConditionsMapIterator it2 = m_febMap.end() ;
      for (FebId id : febIds) {
    it2 = m_febMap.find(id);
    if( it2 != m_febMap.end()) break; 
      }
      if( it2 == m_febMap.end()) return end(onlineHelper);
 
      return iterator( it2,
                       it2->second->begin(),
                       m_febMap.end(),
                       onlineHelper,
                       febIds);
    }
}

◆ begin() [4/4]

template<class T>

LArConditionsContainerDB< T >::const_iterator LArConditionsContainerDB< T >::begin	(	const LArOnlineID_Base *	onlineHelper,
		const FebIdVec &	febIds ) const

inline

Iterator over all channels of selected FEBs.

Definition at line 225 of file LArConditionsContainerDB.h.

{
    if (m_febMap.size()==0) { //no elements yet, begin() and end() have to be identical
    return m_dummyConstIt;
    }
    else {
      if(febIds.size()==0) return end(onlineHelper);
 
      ConstConditionsMapIterator it2 = m_febMap.end() ;
      for (FebId id : febIds) {
    it2 = m_febMap.find(id);
    if( it2 != m_febMap.end()) break; 
      }
      if( it2 == m_febMap.end()) return end(onlineHelper);
 
      return const_iterator( it2,
                             it2->second->begin(),
                             m_febMap.end(),
                             onlineHelper,
                             febIds);
    }
}

◆ end() [1/2]

template<class T>

LArConditionsContainerDB< T >::iterator LArConditionsContainerDB< T >::end ( const LArOnlineID_Base * onlineHelper )

inline

Definition at line 302 of file LArConditionsContainerDB.h.

{
    if (m_febMap.size()==0) {
    return m_dummyIt;
    }
    else {
    ConditionsMapIterator feb_end_it=m_febMap.end();
    ConditionsMapIterator last_feb_it=feb_end_it;
    last_feb_it--;
    return iterator(last_feb_it,
                        last_feb_it->second->end(),
                        feb_end_it,
                        onlineHelper);
    }
}

◆ end() [2/2]

template<class T>

LArConditionsContainerDB< T >::const_iterator LArConditionsContainerDB< T >::end ( const LArOnlineID_Base * onlineHelper ) const

inline

Definition at line 282 of file LArConditionsContainerDB.h.

{
    if (m_febMap.size()==0) {
    return m_dummyConstIt;
    }
    else {
    ConstConditionsMapIterator feb_end_it=m_febMap.end();
    ConstConditionsMapIterator last_feb_it=feb_end_it;
    last_feb_it--;
    return const_iterator(last_feb_it,
                  last_feb_it->second->end(),
                  feb_end_it,
                  onlineHelper);
    }
}

◆ erase()

template<class T>

void LArConditionsContainerDB< T >::erase ( FebId id )

inline

erase element for this FebId

Definition at line 680 of file LArConditionsContainerDB.h.

{
    m_febMap.erase(id);
    m_febHashMap.erase(id);
}

◆ exist()

template<class T>

bool LArConditionsContainerDB< T >::exist ( FebId id ) const

inline

Do conditions for FebId?

Used by writers to check whether add is needed.

Definition at line 626 of file LArConditionsContainerDB.h.

{
  return m_febHashMap.find (id) != m_febHashMap.end();
}

◆ get()

template<class T>

LArConditionsContainerDB< T >::ConstReference LArConditionsContainerDB< T >::get	(	const FebId	id,
		const int	channel ) const

inline

Getter.

Definition at line 583 of file LArConditionsContainerDB.h.

{
    // The get/set methods used to cache the iterator in m_febMap where the
    // last access was found.  That, however, is not at all thread-safe
    // (and was in fact observed to lead to incorrect results in MT jobs).
    // We need to get rid of the caching, but we'll also introduce
    // m_febHashMap to try to reduce the lookup overhead.
    // If this turns out to be a hot spot, then the iterator could
    // be returned to the caller via a cookie.
    typename ConditionsHashMap::const_iterator it = m_febHashMap.find (febId);
    if (it == m_febHashMap.end()) {
      // Unknown FEB
      return Traits::empty();
    }
 
    const ConstChannelVector& vec = *it->second;
    // First check the size - channel vec may be empty
    if (channel < static_cast<int>(vec.size())) {
    return vec[channel];
    }
    else {
        return Traits::empty();
    }
}

◆ getGain()

template<class T>

int LArConditionsContainerDB< T >::getGain ( ) const

inline

access to gain

Definition at line 649 of file LArConditionsContainerDB.h.

{ 
  return m_gain;
} 

◆ getNonConst()

template<class T>

LArConditionsContainerDB< T >::Reference LArConditionsContainerDB< T >::getNonConst	(	const FebId	id,
		const int	channel )

inline

non-const get function (might extend FEB map)

Definition at line 611 of file LArConditionsContainerDB.h.

{
    typename ConditionsHashMap::iterator it = m_febHashMap.find (febId);
    if (it == m_febHashMap.end()) {
      throw std::runtime_error ("Unknown FEB");
    }
 
    ChannelVector& vec = *it->second;
    // Note: channel vec should always be full for non-const access
    return vec[channel];
}

◆ set()

template<class T>

void LArConditionsContainerDB< T >::set	(	const FebId	id,
		const int	channel,
		const T &	payload )

inline

Setter.

Definition at line 565 of file LArConditionsContainerDB.h.

{
  typename ConditionsHashMap::iterator it = m_febHashMap.find (febId);
  if (it == m_febHashMap.end()) {
    // Should never get here
    std::cout << "LArConditionsContainerDB<T>::set ERROR could not find FEB ID " 
              << febId << std::endl;
    return;
  }
    
  // Set payload
  (*(it->second))[channel] = payload;
}

◆ setGain()

template<class T>

void LArConditionsContainerDB< T >::setGain ( int g )

inline

set gain

Definition at line 633 of file LArConditionsContainerDB.h.

{ 
  m_gain = g;
  return;
} 

◆ size()

template<class T>

LArConditionsContainerDB< T >::size_type LArConditionsContainerDB< T >::size ( ) const

inline

Size of map.

Definition at line 642 of file LArConditionsContainerDB.h.

{
    return (m_febMap.size());
}

Member Data Documentation

◆ m_dummyConstIt

template<class T>

const const_iterator LArConditionsContainerDB< T >::m_dummyConstIt

private

Definition at line 179 of file LArConditionsContainerDB.h.

◆ m_dummyIt

template<class T>

const iterator LArConditionsContainerDB< T >::m_dummyIt

private

Definition at line 178 of file LArConditionsContainerDB.h.

◆ m_febHashMap

template<class T>

ConditionsHashMap LArConditionsContainerDB< T >::m_febHashMap

protected

Definition at line 172 of file LArConditionsContainerDB.h.

◆ m_febMap

template<class T>

ConditionsMap LArConditionsContainerDB< T >::m_febMap

protected

Definition at line 171 of file LArConditionsContainerDB.h.

◆ m_gain

template<class T>

unsigned int LArConditionsContainerDB< T >::m_gain

protected

Definition at line 174 of file LArConditionsContainerDB.h.

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

LArConditionsContainerDB.h

Classes

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ChannelIt

◆ ChannelVector

◆ ChannelVectorPointer

◆ ConditionsHashMap

◆ ConditionsMap

◆ ConditionsMapIterator

◆ const_iterator

◆ ConstChannelIt

◆ ConstChannelVector

◆ ConstConditionsMapIterator

◆ ConstPointer

◆ ConstReference

◆ FebId

◆ FebIdVec

◆ iterator

◆ Pointer

◆ Reference

◆ size_type

◆ Traits

Constructor & Destructor Documentation

◆ LArConditionsContainerDB()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ begin() [1/4]

◆ begin() [2/4]

◆ begin() [3/4]

◆ begin() [4/4]

◆ end() [1/2]

◆ end() [2/2]

◆ erase()

◆ exist()

◆ get()

◆ getGain()

◆ getNonConst()

◆ set()

◆ setGain()

◆ size()

Member Data Documentation

◆ m_dummyConstIt

◆ m_dummyIt

◆ m_febHashMap

◆ m_febMap

◆ m_gain