RXReadOutStructure Class Reference

#include <RXReadOutStructure.h>

Inheritance diagram for RXReadOutStructure:

Collaboration diagram for RXReadOutStructure:

Public Types
enum	DataVersion { Atlas, Simulation0, Simulation1 }

Public Member Functions
	RXReadOutStructure (DataVersion vers=Atlas)
	RXReadOutStructure (ubit16 inputData, DataVersion vers=Atlas)
	~RXReadOutStructure ()=default
void	setInit ()
ubit16	makeHeader (ubit16 *inputData)
ubit16	makeSubHeader ()
ubit16	makeBody (ubit16 *inputData)
ubit16	makeFooter (ubit16 errorCode)
ubit16	makeFooter (ubit16 *errorCode)
ubit16	RXid ()
ubit16	status ()
ubit16	errorCode ()
ubit16	decodeFragment (ubit16 inputWord, char &field)
bool	isHeader ()
bool	isBody ()
bool	isFooter ()
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 Attributes
ubit16	m_secid
ubit16	m_status
ubit16	m_errorCode
DataVersion	m_dataVersion

Static Private Attributes
static const ubit16	s_headerNum = 3
static const ubit16	s_headerPos [s_headerNum] = {12, 8, 0}
static const ubit16	s_headerLen [s_headerNum] = {4, 4, 8}
static const ubit16	s_headerVal = 0x0009
static const ubit16	s_footerNum = 2
static const ubit16	s_footerPos [s_footerNum] = {12, 0}
static const ubit16	s_footerLen [s_footerNum] = {4, 12}
static const ubit16	s_footerVal = 0x000b

Detailed Description

Definition at line 14 of file RXReadOutStructure.h.

Member Enumeration Documentation

DataVersion

enum RXReadOutStructure::DataVersion

Enumerator
Atlas
Simulation0
Simulation1

Definition at line 16 of file RXReadOutStructure.h.

{ Atlas, Simulation0, Simulation1 };

Constructor & Destructor Documentation

RXReadOutStructure() [1/2]

RXReadOutStructure::RXReadOutStructure

(

RXReadOutStructure::DataVersion

vers = Atlas

)

Definition at line 24 of file RXReadOutStructure.cxx.

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

RXReadOutStructure() [2/2]

RXReadOutStructure::RXReadOutStructure	(	ubit16	inputData,
		RXReadOutStructure::DataVersion	vers = Atlas
	)

Definition at line 31 of file RXReadOutStructure.cxx.

                                                                                           : m_dataVersion(vers) {
    //
    // Constructor used by the simulation program
    //
 
    decodeFragment(inputData, m_field);
}  // end-of-RXReadOutStructure::RXReadOutStructure()

~RXReadOutStructure()

RXReadOutStructure::~RXReadOutStructure ( )

default

Member Function Documentation

decodeFragment()

unsigned short int RXReadOutStructure::decodeFragment	(	ubit16	inputWord,
		char &	field
	)

Definition at line 78 of file RXReadOutStructure.cxx.

                                                                                   {
    MatrixReadOutStructure MRS;
    //  Removed last because it is not used
    //  bool last=false;
    ubit16 errorCode = 0;
    setInit();
    m_word = inputWord;
    //
    errorCode = 0;
    if (isHeader()) {
        m_field = 'H';
        if (m_dataVersion == Atlas || m_dataVersion == Simulation1) {
            m_secid = get16Bits(inputWord, s_headerPos[1], s_headerLen[1]) >> 3;
            m_status = get16Bits(inputWord, s_headerPos[2], s_headerLen[2]);
        } else if (m_dataVersion == Simulation0) {
            m_status = get16Bits(inputWord, s_headerPos[1], s_headerLen[1]);
            m_secid = get16Bits(inputWord, s_headerPos[2], s_headerLen[2]);
        } else {
            // Unknown format, so leave data invalid.
            m_field = 'U';
        }
    } else if (isFooter()) {
        m_field = 'F';
        m_errorCode = get16Bits(inputWord, s_footerPos[1], s_footerLen[1]);
    } else {
        m_field = 'B';
        if ((m_word & 0xf000) == (MRS.getFooterVal() << MRS.getFooterPos())) {
            /* last=true; */
        } else {
            /* last=false; */
        }  // end-of-if((m_word
    }
    field = m_field;
    return errorCode;  // temporary: force return to 0
}  // end-of-decodeFragment

errorCode()

ubit16 RXReadOutStructure::errorCode ( )

inline

Definition at line 35 of file RXReadOutStructure.h.

{ return m_errorCode; };

field()

char RPCReadOut::field ( ) const

inlineinherited

Definition at line 19 of file RPCReadOut.h.

{ 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

getWord()

ubit16 RPCReadOut::getWord ( ) const

inlineinherited

Definition at line 18 of file RPCReadOut.h.

{ return m_word; };

isBody()

bool RXReadOutStructure::isBody ( )

inline

Definition at line 39 of file RXReadOutStructure.h.

{ return false; };

isFooter()

bool RXReadOutStructure::isFooter

(

)

Definition at line 71 of file RXReadOutStructure.cxx.

                                  {
    bool status = false;
    ubit16 theFooter[s_footerNum] = {s_footerVal};
    if ((m_word & s_last4bitsON) == set16Bits(1, s_footerPos, theFooter)) status = true;
    return status;
}

isHeader()

bool RXReadOutStructure::isHeader

(

)

Definition at line 64 of file RXReadOutStructure.cxx.

                                  {
    bool status = false;
    ubit16 theHeader[s_headerNum] = {s_headerVal};
    if ((m_word & s_last4bitsON) == set16Bits(1, s_headerPos, theHeader)) status = true;
    return status;
}

makeBody()

ubit16 RXReadOutStructure::makeBody ( ubit16 *  inputData )

inline

Definition at line 26 of file RXReadOutStructure.h.

{ return *inputData; };

makeFooter() [1/2]

unsigned short int RXReadOutStructure::makeFooter

(

ubit16 *

errorCode

)

Definition at line 62 of file RXReadOutStructure.cxx.

{ return (*errorCode) & 0x0; }  // end-of-RXReadOutStructure::makeFooter

makeFooter() [2/2]

unsigned short int RXReadOutStructure::makeFooter

(

ubit16

errorCode

)

Definition at line 55 of file RXReadOutStructure.cxx.

                                                                  {
    m_errorCode = errorCode;
    const ubit16 theFooter[s_footerNum] = {s_footerVal, m_errorCode};
    m_word = set16Bits(s_footerNum, s_footerPos, theFooter);
    return m_word;
}  // end-of-RXReadOutStructure::makeFooter

makeHeader()

unsigned short int RXReadOutStructure::makeHeader

(

ubit16 *

inputData

)

Definition at line 47 of file RXReadOutStructure.cxx.

                                                                   {
    const ubit16 theHeader[s_headerNum] = {s_headerVal, *(inputData + 1), *(inputData + 2)};
    m_secid = *(inputData + 1);
    m_status = *(inputData + 2);
    m_word = set16Bits(s_headerNum, s_headerPos, theHeader);
    return m_word;
}  // end-of-RXReadOutStructure::makeHeader

makeSubHeader()

ubit16 RXReadOutStructure::makeSubHeader ( )

inline

Definition at line 24 of file RXReadOutStructure.h.

{ return 0; };

RXid()

ubit16 RXReadOutStructure::RXid ( )

inline

Definition at line 33 of file RXReadOutStructure.h.

{ return m_secid; };

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 RXReadOutStructure::setInit

(

)

Definition at line 39 of file RXReadOutStructure.cxx.

                                 {
    m_field = 'U';
    m_word = 0xffff;
    m_secid = 0xffff;
    m_status = 0xffff;
    m_errorCode = 0xffff;
}  // end-of-RXReadOutStructure::setInit()

status()

ubit16 RXReadOutStructure::status ( )

inline

Definition at line 34 of file RXReadOutStructure.h.

{ return m_status; };

Member Data Documentation

m_dataVersion

DataVersion RXReadOutStructure::m_dataVersion

private

Definition at line 47 of file RXReadOutStructure.h.

m_errorCode

ubit16 RXReadOutStructure::m_errorCode

private

Definition at line 46 of file RXReadOutStructure.h.

m_field

char RPCReadOut::m_field {0}

protectedinherited

Definition at line 28 of file RPCReadOut.h.

m_secid

ubit16 RXReadOutStructure::m_secid

private

Definition at line 44 of file RXReadOutStructure.h.

m_status

ubit16 RXReadOutStructure::m_status

private

Definition at line 45 of file RXReadOutStructure.h.

m_word

ubit16 RPCReadOut::m_word {0xffff}

protectedinherited

Definition at line 27 of file RPCReadOut.h.

s_first8bitsON

constexpr ubit16 RPCReadOut::s_first8bitsON {0}

staticconstexprprotectedinherited

Definition at line 57 of file RPCReadOut.h.

s_footerLen

const ubit16 RXReadOutStructure::s_footerLen = {4, 12}

staticprivate

Definition at line 57 of file RXReadOutStructure.h.

s_footerNum

const ubit16 RXReadOutStructure::s_footerNum = 2

staticprivate

Definition at line 55 of file RXReadOutStructure.h.

s_footerPos

const ubit16 RXReadOutStructure::s_footerPos = {12, 0}

staticprivate

Definition at line 56 of file RXReadOutStructure.h.

s_footerVal

const ubit16 RXReadOutStructure::s_footerVal = 0x000b

staticprivate

Definition at line 58 of file RXReadOutStructure.h.

s_headerLen

const ubit16 RXReadOutStructure::s_headerLen = {4, 4, 8}

staticprivate

Definition at line 53 of file RXReadOutStructure.h.

s_headerNum

const ubit16 RXReadOutStructure::s_headerNum = 3

staticprivate

Definition at line 51 of file RXReadOutStructure.h.

s_headerPos

const ubit16 RXReadOutStructure::s_headerPos = {12, 8, 0}

staticprivate

Definition at line 52 of file RXReadOutStructure.h.

s_headerVal

const ubit16 RXReadOutStructure::s_headerVal = 0x0009

staticprivate

Definition at line 54 of file RXReadOutStructure.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.

---

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

• RXReadOutStructure.h
• RXReadOutStructure.cxx