#include <RPCRODStructure.h>

Inheritance diagram for RPCRODStructure:

Collaboration diagram for RPCRODStructure:

Public Member Functions
	RPCRODStructure ()

	RPCRODStructure (ubit16 inputData)

	~RPCRODStructure ()

void	decodeSourceID (RODword sourceID)

ubit16	getSourceIDReserved ()

ubit16	getSourceIDModuleType ()

ubit16	getSourceIDSubdetectorID ()

ubit16	getSourceIDRODID ()

ubit16	makeHeader (ubit16 *inputData)

ubit16	makeSubHeader ()

ubit16	makeBody (ubit16 *inputData)

ubit16	makeFooter (ubit16 errorCode)

ubit16	makeFooter (ubit16 *errorCode)

bool	isHeader ()

bool	isBody ()

bool	isFooter ()

RODword	getHeaderMarker ()

RODword	getHeaderSize ()

RODword	getFooterSize ()

RODword	getFormatVersion ()

RODword	getSourceID (ubit16 subsystem, ubit16 RODID)

ubit16	getEmptyDataWord ()

ubit16	getWord () const

char	field () const

Protected Member Functions
ubit16	set16Bits (const ubit16 n, const ubit16 pos, const ubit16 val) const

template<size_t n>
ubit16	set16Bits (const std::array< ubit16, n > &pos, const std::array< ubit16, n > &val) const

ubit16	get16Bits (const ubit16 input, const ubit16 position, const ubit16 length) const

Protected Attributes
ubit16	m_word {0xffff}

char	m_field {0}

Static Protected Attributes
static constexpr ubit16	s_last2bitsON {0xc000}

static constexpr ubit16	s_last4bitsON {0xf000}

static constexpr ubit16	s_first8bitsON {0}

Private Member Functions
void	setInit ()

ubit16	getSubDetectorID (ubit16 subsystem)

Private Attributes
ubit16	m_sourceIDreserved

ubit16	m_moduleType

ubit16	m_subDetectorID

ubit16	m_RODID

Static Private Attributes
static const RODword	s_headerMarker = 0xee1234ee

static const RODword	s_headerSize = 8

static const RODword	s_formatVersion = 0x00000000

static const ubit16	s_sourceIDreserved = 0x00

static const ubit16	s_moduleType = 0x00

static const ubit16	s_subDetectorIDA = 0x65

static const ubit16	s_subDetectorIDC = 0x66

static const ubit16	s_emptyDataWord = 0xf000

static const RODword	s_footerSize = 3

Detailed Description

Definition at line 16 of file RPCRODStructure.h.

Constructor & Destructor Documentation

◆ RPCRODStructure() [1/2]

RPCRODStructure::RPCRODStructure ( )

Definition at line 16 of file RPCRODStructure.cxx.

                                  {
     //
     // Constructor used by the simulation program
     //
     setInit();
 }  // end-of-RPCRODStructure::RPCRODStructure()

◆ RPCRODStructure() [2/2]

RPCRODStructure::RPCRODStructure ( ubit16 inputData )

Definition at line 23 of file RPCRODStructure.cxx.

                                          {
     //
     // Constructor used by the simulation program
     //
     // decodeFragment;
     m_sourceIDreserved = 0xffff;
     m_moduleType = 0xffff;
     m_subDetectorID = 0xffff;
     m_RODID = 0xffff;
 }  // end-of-RPCRODStructure::RPCRODStructure()

◆ ~RPCRODStructure()

RPCRODStructure::~RPCRODStructure ( )

Definition at line 34 of file RPCRODStructure.cxx.

34 {} // end-of-RPCRODStructure::~RPCRODStructure

Member Function Documentation

◆ decodeSourceID()

void RPCRODStructure::decodeSourceID ( RODword sourceID )

Definition at line 49 of file RPCRODStructure.cxx.

                                                      {
     m_sourceIDreserved = (sourceID & 0xff000000) >> 24;
     m_moduleType = (sourceID & 0x00ff0000) >> 16;
     m_subDetectorID = (sourceID & 0x0000ff00) >> 8;
     m_RODID = (sourceID & 0x000000ff);
 }  // end-of-decodeSourceID

◆ field()

char RPCReadOut::field ( ) const

inlineinherited

Definition at line 19 of file RPCReadOut.h.

19 { return m_field; };

◆ get16Bits()

ubit16 RPCReadOut::get16Bits	(	const ubit16	input,
		const ubit16	position,
		const ubit16	length
	)		const

inlineprotectedinherited

Definition at line 47 of file RPCReadOut.h.

                                                                                                   {
         ubit16 output = 0;
         ubit16 CMfield = 0;
         for (ubit16 i = 0; i < length; i++) { CMfield = CMfield | 1 << (position + i); }
         output = (input & CMfield) >> position;
         return output;
     }  // end-of-MatrixReadOutStructure::get16Bits

◆ getEmptyDataWord()

ubit16 RPCRODStructure::getEmptyDataWord ( )

inline

Definition at line 48 of file RPCRODStructure.h.

48 { return s_emptyDataWord; };

◆ getFooterSize()

RODword RPCRODStructure::getFooterSize ( )

inline

Definition at line 45 of file RPCRODStructure.h.

45 { return s_footerSize; };

◆ getFormatVersion()

RODword RPCRODStructure::getFormatVersion ( )

inline

Definition at line 46 of file RPCRODStructure.h.

46 { return s_formatVersion; };

◆ getHeaderMarker()

RODword RPCRODStructure::getHeaderMarker ( )

inline

Definition at line 43 of file RPCRODStructure.h.

43 { return s_headerMarker; };

◆ getHeaderSize()

RODword RPCRODStructure::getHeaderSize ( )

inline

Definition at line 44 of file RPCRODStructure.h.

44 { return s_headerSize; };

◆ getSourceID()

RODword RPCRODStructure::getSourceID	(	ubit16	subsystem,
		ubit16	RODID
	)

Definition at line 43 of file RPCRODStructure.cxx.

                                                                    {
     RODword sourceIdentifier = 0;
     sourceIdentifier = s_sourceIDreserved << 24 | s_moduleType << 16 | getSubDetectorID(subsystem) << 8 | RODID;
     return sourceIdentifier;
 }  // end-of-RPCRODStructure::getSourceID

◆ getSourceIDModuleType()

ubit16 RPCRODStructure::getSourceIDModuleType ( )

inline

Definition at line 23 of file RPCRODStructure.h.

23 { return m_moduleType; };

◆ getSourceIDReserved()

ubit16 RPCRODStructure::getSourceIDReserved ( )

inline

Definition at line 22 of file RPCRODStructure.h.

22 { return m_sourceIDreserved; };

◆ getSourceIDRODID()

ubit16 RPCRODStructure::getSourceIDRODID ( )

inline

Definition at line 25 of file RPCRODStructure.h.

25 { return m_RODID; };

◆ getSourceIDSubdetectorID()

ubit16 RPCRODStructure::getSourceIDSubdetectorID ( )

inline

Definition at line 24 of file RPCRODStructure.h.

24 { return m_subDetectorID; };

◆ getSubDetectorID()

ubit16 RPCRODStructure::getSubDetectorID ( ubit16 subsystem )

private

Definition at line 56 of file RPCRODStructure.cxx.

                                                          {
     ubit16 id = s_subDetectorIDA;
     if (subsystem) id = s_subDetectorIDC;
     return id;
 }  // end-of-getSubDetectorID

◆ getWord()

ubit16 RPCReadOut::getWord ( ) const

inlineinherited

Definition at line 18 of file RPCReadOut.h.

18 { return m_word; };

◆ isBody()

bool RPCRODStructure::isBody ( )

inline

Definition at line 40 of file RPCRODStructure.h.

40 { return false; };

◆ isFooter()

bool RPCRODStructure::isFooter ( )

inline

Definition at line 41 of file RPCRODStructure.h.

41 { return false; };

◆ isHeader()

bool RPCRODStructure::isHeader ( )

inline

Definition at line 39 of file RPCRODStructure.h.

39 { return false; };

◆ makeBody()

ubit16 RPCRODStructure::makeBody ( ubit16 * inputData )

inline

Definition at line 31 of file RPCRODStructure.h.

31 { return *inputData; };

◆ makeFooter() [1/2]

ubit16 RPCRODStructure::makeFooter ( ubit16 * errorCode )

inline

Definition at line 34 of file RPCRODStructure.h.

34 { return (*errorCode) & 0x0; };

◆ makeFooter() [2/2]

ubit16 RPCRODStructure::makeFooter ( ubit16 errorCode )

inline

Definition at line 33 of file RPCRODStructure.h.

33 { return errorCode; };

◆ makeHeader()

ubit16 RPCRODStructure::makeHeader ( ubit16 * inputData )

inline

Definition at line 28 of file RPCRODStructure.h.

28 { return *inputData; };

◆ makeSubHeader()

ubit16 RPCRODStructure::makeSubHeader ( )

inline

Definition at line 29 of file RPCRODStructure.h.

29 { return 0; };

◆ set16Bits() [1/2]

template<size_t n>

ubit16 RPCReadOut::set16Bits	(	const std::array< ubit16, n > &	pos,
		const std::array< ubit16, n > &	val
	)		const

inlineprotectedinherited

Definition at line 40 of file RPCReadOut.h.

                                                                                                                {
         ubit16 output = 0;
         for (size_t i = 0; i < n; ++i) { output |= (val[i] << pos[i]); }
         return output;
     }

◆ set16Bits() [2/2]

ubit16 RPCReadOut::set16Bits	(	const ubit16	n,
		const ubit16 *	pos,
		const ubit16 *	val
	)		const

inlineprotectedinherited

Definition at line 30 of file RPCReadOut.h.

                                                                                         {
         ubit16 output = 0;
         ubit16 p = 0, v = 0;
         for (ubit16 i = 0; i < n; i++) {
             v = *(val + i);
             p = *(pos + i);
             output = output | (v << p);
         }  // end-of-for
         return output;
     }  // end-of-MatrixReadOutStructure::set16Bits

◆ setInit()

void RPCRODStructure::setInit ( )

private

Definition at line 36 of file RPCRODStructure.cxx.

                               {
     m_sourceIDreserved = 0xffff;
     m_moduleType = 0xffff;
     m_subDetectorID = 0xffff;
     m_RODID = 0xffff;
 }  // end-of-setInit

Member Data Documentation

◆ m_field

char RPCReadOut::m_field {0}

protectedinherited

Definition at line 28 of file RPCReadOut.h.

◆ m_moduleType

ubit16 RPCRODStructure::m_moduleType

private

Definition at line 52 of file RPCRODStructure.h.

◆ m_RODID

ubit16 RPCRODStructure::m_RODID

private

Definition at line 54 of file RPCRODStructure.h.

◆ m_sourceIDreserved

ubit16 RPCRODStructure::m_sourceIDreserved

private

Definition at line 51 of file RPCRODStructure.h.

◆ m_subDetectorID

ubit16 RPCRODStructure::m_subDetectorID

private

Definition at line 53 of file RPCRODStructure.h.

◆ m_word

ubit16 RPCReadOut::m_word {0xffff}

protectedinherited

Definition at line 27 of file RPCReadOut.h.

◆ s_emptyDataWord

const ubit16 RPCRODStructure::s_emptyDataWord = 0xf000

staticprivate

Definition at line 67 of file RPCRODStructure.h.

◆ s_first8bitsON

constexpr ubit16 RPCReadOut::s_first8bitsON {0}

staticconstexprprotectedinherited

Definition at line 57 of file RPCReadOut.h.

◆ s_footerSize

const RODword RPCRODStructure::s_footerSize = 3

staticprivate

Definition at line 71 of file RPCRODStructure.h.

◆ s_formatVersion

const RODword RPCRODStructure::s_formatVersion = 0x00000000

staticprivate

Definition at line 60 of file RPCRODStructure.h.

◆ s_headerMarker

const RODword RPCRODStructure::s_headerMarker = 0xee1234ee

staticprivate

Definition at line 58 of file RPCRODStructure.h.

◆ s_headerSize

const RODword RPCRODStructure::s_headerSize = 8

staticprivate

Definition at line 59 of file RPCRODStructure.h.

◆ s_last2bitsON

constexpr ubit16 RPCReadOut::s_last2bitsON {0xc000}

staticconstexprprotectedinherited

Definition at line 55 of file RPCReadOut.h.

◆ s_last4bitsON

constexpr ubit16 RPCReadOut::s_last4bitsON {0xf000}

staticconstexprprotectedinherited

Definition at line 56 of file RPCReadOut.h.

◆ s_moduleType

const ubit16 RPCRODStructure::s_moduleType = 0x00

staticprivate

Definition at line 63 of file RPCRODStructure.h.

◆ s_sourceIDreserved

const ubit16 RPCRODStructure::s_sourceIDreserved = 0x00

staticprivate

Definition at line 62 of file RPCRODStructure.h.

◆ s_subDetectorIDA

const ubit16 RPCRODStructure::s_subDetectorIDA = 0x65

staticprivate

Definition at line 64 of file RPCRODStructure.h.

◆ s_subDetectorIDC

const ubit16 RPCRODStructure::s_subDetectorIDC = 0x66

staticprivate

Definition at line 65 of file RPCRODStructure.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RPCRODStructure() [1/2]

◆ RPCRODStructure() [2/2]

◆ ~RPCRODStructure()

Member Function Documentation

◆ decodeSourceID()

◆ field()

◆ get16Bits()

◆ getEmptyDataWord()

◆ getFooterSize()

◆ getFormatVersion()

◆ getHeaderMarker()

◆ getHeaderSize()

◆ getSourceID()

◆ getSourceIDModuleType()

◆ getSourceIDReserved()

◆ getSourceIDRODID()

◆ getSourceIDSubdetectorID()

◆ getSubDetectorID()

◆ getWord()

◆ isBody()

◆ isFooter()

◆ isHeader()

◆ makeBody()

◆ makeFooter() [1/2]

◆ makeFooter() [2/2]

◆ makeHeader()

◆ makeSubHeader()

◆ set16Bits() [1/2]

◆ set16Bits() [2/2]

◆ setInit()

Member Data Documentation

◆ m_field

◆ m_moduleType

◆ m_RODID

◆ m_sourceIDreserved

◆ m_subDetectorID

◆ m_word

◆ s_emptyDataWord

◆ s_first8bitsON

◆ s_footerSize

◆ s_formatVersion

◆ s_headerMarker

◆ s_headerSize

◆ s_last2bitsON

◆ s_last4bitsON

◆ s_moduleType

◆ s_sourceIDreserved

◆ s_subDetectorIDA

◆ s_subDetectorIDC