Class which stores infomration on the SCT chips: id, config, mask. More...

#include <SCT_Chip.h>

Collaboration diagram for SCT_Chip:

Public Member Functions
	SCT_Chip ()
	Default constructor.
	SCT_Chip (short id, short config, uint32_t mask0, uint32_t mask1, uint32_t mask2, uint32_t mask3)
	Actual constructor: create chip from id, config and four 32-bit masks.
	~SCT_Chip ()=default
	Default destructor.
short	id () const
	Chip Id.
short	inPort () const
	Active input port.
short	outPort () const
	Active output port.
bool	isEnd () const
	Is chip an end.
bool	isMaster () const
	Is chip a master.
bool	canBeMaster () const
	Can chip be a master (i.e position 0 or 6)
bool	slaveConfiguredAsMaster () const
	Is this a slave chip mistakenly configured as a master.
bool	initializeMaskFromInts (uint32_t mask0, uint32_t mask1, uint32_t mask2, uint32_t mask3)
	Initialize channel mask from four ins (as in DB)
bool	initializeMaskFromString (const std::string &maskString)
	Initialize channel mask from a string.
bool	channelIsMasked (const unsigned int channelNumber) const
	Gives status of channel at channelNumber.
unsigned int	numberOfMaskedChannels () const
	Number of masked channels.
void	appendBadStripsToVector (std::vector< int > &maskedChannelVector) const
	Append masked channels' numbers to a user-supplied vector.

Private Types
enum	{ nSubwords = 4 , lenSubword = 32 , nBitsMask = 128 , nBitsConfig = 16 }
	Enum for lengths of words. More...
enum	{ RO_BIT = 0 , CAL_BIT = 2 , TR_BIT = 4 , EDGE_BIT = 6 , MASK_BIT = 7 , ACC_BIT = 8 , IN_BIT = 9 , OUT_BIT = 10 , MASTER_BIT = 11 , END_BIT = 12 , FEED_BIT = 13 }
	Enum describing the bits in the chip configuration. More...

Private Attributes
short	m_id
	Chip Id.
std::bitset< nBitsConfig >	m_config
	Chip configuration mask.
short	m_in
	Active input port.
short	m_out
	Active output port.
bool	m_end
	Is chip an end.
bool	m_master
	Is chip a master.
std::bitset< nBitsMask >	m_mask
	Chip strip mask.

Friends
std::ostream &	operator<< (std::ostream &output, const SCT_Chip &chip)
	Outputstream operator for chip.

Detailed Description

Class which stores infomration on the SCT chips: id, config, mask.

Definition at line 27 of file SCT_Chip.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enum describing the bits in the chip configuration.

Enumerator
RO_BIT
CAL_BIT
TR_BIT
EDGE_BIT
MASK_BIT
ACC_BIT
IN_BIT
OUT_BIT
MASTER_BIT
END_BIT
FEED_BIT

Definition at line 74 of file SCT_Chip.h.

       {RO_BIT   = 0, CAL_BIT = 2, TR_BIT  = 4,  EDGE_BIT   = 6,  MASK_BIT = 7,
        ACC_BIT  = 8, IN_BIT  = 9, OUT_BIT = 10, MASTER_BIT = 11, END_BIT  = 12,
        FEED_BIT = 13};

◆ anonymous enum

anonymous enum

private

Enum for lengths of words.

Enumerator
nSubwords
lenSubword
nBitsMask
nBitsConfig

Definition at line 71 of file SCT_Chip.h.

71{nSubwords = 4, lenSubword = 32, nBitsMask = 128, nBitsConfig = 16};

SCT_Chip::nBitsConfig

@ nBitsConfig

Definition SCT_Chip.h:71

SCT_Chip::lenSubword

@ lenSubword

Definition SCT_Chip.h:71

SCT_Chip::nSubwords

@ nSubwords

Definition SCT_Chip.h:71

SCT_Chip::nBitsMask

@ nBitsMask

Definition SCT_Chip.h:71

Constructor & Destructor Documentation

◆ SCT_Chip() [1/2]

SCT_Chip::SCT_Chip ( )

Default constructor.

Definition at line 10 of file SCT_Chip.cxx.

                  :
  m_id(0),
  m_config(0),m_in(0),m_out(0),m_end(false),m_master(false) {
  m_mask.set();
}

◆ SCT_Chip() [2/2]

SCT_Chip::SCT_Chip	(	short	id,
		short	config,
		uint32_t	mask0,
		uint32_t	mask1,
		uint32_t	mask2,
		uint32_t	mask3 )

Actual constructor: create chip from id, config and four 32-bit masks.

Definition at line 17 of file SCT_Chip.cxx.

                                                                                                        :
  m_id(id),
  m_config(config) {
  m_in     = m_config.test(IN_BIT) ? 1 : 0;
  m_out    = m_config.test(OUT_BIT) ? 1 : 0;
  m_end    = m_config.test(END_BIT);
  m_master = !m_config.test(MASTER_BIT);        // Master bit is 0 if master
  initializeMaskFromInts(mask0, mask1, mask2, mask3);
}

◆ ~SCT_Chip()

SCT_Chip::~SCT_Chip ( )

default

Default destructor.

Member Function Documentation

◆ appendBadStripsToVector()

void SCT_Chip::appendBadStripsToVector ( std::vector< int > & maskedChannelVector ) const

Append masked channels' numbers to a user-supplied vector.

Definition at line 80 of file SCT_Chip.cxx.

                                                                                {  
  for (unsigned int thisChann(0);thisChann != nBitsMask; ++thisChann){
    if (channelIsMasked(thisChann)) maskedChannelVector.push_back(thisChann);
  }
}

◆ canBeMaster()

bool SCT_Chip::canBeMaster ( ) const

inline

Can chip be a master (i.e position 0 or 6)

Definition at line 52 of file SCT_Chip.h.

52{return (m_id == 0 || m_id == 6);}

◆ channelIsMasked()

bool SCT_Chip::channelIsMasked ( const unsigned int channelNumber ) const

Gives status of channel at channelNumber.

Definition at line 70 of file SCT_Chip.cxx.

                                                                    {
  return !(m_mask.test(channelNumber));
}

◆ id()

short SCT_Chip::id ( ) const

inline

Chip Id.

Definition at line 42 of file SCT_Chip.h.

42{return m_id;}

◆ initializeMaskFromInts()

bool SCT_Chip::initializeMaskFromInts	(	uint32_t	mask0,
		uint32_t	mask1,
		uint32_t	mask2,
		uint32_t	mask3 )

Initialize channel mask from four ins (as in DB)

Definition at line 28 of file SCT_Chip.cxx.

                                                                                                   {
  bool successfulInitialization(true);
  uint32_t subWords[nSubwords]={mask0,mask1,mask2,mask3};
  // Put the integers into 32 bit bitsets
  std::bitset<lenSubword> subBinary;
  for (unsigned int i{0}; i!=nSubwords; ++i) {
    subBinary = subWords[i];
    // Put the four bitsets together in one 128 bit bitset (private member data)
    for (unsigned int j{0}; j!=lenSubword; ++j) {
      m_mask[i*lenSubword+j]=subBinary[j];
    }
  }
  return successfulInitialization;
}

◆ initializeMaskFromString()

bool SCT_Chip::initializeMaskFromString ( const std::string & maskString )

Initialize channel mask from a string.

Definition at line 45 of file SCT_Chip.cxx.

                                                                  {
  bool successfulInitialization(true);
  std::istringstream formatStream(maskString);
  uint32_t  subWords[nSubwords];
 
  // Parse into four 32-bit integers (there must be a better way!)
  // As a very basic check, we enable exceptions on the hex conversion.
  formatStream.exceptions(std::ios_base::badbit|std::ios_base::failbit);
 
  try{
    formatStream >> std::hex >> subWords[nSubwords-1] 
                 >> std::hex >> subWords[nSubwords-2] 
                 >> std::hex >> subWords[nSubwords-3] 
                 >> std::hex >> subWords[nSubwords-4];
  } catch(const std::ios_base::failure&) {
    std::cerr << "The SCT_ChipMask code has failed to convert the received string to a mask; the received string is: ";
    std::cerr << maskString << std::endl;
    successfulInitialization = false;
  }
 
  initializeMaskFromInts(subWords[0], subWords[1], subWords[2], subWords[3]);
  return successfulInitialization;
}

◆ inPort()

short SCT_Chip::inPort ( ) const

inline

Active input port.

Definition at line 44 of file SCT_Chip.h.

44{return m_in;}

◆ isEnd()

bool SCT_Chip::isEnd ( ) const

inline

Is chip an end.

Definition at line 48 of file SCT_Chip.h.

48{return m_end;}

◆ isMaster()

bool SCT_Chip::isMaster ( ) const

inline

Is chip a master.

Definition at line 50 of file SCT_Chip.h.

50{return m_master;}

◆ numberOfMaskedChannels()

unsigned int SCT_Chip::numberOfMaskedChannels ( ) const

Number of masked channels.

Definition at line 75 of file SCT_Chip.cxx.

                                                    {
  return nBitsMask - m_mask.count();
}

◆ outPort()

short SCT_Chip::outPort ( ) const

inline

Active output port.

Definition at line 46 of file SCT_Chip.h.

46{return m_out;}

◆ slaveConfiguredAsMaster()

bool SCT_Chip::slaveConfiguredAsMaster ( ) const

inline

Is this a slave chip mistakenly configured as a master.

Definition at line 55 of file SCT_Chip.h.

55{return (!canBeMaster() && isMaster());}

SCT_Chip::isMaster

bool isMaster() const

Is chip a master.

Definition SCT_Chip.h:50

SCT_Chip::canBeMaster

bool canBeMaster() const

Can chip be a master (i.e position 0 or 6)

Definition SCT_Chip.h:52

◆ operator<<

std::ostream & operator<<	(	std::ostream &	output,
		const SCT_Chip &	chip )

friend

Outputstream operator for chip.

Definition at line 88 of file SCT_Chip.h.

                                                                        {
  output << "Chip " << std::setw(2) << chip.m_id << ":\t" 
         << (chip.m_master ? "MASTER" : "SLAVE") << (chip.m_end ? " END" : "") 
         << ", IN PORT = " << chip.m_in << ", OUT PORT = " << chip.m_out << "\n"
         << "Config = " << chip.m_config << "\n"
         << "Mask   = " << chip.m_mask;
  return output;
}

Member Data Documentation

◆ m_config

std::bitset<nBitsConfig> SCT_Chip::m_config

private

Chip configuration mask.

Definition at line 79 of file SCT_Chip.h.

◆ m_end

bool SCT_Chip::m_end

private

Is chip an end.

Definition at line 82 of file SCT_Chip.h.

◆ m_id

short SCT_Chip::m_id

private

Chip Id.

Definition at line 78 of file SCT_Chip.h.

◆ m_in

short SCT_Chip::m_in

private

Active input port.

Definition at line 80 of file SCT_Chip.h.

◆ m_mask

std::bitset<nBitsMask> SCT_Chip::m_mask

private

Chip strip mask.

Definition at line 84 of file SCT_Chip.h.

◆ m_master

bool SCT_Chip::m_master

private

Is chip a master.

Definition at line 83 of file SCT_Chip.h.

◆ m_out

short SCT_Chip::m_out

private

Active output port.

Definition at line 81 of file SCT_Chip.h.

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

Public Member Functions

Private Types

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ SCT_Chip() [1/2]

◆ SCT_Chip() [2/2]

◆ ~SCT_Chip()

Member Function Documentation

◆ appendBadStripsToVector()

◆ canBeMaster()

◆ channelIsMasked()

◆ id()

◆ initializeMaskFromInts()

◆ initializeMaskFromString()

◆ inPort()

◆ isEnd()

◆ isMaster()

◆ numberOfMaskedChannels()

◆ outPort()

◆ slaveConfiguredAsMaster()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ m_config

◆ m_end

◆ m_id

◆ m_in

◆ m_mask

◆ m_master

◆ m_out