HcalElectronicsMap Class Reference

#include <HcalElectronicsMap.h>

Classes
class	PrecisionItem
class	TriggerItem

Public Member Functions
std::vector< HcalElectronicsId >	allElectronicsId () const
std::vector< HcalElectronicsId >	allElectronicsIdPrecision () const
std::vector< HcalElectronicsId >	allElectronicsIdTrigger () const
std::vector< HcalGenericDetId >	allPrecisionId () const
std::vector< HcalTrigTowerDetId >	allTriggerId () const
	HcalElectronicsMap ()
	HcalElectronicsMap (const HcalElectronicsMap &src)
	HcalElectronicsMap (HcalElectronicsMap &&other)
const DetId	lookup (HcalElectronicsId fId) const
	lookup the logical detid associated with the given electronics id More...
const HcalElectronicsId	lookup (DetId fId) const
	brief lookup the electronics detid associated with the given logical id More...
bool	lookup (const HcalElectronicsId pId, HcalElectronicsId &eid, HcalGenericDetId &did) const
	brief lookup the DetId and full electronics id associated with this partial (dcc/spigot/fiber/fiberchan) id More...
bool	lookup (const HcalElectronicsId pId, HcalElectronicsId &eid, HcalTrigTowerDetId &did) const
	brief lookup the DetId and full electronics id associated with this partial (dcc/spigot/slb/slbchan) id More...
const DetId	lookupTrigger (HcalElectronicsId fId) const
	brief lookup the trigger logical detid associated with the given electronics id More...
const HcalElectronicsId	lookupTrigger (DetId fId) const
	brief lookup the electronics detid associated with the given trigger logical id More...
bool	mapEId2chId (HcalElectronicsId fElectronicsId, DetId fId)
bool	mapEId2tId (HcalElectronicsId fElectronicsId, HcalTrigTowerDetId fTriggerId)
HcalElectronicsMap &	operator= (const HcalElectronicsMap &rhs)
void	sort ()
void	sortById () const
void	sortByTriggerId () const
void	swap (HcalElectronicsMap &other)
	~HcalElectronicsMap ()

Protected Member Functions
const PrecisionItem *	findById (unsigned long fId) const
const TriggerItem *	findByTrigId (unsigned long fTrigId) const
const PrecisionItem *	findPByElId (unsigned long fElId) const
const TriggerItem *	findTByElId (unsigned long fElId) const

Protected Attributes
std::vector< PrecisionItem >	mPItems
std::atomic< std::vector < const PrecisionItem * > * >	mPItemsById
std::vector< TriggerItem >	mTItems
std::atomic< std::vector < const TriggerItem * > * >	mTItemsByTrigId

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Friends
class	boost::serialization::access
template<typename CondSerializationT , typename Enabled >
struct	cond::serialization::access

Detailed Description

Author

Fedor Ratnikov (UMd) POOL object to store map between detector ID, electronics ID and trigger ID $Author: ratnikov

Date:

2007/12/10 18:36:43

Revision:

1.16

Author

Fedor Ratnikov (UMd) POOL object to store mapping for Hcal channels $Author: ratnikov

Date:

2007/09/18 06:48:38

Revision:

1.22

Definition at line 29 of file HcalElectronicsMap.h.

Constructor & Destructor Documentation

HcalElectronicsMap::HcalElectronicsMap

(

)

Definition at line 16 of file HcalElectronicsMap.cc.

                                       : 
  mPItems(HcalElectronicsId::maxLinearIndex+1),
  mTItems(HcalElectronicsId::maxLinearIndex+1),
  mPItemsById(nullptr), mTItemsByTrigId(nullptr)
{}

HcalElectronicsMap::~HcalElectronicsMap

(

)

Definition at line 27 of file HcalElectronicsMap.cc.

References mPItemsById, and mTItemsByTrigId.

                                        {
    delete mPItemsById.load();
    delete mTItemsByTrigId.load();
}

HcalElectronicsMap::HcalElectronicsMap

(

const HcalElectronicsMap &

src

)

Definition at line 32 of file HcalElectronicsMap.cc.

    : mPItems(src.mPItems), mTItems(src.mTItems),
      mPItemsById(nullptr), mTItemsByTrigId(nullptr) {}

HcalElectronicsMap::HcalElectronicsMap

(

HcalElectronicsMap &&

other

)

Definition at line 54 of file HcalElectronicsMap.cc.

References swap().

    : HcalElectronicsMap() {
    other.swap(*this);
}

Member Function Documentation

std::vector< HcalElectronicsId > HcalElectronicsMap::allElectronicsId

(

)

const

Definition at line 143 of file HcalElectronicsMap.cc.

References mPItems, mTItems, and mps_fire::result.

Referenced by HcalLuttoDB::analyze().

                                                                          {
  std::vector <HcalElectronicsId> result;
  for (std::vector<PrecisionItem>::const_iterator item = mPItems.begin (); item != mPItems.end (); item++) 
    if (item->mElId) result.push_back(HcalElectronicsId(item->mElId));
  for (std::vector<TriggerItem>::const_iterator item = mTItems.begin (); item != mTItems.end (); item++) 
    if (item->mElId) result.push_back(HcalElectronicsId(item->mElId));

  return result;
}

std::vector< HcalElectronicsId > HcalElectronicsMap::allElectronicsIdPrecision

(

)

const

Definition at line 153 of file HcalElectronicsMap.cc.

References mPItems, and mps_fire::result.

Referenced by HcalRawDataClient::beginRun(), HcalRawDataMonitor::bookHistograms(), HcalDetDiagLEDMonitor::CheckStatus(), HcalDetDiagPedestalMonitor::CheckStatus(), EMap::EMap(), HcalDetDiagLEDMonitor::fillHistos(), HcalDetDiagLaserMonitor::fillProblems(), HcalDetDiagLEDMonitor::SaveReference(), HcalDetDiagPedestalMonitor::SaveReference(), and HcalDetDiagLaserMonitor::SaveReference().

                                                                                  {
  std::vector <HcalElectronicsId> result;
  for (std::vector<PrecisionItem>::const_iterator item = mPItems.begin (); item != mPItems.end (); item++) 
    if (item->mElId) result.push_back(HcalElectronicsId(item->mElId));
  return result;
}

std::vector< HcalElectronicsId > HcalElectronicsMap::allElectronicsIdTrigger

(

)

const

Definition at line 160 of file HcalElectronicsMap.cc.

References mTItems, and mps_fire::result.

Referenced by EMap::EMap().

                                                                                {
  std::vector <HcalElectronicsId> result;
  for (std::vector<TriggerItem>::const_iterator item = mTItems.begin (); item != mTItems.end (); item++) 
    if (item->mElId) result.push_back(HcalElectronicsId(item->mElId));

  return result;
}

std::vector< HcalGenericDetId > HcalElectronicsMap::allPrecisionId

(

)

const

Definition at line 168 of file HcalElectronicsMap.cc.

References mPItems, and mps_fire::result.

                                                                       {
  std::vector <HcalGenericDetId> result;
  std::set <unsigned long> allIds;
  for (std::vector<PrecisionItem>::const_iterator item = mPItems.begin (); item != mPItems.end (); item++)  
    if (item->mId) allIds.insert (item->mId);
  for (std::set <unsigned long>::const_iterator channel = allIds.begin (); channel != allIds.end (); channel++) {
      result.push_back (HcalGenericDetId (*channel));
  }
  return result;
}

std::vector< HcalTrigTowerDetId > HcalElectronicsMap::allTriggerId

(

)

const

Definition at line 179 of file HcalElectronicsMap.cc.

References mTItems, and mps_fire::result.

                                                                       {
  std::vector <HcalTrigTowerDetId> result;
  std::set <unsigned long> allIds;
  for (std::vector<TriggerItem>::const_iterator item = mTItems.begin (); item != mTItems.end (); item++)  
    if (item->mTrigId) allIds.insert (item->mTrigId);
  for (std::set <unsigned long>::const_iterator channel = allIds.begin (); channel != allIds.end (); channel++)
    result.push_back (HcalTrigTowerDetId (*channel));
  return result;
}

const HcalElectronicsMap::PrecisionItem * HcalElectronicsMap::findById ( unsigned long  fId ) const

protected

Definition at line 59 of file HcalElectronicsMap.cc.

References mPItemsById, sortById(), and filterCSVwithJSON::target.

Referenced by lookup().

                                                                                            {
  PrecisionItem target (fId, 0);
  std::vector<const HcalElectronicsMap::PrecisionItem*>::const_iterator item;

  sortById();
  
  auto ptr = (*mPItemsById.load(std::memory_order_acquire));
  item = std::lower_bound (ptr.begin(), ptr.end(), &target, hcal_impl::LessById());
  if (item == ptr.end() || (*item)->mId != fId)
    //    throw cms::Exception ("Conditions not found") << "Unavailable Electronics map for cell " << fId;
    return 0;
  return *item;
}

const HcalElectronicsMap::TriggerItem * HcalElectronicsMap::findByTrigId ( unsigned long  fTrigId ) const

protected

Definition at line 90 of file HcalElectronicsMap.cc.

References mTItemsByTrigId, sortByTriggerId(), and filterCSVwithJSON::target.

Referenced by lookupTrigger().

                                                                                                  {
  TriggerItem target (fTrigId,0);
  std::vector<const HcalElectronicsMap::TriggerItem*>::const_iterator item;

  sortByTriggerId();
  
  auto ptr = (*mTItemsByTrigId.load(std::memory_order_acquire));
  item = std::lower_bound (ptr.begin(), ptr.end(), &target, hcal_impl::LessByTrigId());
  if (item == (*mTItemsByTrigId).end() || (*item)->mTrigId != fTrigId)
    //    throw cms::Exception ("Conditions not found") << "Unavailable Electronics map for cell " << fId;
    return 0;
  return *item;
}

const HcalElectronicsMap::PrecisionItem * HcalElectronicsMap::findPByElId ( unsigned long  fElId ) const

protected

Definition at line 73 of file HcalElectronicsMap.cc.

References i, HcalElectronicsId::linearIndex(), HcalElectronicsMap::PrecisionItem::mElId, and mPItems.

Referenced by lookup().

                                                                                                 {
  HcalElectronicsId eid(fElId);
  const PrecisionItem* i=&(mPItems[eid.linearIndex()]);
  
  if (i!=0 && i->mElId!=fElId) i=0;
  return i;
}

const HcalElectronicsMap::TriggerItem * HcalElectronicsMap::findTByElId ( unsigned long  fElId ) const

protected

Definition at line 81 of file HcalElectronicsMap.cc.

References i, HcalElectronicsId::linearIndex(), HcalElectronicsMap::TriggerItem::mElId, and mTItems.

Referenced by lookupTrigger().

                                                                                               {
  HcalElectronicsId eid(fElId);
  const TriggerItem* i=&(mTItems[eid.linearIndex()]);
  
  if (i!=0 && i->mElId!=fElId) i=0;
  return i;
}

const DetId HcalElectronicsMap::lookup

(

HcalElectronicsId

fId

)

const

lookup the logical detid associated with the given electronics id

Definition at line 104 of file HcalElectronicsMap.cc.

References findPByElId(), HcalElectronicsMap::PrecisionItem::mId, and HcalElectronicsId::rawId().

Referenced by HcalLuttoDB::analyze(), HcalRawDataClient::beginRun(), HcalRawDataMonitor::bookHistograms(), HcalDetDiagLEDMonitor::CheckStatus(), HcalDetDiagPedestalMonitor::CheckStatus(), HcalMonitorModule::CheckSubdetectorStatus(), HcalBaseDQMonitor::CheckSubdetectorStatus(), EMap::EMap(), ChannelPattern::Fill_by_hand(), HcalDetDiagLEDMonitor::fillHistos(), HcalDetDiagLaserMonitor::fillProblems(), HcalDetDiagLEDClient::htmlOutput(), HcalDetDiagLaserClient::htmlOutput(), HcalDetDiagPedestalClient::htmlOutput(), HcalPacker::pack(), HcalPatternSource::produce(), HcalTriggerPrimitiveAlgo::runFEFormatError(), HcalDetDiagLEDMonitor::SaveReference(), HcalDetDiagPedestalMonitor::SaveReference(), HcalDetDiagLaserMonitor::SaveReference(), HcalUnpacker::unpack(), HcalUnpacker::unpackUTCA(), and HcalUnpacker::unpackVME().

                                                                   {
  const PrecisionItem* item = findPByElId (fId.rawId ());
  return DetId (item ? item->mId : 0);
}

const HcalElectronicsId HcalElectronicsMap::lookup

(

DetId

fId

)

const

brief lookup the electronics detid associated with the given logical id

Definition at line 109 of file HcalElectronicsMap.cc.

References findById(), HcalElectronicsMap::PrecisionItem::mElId, and DetId::rawId().

                                                                  {
  const PrecisionItem* item = findById (fId.rawId ());
  return HcalElectronicsId (item ? item->mElId : 0);
}

bool HcalElectronicsMap::lookup	(	const HcalElectronicsId	pId,
		HcalElectronicsId &	eid,
		HcalGenericDetId &	did
	)		const

brief lookup the DetId and full electronics id associated with this partial (dcc/spigot/fiber/fiberchan) id

Definition at line 124 of file HcalElectronicsMap.cc.

References i, HcalElectronicsId::linearIndex(), HcalElectronicsMap::PrecisionItem::mElId, HcalElectronicsMap::PrecisionItem::mId, and mPItems.

                                                                                                                {
  const PrecisionItem* i=&(mPItems[pid.linearIndex()]);
  if (i!=0 && i->mId!=0) {
    eid=HcalElectronicsId(i->mElId);
    did=HcalGenericDetId(i->mId);
    return true;
  } else return false;
}

bool HcalElectronicsMap::lookup	(	const HcalElectronicsId	pId,
		HcalElectronicsId &	eid,
		HcalTrigTowerDetId &	did
	)		const

brief lookup the DetId and full electronics id associated with this partial (dcc/spigot/slb/slbchan) id

Definition at line 133 of file HcalElectronicsMap.cc.

References i, HcalElectronicsId::linearIndex(), HcalElectronicsMap::TriggerItem::mElId, mTItems, and HcalElectronicsMap::TriggerItem::mTrigId.

                                                                                                                  {
  const TriggerItem* i=&(mTItems[pid.linearIndex()]);
  if (i!=0 && i->mTrigId!=0) {
    eid=HcalElectronicsId(i->mElId);
    did=HcalGenericDetId(i->mTrigId);
    return true;
  } else return false;  
}

const DetId HcalElectronicsMap::lookupTrigger

(

HcalElectronicsId

fId

)

const

brief lookup the trigger logical detid associated with the given electronics id

Definition at line 114 of file HcalElectronicsMap.cc.

References findTByElId(), HcalElectronicsMap::TriggerItem::mTrigId, and HcalElectronicsId::rawId().

Referenced by HcalLuttoDB::analyze(), EMap::EMap(), HcalUnpacker::unpackUTCA(), and HcalUnpacker::unpackVME().

                                                                         {
  const TriggerItem* item = findTByElId (fId.rawId ());
  return DetId (item ? item->mTrigId : 0);
}

const HcalElectronicsId HcalElectronicsMap::lookupTrigger

(

DetId

fId

)

const

brief lookup the electronics detid associated with the given trigger logical id

Definition at line 119 of file HcalElectronicsMap.cc.

References findByTrigId(), HcalElectronicsMap::TriggerItem::mElId, and DetId::rawId().

                                                                         {
  const TriggerItem* item = findByTrigId (fId.rawId ());
  return HcalElectronicsId (item ? item->mElId : 0);
}

bool HcalElectronicsMap::mapEId2chId	(	HcalElectronicsId	fElectronicsId,
		DetId	fId
	)

Definition at line 209 of file HcalElectronicsMap.cc.

References HcalElectronicsId::linearIndex(), HcalElectronicsMap::PrecisionItem::mElId, HcalElectronicsMap::PrecisionItem::mId, mPItems, mPItemsById, DetId::rawId(), and HcalElectronicsId::rawId().

Referenced by HcalLogicalMap::generateHcalElectronicsMap(), and HcalDbOnline::getObject().

                                                                                 {
  PrecisionItem& item = mPItems[fElectronicsId.linearIndex()];

  delete mPItemsById.load();
  mPItemsById = nullptr;

  if (item.mElId==0) item.mElId=fElectronicsId.rawId();
  if (item.mId == 0) {
    item.mId = fId.rawId ();
  } 
  else if (item.mId != fId.rawId ()) {
     edm::LogWarning("HCAL") << "HcalElectronicsMap::mapEId2tId-> Electronics channel " <<  fElectronicsId << " already mapped to channel " 
                 << HcalGenericDetId(item.mId) << ". New value " << HcalGenericDetId(fId) << " is ignored" ;
       return false;
  }
  return true;
}

bool HcalElectronicsMap::mapEId2tId	(	HcalElectronicsId	fElectronicsId,
		HcalTrigTowerDetId	fTriggerId
	)

Definition at line 189 of file HcalElectronicsMap.cc.

References HcalElectronicsId::linearIndex(), HcalElectronicsMap::TriggerItem::mElId, mTItems, mTItemsByTrigId, HcalElectronicsMap::TriggerItem::mTrigId, DetId::rawId(), and HcalElectronicsId::rawId().

Referenced by HcalLogicalMap::generateHcalElectronicsMap().

                                                                                                    {
  TriggerItem& item = mTItems[fElectronicsId.linearIndex()];

  if (mTItemsByTrigId) {
      delete mTItemsByTrigId.load();
      mTItemsByTrigId = nullptr;
  }

  if (item.mElId==0) item.mElId=fElectronicsId.rawId();
  if (item.mTrigId == 0) {
    item.mTrigId = fTriggerId.rawId (); // just cast avoiding long machinery
  } 
  else if (item.mTrigId != fTriggerId.rawId ()) {
    edm::LogWarning("HCAL") << "HcalElectronicsMap::mapEId2tId-> Electronics channel " <<  fElectronicsId  << " already mapped to trigger channel " 
          << (HcalTrigTowerDetId(item.mTrigId)) << ". New value " << fTriggerId << " is ignored" ;
    return false;
  }
  return true;
}

HcalElectronicsMap & HcalElectronicsMap::operator=

(

const HcalElectronicsMap &

rhs

)

Definition at line 37 of file HcalElectronicsMap.cc.

References swap(), and groupFilesInBlocks::temp.

                                                           {
    HcalElectronicsMap temp(rhs);
    temp.swap(*this);
    return *this;
}

template<class Archive >

void HcalElectronicsMap::serialize ( Archive &  ar, const unsigned int  version  )

private

void HcalElectronicsMap::sort ( )

inline

Definition at line 78 of file HcalElectronicsMap.h.

Referenced by fillDefaults(), HcalLogicalMap::generateHcalElectronicsMap(), and HcalDbOnline::getObject().

{}

void HcalElectronicsMap::sortById

(

)

const

Definition at line 227 of file HcalElectronicsMap.cc.

References i, mPItems, and mPItemsById.

Referenced by findById().

                                         {
  if (!mPItemsById.load(std::memory_order_acquire)) {
      auto ptr = new std::vector<const PrecisionItem*>;
      for (auto i=mPItems.begin(); i!=mPItems.end(); ++i) {
          if (i->mElId) (*ptr).push_back(&(*i));
      }
    
      std::sort ((*ptr).begin(), (*ptr).end(), hcal_impl::LessById ());
      //atomically try to swap this to become mPItemsById
      std::vector<const PrecisionItem*>* expect = nullptr;
      bool exchanged = mPItemsById.compare_exchange_strong(expect, ptr, std::memory_order_acq_rel);
      if(!exchanged) {
          delete ptr;
      }
  }
}

void HcalElectronicsMap::sortByTriggerId

(

)

const

Definition at line 244 of file HcalElectronicsMap.cc.

References i, mTItems, and mTItemsByTrigId.

Referenced by findByTrigId().

                                                {
  if (!mTItemsByTrigId.load(std::memory_order_acquire)) {
      auto ptr = new std::vector<const TriggerItem*>;
      for (auto i=mTItems.begin(); i!=mTItems.end(); ++i) {
          if (i->mElId) (*ptr).push_back(&(*i));
      }
    
      std::sort ((*ptr).begin(), (*ptr).end(), hcal_impl::LessByTrigId ());
      //atomically try to swap this to become mTItemsByTrigId
      std::vector<const TriggerItem*>* expect = nullptr;
      bool exchanged = mTItemsByTrigId.compare_exchange_strong(expect, ptr, std::memory_order_acq_rel);
      if(!exchanged) {
          delete ptr;
      }
  }
}

void HcalElectronicsMap::swap

(

HcalElectronicsMap &

other

)

Definition at line 43 of file HcalElectronicsMap.cc.

References mPItems, mPItemsById, mTItems, mTItemsByTrigId, and std::swap().

Referenced by HcalElectronicsMap(), and operator=().

                                                       {
    std::swap(mPItems, other.mPItems);
    std::swap(mTItems, other.mTItems);
    other.mTItemsByTrigId.exchange(
            mTItemsByTrigId.exchange(other.mTItemsByTrigId.load(std::memory_order_acquire), std::memory_order_acq_rel),
            std::memory_order_acq_rel);
    other.mPItemsById.exchange(
            mPItemsById.exchange(other.mPItemsById.load(std::memory_order_acquire), std::memory_order_acq_rel),
            std::memory_order_acq_rel);
}

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Definition at line 116 of file HcalElectronicsMap.h.

template<typename CondSerializationT , typename Enabled >

friend struct cond::serialization::access

friend

Definition at line 116 of file HcalElectronicsMap.h.

Member Data Documentation

std::vector<PrecisionItem> HcalElectronicsMap::mPItems

protected

Definition at line 106 of file HcalElectronicsMap.h.

Referenced by allElectronicsId(), allElectronicsIdPrecision(), allPrecisionId(), findPByElId(), lookup(), mapEId2chId(), sortById(), and swap().

std::atomic<std::vector<const PrecisionItem*>*> HcalElectronicsMap::mPItemsById

mutableprotected

Definition at line 109 of file HcalElectronicsMap.h.

Referenced by findById(), mapEId2chId(), sortById(), swap(), and ~HcalElectronicsMap().

std::vector<TriggerItem> HcalElectronicsMap::mTItems

protected

Definition at line 107 of file HcalElectronicsMap.h.

Referenced by allElectronicsId(), allElectronicsIdTrigger(), allTriggerId(), findTByElId(), lookup(), mapEId2tId(), sortByTriggerId(), and swap().

std::atomic<std::vector<const TriggerItem*>*> HcalElectronicsMap::mTItemsByTrigId

mutableprotected

Definition at line 110 of file HcalElectronicsMap.h.

Referenced by findByTrigId(), mapEId2tId(), sortByTriggerId(), swap(), and ~HcalElectronicsMap().