GctBlockHeader Class Reference

Simple class for holding the basic attributes of an 32-bit block header. More...

#include <GctBlockHeader.h>

Public Member Functions
uint32_t	blockId () const
	Get the block ID. More...
uint32_t	blockLength () const
	Get the fundamental block length (for 1 time sample) More...
uint32_t	bxId () const
	Get the bunch crossing ID. More...
uint32_t	eventId () const
	Get the event ID. More...
	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-derived classes. More...
uint32_t	nSamples () const
	Get the number of time samples. More...
bool	valid () const
	Returns true if it's valid block header - i.e. if the header is known and can be unpacked. More...
	~GctBlockHeader ()
	Destructor. More...

Private Attributes
uint32_t	m_blockId
	The Block ID. More...
uint32_t	m_blockLength
	The fundamental block length (for 1 time sample) More...
uint32_t	m_bxId
	The bunch-crossing ID. More...
uint32_t	m_eventId
	The event ID. More...
uint32_t	m_nSamples
	The number of time-samples. More...
bool	m_valid
	Is this a valid block header. More...

Detailed Description

Simple class for holding the basic attributes of an 32-bit block header.

• Author

  Robert Frazier

Definition at line 16 of file GctBlockHeader.h.

Constructor & Destructor Documentation

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-derived classes.

Parameters

valid

Flag if this is a known and valid header .

Definition at line 3 of file GctBlockHeader.cc.

                                          :
  m_blockId(blockId),
  m_blockLength(blockLength),
  m_nSamples(nSamples),
  m_bxId(bxId),
  m_eventId(eventId),
  m_valid(valid)
{
}

GctBlockHeader::~GctBlockHeader ( )

inline

Destructor.

Definition at line 32 of file GctBlockHeader.h.

{};

Member Function Documentation

uint32_t GctBlockHeader::blockId ( ) const

inline

Get the block ID.

Definition at line 35 of file GctBlockHeader.h.

References m_blockId.

Referenced by GctFormatTranslateV35::blockToFibres(), GctFormatTranslateV38::blockToFibres(), GctFormatTranslateMCLegacy::blockToFibres(), GctFormatTranslateV35::blockToGctEmCandsAndEnergySums(), GctFormatTranslateV38::blockToGctEmCandsAndEnergySums(), GctFormatTranslateMCLegacy::blockToGctEmCandsAndEnergySums(), GctFormatTranslateV35::blockToGctInternEmCand(), GctFormatTranslateV38::blockToGctInternEmCand(), GctFormatTranslateV35::blockToGctInternEtSums(), GctFormatTranslateV38::blockToGctInternEtSums(), GctFormatTranslateV35::blockToGctInternEtSumsAndJetCluster(), GctFormatTranslateV38::blockToGctInternEtSumsAndJetCluster(), GctFormatTranslateV38::blockToGctInternHtMissPostWheel(), GctFormatTranslateV38::blockToGctInternHtMissPreWheel(), GctFormatTranslateV35::blockToGctInternRingSums(), GctFormatTranslateV38::blockToGctInternRingSums(), GctFormatTranslateV35::blockToGctJetCandsAndCounts(), GctFormatTranslateV38::blockToGctJetCandsAndCounts(), GctFormatTranslateMCLegacy::blockToGctJetCandsAndCounts(), GctFormatTranslateV35::blockToGctJetClusterMinimal(), GctFormatTranslateV38::blockToGctJetClusterMinimal(), GctFormatTranslateV35::blockToGctJetPreCluster(), GctFormatTranslateV38::blockToGctJetPreCluster(), GctFormatTranslateV35::blockToGctTrigObjects(), GctFormatTranslateV38::blockToGctTrigObjects(), GctFormatTranslateV35::blockToGctWheelInputInternEtAndRingSums(), GctFormatTranslateV38::blockToGctWheelInputInternEtAndRingSums(), GctFormatTranslateV35::blockToGctWheelOutputInternEtAndRingSums(), GctFormatTranslateV38::blockToGctWheelOutputInternEtAndRingSums(), GctFormatTranslateV35::blockToRctCaloRegions(), GctFormatTranslateV38::blockToRctCaloRegions(), GctFormatTranslateV35::blockToRctEmCand(), GctFormatTranslateV38::blockToRctEmCand(), GctFormatTranslateMCLegacy::blockToRctEmCand(), GctFormatTranslateV35::convertBlock(), GctFormatTranslateMCLegacy::convertBlock(), GctFormatTranslateV38::convertBlock(), GctFormatTranslateBase::getBlockDescription(), and operator<<().

{ return m_blockId; }

uint32_t GctBlockHeader::blockLength ( ) const

inline

Get the fundamental block length (for 1 time sample)

Definition at line 38 of file GctBlockHeader.h.

References m_blockLength.

Referenced by GctFormatTranslateV35::blockToFibres(), GctFormatTranslateV38::blockToFibres(), GctFormatTranslateMCLegacy::blockToFibres(), GctFormatTranslateV35::blockToGctInternEmCand(), GctFormatTranslateV38::blockToGctInternEmCand(), GctFormatTranslateV35::blockToGctInternEtSums(), GctFormatTranslateV38::blockToGctInternEtSums(), GctFormatTranslateV35::blockToGctInternEtSumsAndJetCluster(), GctFormatTranslateV38::blockToGctInternEtSumsAndJetCluster(), GctFormatTranslateV38::blockToGctInternHtMissPostWheel(), GctFormatTranslateV38::blockToGctInternHtMissPreWheel(), GctFormatTranslateV35::blockToGctInternRingSums(), GctFormatTranslateV38::blockToGctInternRingSums(), GctFormatTranslateV35::blockToGctJetClusterMinimal(), GctFormatTranslateV38::blockToGctJetClusterMinimal(), GctFormatTranslateV35::blockToGctJetPreCluster(), GctFormatTranslateV38::blockToGctJetPreCluster(), GctFormatTranslateV35::blockToGctTrigObjects(), GctFormatTranslateV38::blockToGctTrigObjects(), GctFormatTranslateV35::blockToGctWheelInputInternEtAndRingSums(), GctFormatTranslateV38::blockToGctWheelInputInternEtAndRingSums(), GctFormatTranslateV35::blockToGctWheelOutputInternEtAndRingSums(), GctFormatTranslateV38::blockToGctWheelOutputInternEtAndRingSums(), GctFormatTranslateV35::blockToRctCaloRegions(), GctFormatTranslateV38::blockToRctCaloRegions(), GctFormatTranslateV35::blockToRctEmCand(), GctFormatTranslateV38::blockToRctEmCand(), GctFormatTranslateMCLegacy::blockToRctEmCand(), operator<<(), and GctRawToDigi::unpack().

{ return m_blockLength; }

uint32_t GctBlockHeader::bxId ( ) const

inline

Get the bunch crossing ID.

Definition at line 44 of file GctBlockHeader.h.

References m_bxId.

Referenced by operator<<().

{ return m_bxId; }

uint32_t GctBlockHeader::eventId ( ) const

inline

Get the event ID.

Definition at line 47 of file GctBlockHeader.h.

References m_eventId.

Referenced by operator<<().

{ return m_eventId; }

uint32_t GctBlockHeader::nSamples ( ) const

inline

Get the number of time samples.

Definition at line 41 of file GctBlockHeader.h.

References m_nSamples.

Referenced by GctFormatTranslateMCLegacy::blockToAllRctCaloRegions(), GctFormatTranslateV35::blockToFibres(), GctFormatTranslateV38::blockToFibres(), GctFormatTranslateMCLegacy::blockToFibres(), GctFormatTranslateV35::blockToGctEmCandsAndEnergySums(), GctFormatTranslateV38::blockToGctEmCandsAndEnergySums(), GctFormatTranslateMCLegacy::blockToGctEmCandsAndEnergySums(), GctFormatTranslateV35::blockToGctInternEmCand(), GctFormatTranslateV38::blockToGctInternEmCand(), GctFormatTranslateV35::blockToGctInternEtSums(), GctFormatTranslateV38::blockToGctInternEtSums(), GctFormatTranslateV35::blockToGctInternEtSumsAndJetCluster(), GctFormatTranslateV38::blockToGctInternEtSumsAndJetCluster(), GctFormatTranslateV38::blockToGctInternHtMissPostWheel(), GctFormatTranslateV38::blockToGctInternHtMissPreWheel(), GctFormatTranslateV35::blockToGctInternRingSums(), GctFormatTranslateV38::blockToGctInternRingSums(), GctFormatTranslateV35::blockToGctJetCandsAndCounts(), GctFormatTranslateV38::blockToGctJetCandsAndCounts(), GctFormatTranslateMCLegacy::blockToGctJetCandsAndCounts(), GctFormatTranslateV35::blockToGctJetClusterMinimal(), GctFormatTranslateV38::blockToGctJetClusterMinimal(), GctFormatTranslateV35::blockToGctJetPreCluster(), GctFormatTranslateV38::blockToGctJetPreCluster(), GctFormatTranslateV35::blockToGctTrigObjects(), GctFormatTranslateV38::blockToGctTrigObjects(), GctFormatTranslateV35::blockToGctWheelInputInternEtAndRingSums(), GctFormatTranslateV38::blockToGctWheelInputInternEtAndRingSums(), GctFormatTranslateV35::blockToGctWheelOutputInternEtAndRingSums(), GctFormatTranslateV38::blockToGctWheelOutputInternEtAndRingSums(), GctFormatTranslateV35::blockToRctCaloRegions(), GctFormatTranslateV38::blockToRctCaloRegions(), GctFormatTranslateV35::blockToRctEmCand(), GctFormatTranslateV38::blockToRctEmCand(), GctFormatTranslateMCLegacy::blockToRctEmCand(), GctFormatTranslateBase::checkBlock(), GctFormatTranslateV35::convertBlock(), GctFormatTranslateV38::convertBlock(), GctFormatTranslateMCLegacy::convertBlock(), operator<<(), and GctRawToDigi::unpack().

{ return m_nSamples; }

bool GctBlockHeader::valid ( ) const

inline

Returns true if it's valid block header - i.e. if the header is known and can be unpacked.

Definition at line 50 of file GctBlockHeader.h.

References m_valid.

Referenced by GctFormatTranslateBase::checkBlock(), and GctFormatTranslateBase::getBlockDescription().

{ return m_valid; }

Member Data Documentation

uint32_t GctBlockHeader::m_blockId

private

The Block ID.

Definition at line 61 of file GctBlockHeader.h.

Referenced by blockId().

uint32_t GctBlockHeader::m_blockLength

private

The fundamental block length (for 1 time sample)

Definition at line 63 of file GctBlockHeader.h.

Referenced by blockLength().

uint32_t GctBlockHeader::m_bxId

private

The bunch-crossing ID.

Definition at line 67 of file GctBlockHeader.h.

Referenced by bxId().

uint32_t GctBlockHeader::m_eventId

private

The event ID.

Definition at line 69 of file GctBlockHeader.h.

Referenced by eventId().

uint32_t GctBlockHeader::m_nSamples

private

The number of time-samples.

Definition at line 65 of file GctBlockHeader.h.

Referenced by nSamples().

bool GctBlockHeader::m_valid

private

Is this a valid block header.

Definition at line 71 of file GctBlockHeader.h.

Referenced by valid().