CMS 3D CMS Logo

GctBlockHeader.h
Go to the documentation of this file.
1 #ifndef GctBlockHeader_h_
2 #define GctBlockHeader_h_
3 
11 // C++ headers
12 #include <ostream>
13 #include <cstdint>
14 
16 public:
17  /* PUBLIC METHODS */
18 
20 
21  GctBlockHeader(uint32_t blockId, uint32_t blockLength, uint32_t nSamples, uint32_t bxId, uint32_t eventId, bool valid);
22 
25 
27  uint32_t blockId() const { return m_blockId; }
28 
30  uint32_t blockLength() const { return m_blockLength; }
31 
33  uint32_t nSamples() const { return m_nSamples; }
34 
36  uint32_t bxId() const { return m_bxId; }
37 
39  uint32_t eventId() const { return m_eventId; }
40 
42  bool valid() const { return m_valid; }
43 
44 private:
45  /* PRIVATE METHODS */
46 
47  /* PRIVATE MEMBER DATA */
48 
49  uint32_t m_blockId;
50 
51  uint32_t m_blockLength;
52 
53  uint32_t m_nSamples;
54 
55  uint32_t m_bxId;
56 
57  uint32_t m_eventId;
58 
59  bool m_valid;
60 };
61 
62 #include <vector>
63 typedef std::vector<GctBlockHeader> GctBlockHeaderCollection;
64 
65 std::ostream& operator<<(std::ostream& os, const GctBlockHeader& h);
66 
67 #endif /* GctBlockHeader_h_ */
operator<<
std::ostream & operator<<(std::ostream &os, const GctBlockHeader &h)
Definition: GctBlockHeader.cc:12
GctBlockHeader::valid
bool valid() const
Returns true if it's valid block header - i.e. if the header is known and can be unpacked.
Definition: GctBlockHeader.h:42
GctBlockHeaderCollection
std::vector< GctBlockHeader > GctBlockHeaderCollection
Definition: GctBlockHeader.h:63
GctBlockHeader
Simple class for holding the basic attributes of an 32-bit block header.
Definition: GctBlockHeader.h:15
GctBlockHeader::m_valid
bool m_valid
Is this a valid block header.
Definition: GctBlockHeader.h:59
GctBlockHeader::blockId
uint32_t blockId() const
Get the block ID.
Definition: GctBlockHeader.h:27
GctBlockHeader::eventId
uint32_t eventId() const
Get the event ID.
Definition: GctBlockHeader.h:39
GctBlockHeader::m_bxId
uint32_t m_bxId
The bunch-crossing ID.
Definition: GctBlockHeader.h:55
h
GctBlockHeader::m_eventId
uint32_t m_eventId
The event ID.
Definition: GctBlockHeader.h:57
GctBlockHeader::blockLength
uint32_t blockLength() const
Get the fundamental block length (for 1 time sample)
Definition: GctBlockHeader.h:30
GctBlockHeader::m_blockId
uint32_t m_blockId
The Block ID.
Definition: GctBlockHeader.h:49
GctBlockHeader::~GctBlockHeader
~GctBlockHeader()
Destructor.
Definition: GctBlockHeader.h:24
GctBlockHeader::GctBlockHeader
GctBlockHeader(uint32_t blockId, uint32_t blockLength, uint32_t nSamples, uint32_t bxId, uint32_t eventId, bool valid)
Constructor. Don't use directly - use the generateBlockHeader() method in GctFormatTranslateBase-deri...
Definition: GctBlockHeader.cc:3
GctBlockHeader::bxId
uint32_t bxId() const
Get the bunch crossing ID.
Definition: GctBlockHeader.h:36
GctBlockHeader::m_blockLength
uint32_t m_blockLength
The fundamental block length (for 1 time sample)
Definition: GctBlockHeader.h:51
GctBlockHeader::nSamples
uint32_t nSamples() const
Get the number of time samples.
Definition: GctBlockHeader.h:33
GctBlockHeader::m_nSamples
uint32_t m_nSamples
The number of time-samples.
Definition: GctBlockHeader.h:53