CMS 3D CMS Logo

GctUnpackCollections Class Reference

RAII and useful methods for the many dataformat collections required by the GCT unpacker. More...

#include <EventFilter/GctRawToDigi/src/GctUnpackCollections.h>

List of all members.

Public Member Functions

L1GctJetCandCollection *const gctCenJets () const
 GCT output: Central Jets collection.
L1GctEtHadCollection *const gctEtHad () const
 GCT output: Hadronic transverse-energy (Ht) collection.
L1GctEtMissCollection *const gctEtMiss () const
 GCT output: Missing Et collection.
L1GctEtTotalCollection *const gctEtTot () const
 GCT output: Total Et collection.
L1GctFibreCollection *const gctFibres () const
 Raw fibre input to the GCT.
L1GctJetCandCollection *const gctForJets () const
 GCT output: Forward Jets collection.
L1GctHFBitCountsCollection *const gctHfBitCounts () const
 GCT output: Hadronic-Forward bit-counts collection.
L1GctHFRingEtSumsCollection *const gctHfRingEtSums () const
 GCT output: Hadronic-Forward ring-sums collection.
L1GctInternEmCandCollection *const gctInternEm () const
 Internal EM candidate collection.
L1GctInternEtSumCollection *const gctInternEtSums () const
 Internal Et Sum collection.
L1GctInternJetDataCollection *const gctInternJets () const
 Internal Jet candidate collection.
L1GctEmCandCollection *const gctIsoEm () const
 GCT output: Isolated EM candidate collection.
L1GctJetCountsCollection *const gctJetCounts () const
 DEPRECATED. ONLY GT NEEDS THIS.
L1GctEmCandCollection *const gctNonIsoEm () const
 GCT output: Non-isolated EM candidate collection.
L1GctJetCandCollection *const gctTauJets () const
 GCT output: Tau Jets collection.
 GctUnpackCollections (edm::Event &event, const bool hltMode)
 Construct with an event. The collections get put into the event when the object instance goes out of scope (i.e. in the destructor).
L1CaloRegionCollection *const rctCalo () const
 Input calo regions from the RCT to the GCT.
L1CaloEmCollection *const rctEm () const
 Input electrons from the RCT to the GCT.
 ~GctUnpackCollections ()
 Destructor - the last action of this object is to put the gct collections into the event provided on construction.

Private Member Functions

 GctUnpackCollections (const GctUnpackCollections &)
 Copy ctor - deliberately not implemented!
GctUnpackCollectionsoperator= (const GctUnpackCollections &)
 Assignment op - deliberately not implemented!

Private Attributes

edm::Eventm_event
 The event the collections will be put into on destruction of the GctUnpackCollections instance.
std::auto_ptr
< L1GctJetCandCollection
m_gctCenJets
std::auto_ptr
< L1GctEtHadCollection
m_gctEtHad
std::auto_ptr
< L1GctEtMissCollection
m_gctEtMiss
std::auto_ptr
< L1GctEtTotalCollection
m_gctEtTot
std::auto_ptr
< L1GctFibreCollection
m_gctFibres
 Raw fibre input to the GCT.
std::auto_ptr
< L1GctJetCandCollection
m_gctForJets
std::auto_ptr
< L1GctHFBitCountsCollection
m_gctHfBitCounts
std::auto_ptr
< L1GctHFRingEtSumsCollection
m_gctHfRingEtSums
std::auto_ptr
< L1GctInternEmCandCollection
m_gctInternEm
std::auto_ptr
< L1GctInternEtSumCollection
m_gctInternEtSums
std::auto_ptr
< L1GctInternJetDataCollection
m_gctInternJets
std::auto_ptr
< L1GctEmCandCollection
m_gctIsoEm
std::auto_ptr
< L1GctJetCountsCollection
m_gctJetCounts
std::auto_ptr
< L1GctEmCandCollection
m_gctNonIsoEm
std::auto_ptr
< L1GctJetCandCollection
m_gctTauJets
const bool m_hltMode
 For the 31X to 22X backport, the hltMode flag is needed here to control what is put into the event.
std::auto_ptr
< L1CaloRegionCollection
m_rctCalo
 Input calo regions.
std::auto_ptr< L1CaloEmCollectionm_rctEm
 Input electrons.


Detailed Description

RAII and useful methods for the many dataformat collections required by the GCT unpacker.

Deliberately made non-copyable with const members and private copy ctor, etc.

Author:
Robert Frazier
Revision
1.1.2.5
Date
2009/04/30 13:20:08

Definition at line 23 of file GctUnpackCollections.h.


Constructor & Destructor Documentation

GctUnpackCollections::GctUnpackCollections ( edm::Event event,
const bool  hltMode 
)

Construct with an event. The collections get put into the event when the object instance goes out of scope (i.e. in the destructor).

Parameters:
hltMode flag is added here as part of the 31X to 22X backport. It's needed to control what gets put into the event.

Definition at line 4 of file GctUnpackCollections.cc.

References m_gctCenJets, m_gctForJets, m_gctIsoEm, and m_gctTauJets.

00004                                                                              :
00005   m_event(event),
00006   m_hltMode(hltMode),
00007   m_gctFibres(new L1GctFibreCollection()),  // GCT input collections
00008   m_rctEm(new L1CaloEmCollection()),
00009   m_rctCalo(new L1CaloRegionCollection()),
00010   m_gctInternEm(new L1GctInternEmCandCollection()),  // GCT internal collections
00011   m_gctInternJets(new L1GctInternJetDataCollection()),
00012   m_gctInternEtSums(new L1GctInternEtSumCollection()),
00013   m_gctIsoEm(new L1GctEmCandCollection()),  // GCT output collections
00014   m_gctNonIsoEm(new L1GctEmCandCollection()),
00015   m_gctCenJets(new L1GctJetCandCollection()),
00016   m_gctForJets(new L1GctJetCandCollection()),
00017   m_gctTauJets(new L1GctJetCandCollection()),
00018   m_gctHfBitCounts(new L1GctHFBitCountsCollection()),
00019   m_gctHfRingEtSums(new L1GctHFRingEtSumsCollection()),
00020   m_gctEtTot(new L1GctEtTotalCollection()),
00021   m_gctEtHad(new L1GctEtHadCollection()),
00022   m_gctEtMiss(new L1GctEtMissCollection()),
00023   m_gctJetCounts(new L1GctJetCountsCollection())  // Deprecated (empty collection still needed by GT)
00024 {
00025   m_gctIsoEm->reserve(4);
00026   m_gctCenJets->reserve(4);
00027   m_gctForJets->reserve(4);
00028   m_gctTauJets->reserve(4);
00029   // ** DON'T RESERVE SPACE IN VECTORS FOR DEBUG UNPACK ITEMS! **
00030 }

GctUnpackCollections::~GctUnpackCollections (  ) 

Destructor - the last action of this object is to put the gct collections into the event provided on construction.

Definition at line 32 of file GctUnpackCollections.cc.

References m_event, m_gctCenJets, m_gctEtHad, m_gctEtMiss, m_gctEtTot, m_gctFibres, m_gctForJets, m_gctHfBitCounts, m_gctHfRingEtSums, m_gctInternEm, m_gctInternEtSums, m_gctInternJets, m_gctIsoEm, m_gctJetCounts, m_gctNonIsoEm, m_gctTauJets, m_hltMode, m_rctCalo, m_rctEm, and edm::Event::put().

00033 {
00034   // GCT input collections
00035   if(!m_hltMode) { m_event.put(m_gctFibres); }
00036   m_event.put(m_rctEm);
00037   m_event.put(m_rctCalo);
00038 
00039   // GCT internal collections
00040   if(!m_hltMode)
00041   {
00042     m_event.put(m_gctInternEm);
00043     m_event.put(m_gctInternJets);
00044     m_event.put(m_gctInternEtSums);
00045   }
00046 
00047   // GCT output collections
00048   m_event.put(m_gctIsoEm, "isoEm");
00049   m_event.put(m_gctNonIsoEm, "nonIsoEm");
00050   m_event.put(m_gctCenJets,"cenJets");
00051   m_event.put(m_gctForJets,"forJets");
00052   m_event.put(m_gctTauJets,"tauJets");
00053   m_event.put(m_gctHfBitCounts);
00054   m_event.put(m_gctHfRingEtSums);
00055   m_event.put(m_gctEtTot);
00056   m_event.put(m_gctEtHad);
00057   m_event.put(m_gctEtMiss);
00058   m_event.put(m_gctJetCounts);  // Deprecated (empty collection still needed by GT)
00059 }

GctUnpackCollections::GctUnpackCollections ( const GctUnpackCollections  )  [private]

Copy ctor - deliberately not implemented!


Member Function Documentation

L1GctJetCandCollection* const GctUnpackCollections::gctCenJets (  )  const [inline]

GCT output: Central Jets collection.

Definition at line 46 of file GctUnpackCollections.h.

References m_gctCenJets.

Referenced by GctFormatTranslateBase::gctJets(), and operator<<().

L1GctEtHadCollection* const GctUnpackCollections::gctEtHad (  )  const [inline]

GCT output: Hadronic transverse-energy (Ht) collection.

Definition at line 52 of file GctUnpackCollections.h.

References m_gctEtHad.

Referenced by GctFormatTranslateV35::blockToGctEmCandsAndEnergySums(), GctFormatTranslateMCLegacy::blockToGctEmCandsAndEnergySums(), GctFormatTranslateV38::blockToGctEmCandsAndEnergySums(), and operator<<().

L1GctEtMissCollection* const GctUnpackCollections::gctEtMiss (  )  const [inline]

GCT output: Missing Et collection.

Definition at line 53 of file GctUnpackCollections.h.

References m_gctEtMiss.

Referenced by GctFormatTranslateV35::blockToGctEmCandsAndEnergySums(), GctFormatTranslateMCLegacy::blockToGctEmCandsAndEnergySums(), GctFormatTranslateV38::blockToGctEmCandsAndEnergySums(), and operator<<().

L1GctEtTotalCollection* const GctUnpackCollections::gctEtTot (  )  const [inline]

GCT output: Total Et collection.

Definition at line 51 of file GctUnpackCollections.h.

References m_gctEtTot.

Referenced by GctFormatTranslateV35::blockToGctEmCandsAndEnergySums(), GctFormatTranslateMCLegacy::blockToGctEmCandsAndEnergySums(), GctFormatTranslateV38::blockToGctEmCandsAndEnergySums(), and operator<<().

L1GctFibreCollection* const GctUnpackCollections::gctFibres (  )  const [inline]

Raw fibre input to the GCT.

Definition at line 34 of file GctUnpackCollections.h.

References m_gctFibres.

Referenced by GctFormatTranslateV35::blockToFibres(), GctFormatTranslateV38::blockToFibres(), GctFormatTranslateMCLegacy::blockToFibres(), and operator<<().

L1GctJetCandCollection* const GctUnpackCollections::gctForJets (  )  const [inline]

GCT output: Forward Jets collection.

Definition at line 47 of file GctUnpackCollections.h.

References m_gctForJets.

Referenced by GctFormatTranslateBase::gctJets(), and operator<<().

L1GctHFBitCountsCollection* const GctUnpackCollections::gctHfBitCounts (  )  const [inline]

GCT output: Hadronic-Forward bit-counts collection.

Definition at line 49 of file GctUnpackCollections.h.

References m_gctHfBitCounts.

Referenced by GctFormatTranslateV35::blockToGctJetCandsAndCounts(), GctFormatTranslateV38::blockToGctJetCandsAndCounts(), GctFormatTranslateMCLegacy::blockToGctJetCandsAndCounts(), and operator<<().

L1GctHFRingEtSumsCollection* const GctUnpackCollections::gctHfRingEtSums (  )  const [inline]

GCT output: Hadronic-Forward ring-sums collection.

Definition at line 50 of file GctUnpackCollections.h.

References m_gctHfRingEtSums.

Referenced by GctFormatTranslateV35::blockToGctJetCandsAndCounts(), GctFormatTranslateV38::blockToGctJetCandsAndCounts(), GctFormatTranslateMCLegacy::blockToGctJetCandsAndCounts(), and operator<<().

L1GctInternEmCandCollection* const GctUnpackCollections::gctInternEm (  )  const [inline]

Internal EM candidate collection.

Definition at line 39 of file GctUnpackCollections.h.

References m_gctInternEm.

Referenced by GctFormatTranslateV35::blockToGctInternEmCand(), GctFormatTranslateV38::blockToGctInternEmCand(), and operator<<().

L1GctInternEtSumCollection* const GctUnpackCollections::gctInternEtSums (  )  const [inline]

Internal Et Sum collection.

Definition at line 41 of file GctUnpackCollections.h.

References m_gctInternEtSums.

Referenced by operator<<().

L1GctInternJetDataCollection* const GctUnpackCollections::gctInternJets (  )  const [inline]

Internal Jet candidate collection.

Definition at line 40 of file GctUnpackCollections.h.

References m_gctInternJets.

Referenced by GctFormatTranslateV35::blockToGctJetClusterMinimal(), GctFormatTranslateV38::blockToGctJetClusterMinimal(), GctFormatTranslateV35::blockToGctJetPreCluster(), GctFormatTranslateV38::blockToGctJetPreCluster(), GctFormatTranslateV35::blockToGctTrigObjects(), GctFormatTranslateV38::blockToGctTrigObjects(), and operator<<().

L1GctEmCandCollection* const GctUnpackCollections::gctIsoEm (  )  const [inline]

GCT output: Isolated EM candidate collection.

Definition at line 44 of file GctUnpackCollections.h.

References m_gctIsoEm.

Referenced by GctFormatTranslateV35::blockToGctEmCandsAndEnergySums(), GctFormatTranslateMCLegacy::blockToGctEmCandsAndEnergySums(), GctFormatTranslateV38::blockToGctEmCandsAndEnergySums(), and operator<<().

L1GctJetCountsCollection* const GctUnpackCollections::gctJetCounts (  )  const [inline]

DEPRECATED. ONLY GT NEEDS THIS.

Definition at line 54 of file GctUnpackCollections.h.

References m_gctJetCounts.

L1GctEmCandCollection* const GctUnpackCollections::gctNonIsoEm (  )  const [inline]

GCT output: Non-isolated EM candidate collection.

Definition at line 45 of file GctUnpackCollections.h.

References m_gctNonIsoEm.

Referenced by GctFormatTranslateV35::blockToGctEmCandsAndEnergySums(), GctFormatTranslateMCLegacy::blockToGctEmCandsAndEnergySums(), GctFormatTranslateV38::blockToGctEmCandsAndEnergySums(), and operator<<().

L1GctJetCandCollection* const GctUnpackCollections::gctTauJets (  )  const [inline]

GCT output: Tau Jets collection.

Definition at line 48 of file GctUnpackCollections.h.

References m_gctTauJets.

Referenced by GctFormatTranslateBase::gctJets(), and operator<<().

GctUnpackCollections& GctUnpackCollections::operator= ( const GctUnpackCollections  )  [private]

Assignment op - deliberately not implemented!

L1CaloRegionCollection* const GctUnpackCollections::rctCalo (  )  const [inline]

Input calo regions from the RCT to the GCT.

Definition at line 36 of file GctUnpackCollections.h.

References m_rctCalo.

Referenced by GctFormatTranslateMCLegacy::blockToAllRctCaloRegions(), GctFormatTranslateV35::blockToRctCaloRegions(), GctFormatTranslateV38::blockToRctCaloRegions(), and operator<<().

L1CaloEmCollection* const GctUnpackCollections::rctEm (  )  const [inline]

Input electrons from the RCT to the GCT.

Definition at line 35 of file GctUnpackCollections.h.

References m_rctEm.

Referenced by GctFormatTranslateV35::blockToRctEmCand(), GctFormatTranslateV38::blockToRctEmCand(), GctFormatTranslateMCLegacy::blockToRctEmCand(), and operator<<().


Member Data Documentation

edm::Event& GctUnpackCollections::m_event [private]

The event the collections will be put into on destruction of the GctUnpackCollections instance.

Definition at line 62 of file GctUnpackCollections.h.

Referenced by ~GctUnpackCollections().

std::auto_ptr<L1GctJetCandCollection> GctUnpackCollections::m_gctCenJets [private]

Definition at line 78 of file GctUnpackCollections.h.

Referenced by gctCenJets(), GctUnpackCollections(), and ~GctUnpackCollections().

std::auto_ptr<L1GctEtHadCollection> GctUnpackCollections::m_gctEtHad [private]

Definition at line 84 of file GctUnpackCollections.h.

Referenced by gctEtHad(), and ~GctUnpackCollections().

std::auto_ptr<L1GctEtMissCollection> GctUnpackCollections::m_gctEtMiss [private]

Definition at line 85 of file GctUnpackCollections.h.

Referenced by gctEtMiss(), and ~GctUnpackCollections().

std::auto_ptr<L1GctEtTotalCollection> GctUnpackCollections::m_gctEtTot [private]

Definition at line 83 of file GctUnpackCollections.h.

Referenced by gctEtTot(), and ~GctUnpackCollections().

std::auto_ptr<L1GctFibreCollection> GctUnpackCollections::m_gctFibres [private]

Raw fibre input to the GCT.

Definition at line 66 of file GctUnpackCollections.h.

Referenced by gctFibres(), and ~GctUnpackCollections().

std::auto_ptr<L1GctJetCandCollection> GctUnpackCollections::m_gctForJets [private]

Definition at line 79 of file GctUnpackCollections.h.

Referenced by gctForJets(), GctUnpackCollections(), and ~GctUnpackCollections().

std::auto_ptr<L1GctHFBitCountsCollection> GctUnpackCollections::m_gctHfBitCounts [private]

Definition at line 81 of file GctUnpackCollections.h.

Referenced by gctHfBitCounts(), and ~GctUnpackCollections().

std::auto_ptr<L1GctHFRingEtSumsCollection> GctUnpackCollections::m_gctHfRingEtSums [private]

Definition at line 82 of file GctUnpackCollections.h.

Referenced by gctHfRingEtSums(), and ~GctUnpackCollections().

std::auto_ptr<L1GctInternEmCandCollection> GctUnpackCollections::m_gctInternEm [private]

Definition at line 71 of file GctUnpackCollections.h.

Referenced by gctInternEm(), and ~GctUnpackCollections().

std::auto_ptr<L1GctInternEtSumCollection> GctUnpackCollections::m_gctInternEtSums [private]

Definition at line 73 of file GctUnpackCollections.h.

Referenced by gctInternEtSums(), and ~GctUnpackCollections().

std::auto_ptr<L1GctInternJetDataCollection> GctUnpackCollections::m_gctInternJets [private]

Definition at line 72 of file GctUnpackCollections.h.

Referenced by gctInternJets(), and ~GctUnpackCollections().

std::auto_ptr<L1GctEmCandCollection> GctUnpackCollections::m_gctIsoEm [private]

Definition at line 76 of file GctUnpackCollections.h.

Referenced by gctIsoEm(), GctUnpackCollections(), and ~GctUnpackCollections().

std::auto_ptr<L1GctJetCountsCollection> GctUnpackCollections::m_gctJetCounts [private]

Definition at line 86 of file GctUnpackCollections.h.

Referenced by gctJetCounts(), and ~GctUnpackCollections().

std::auto_ptr<L1GctEmCandCollection> GctUnpackCollections::m_gctNonIsoEm [private]

Definition at line 77 of file GctUnpackCollections.h.

Referenced by gctNonIsoEm(), and ~GctUnpackCollections().

std::auto_ptr<L1GctJetCandCollection> GctUnpackCollections::m_gctTauJets [private]

Definition at line 80 of file GctUnpackCollections.h.

Referenced by gctTauJets(), GctUnpackCollections(), and ~GctUnpackCollections().

const bool GctUnpackCollections::m_hltMode [private]

For the 31X to 22X backport, the hltMode flag is needed here to control what is put into the event.

Definition at line 63 of file GctUnpackCollections.h.

Referenced by ~GctUnpackCollections().

std::auto_ptr<L1CaloRegionCollection> GctUnpackCollections::m_rctCalo [private]

Input calo regions.

Definition at line 68 of file GctUnpackCollections.h.

Referenced by rctCalo(), and ~GctUnpackCollections().

std::auto_ptr<L1CaloEmCollection> GctUnpackCollections::m_rctEm [private]

Input electrons.

Definition at line 67 of file GctUnpackCollections.h.

Referenced by rctEm(), and ~GctUnpackCollections().


The documentation for this class was generated from the following files:
Generated on Tue Jun 9 18:21:11 2009 for CMSSW by  doxygen 1.5.4