TrigMonROBData Class Reference

#include <TrigMonROBData.h>

Collaboration diagram for TrigMonROBData:

Public Types
enum	History {   kUNCLASSIFIED = 0, kRETRIEVED = 1, kCACHED = 2, kIGNORED = 4,   kDISABLED = 8 }
enum	Status { kUNKNOWN = 0x0, kPREFETCH = 0x40, kOK = 0x80 }

Public Member Functions
	TrigMonROBData ()
	TrigMonROBData (uint32_t rob_id, uint32_t rob_size)
	~TrigMonROBData ()
void	setHistory (History hist)
void	setStatusOK ()
void	setStatusPREFETCH ()
bool	isUnclassified () const
bool	isCached () const
bool	isRetrieved () const
bool	isIgnored () const
bool	isDisabled () const
bool	isStatusOk () const
bool	isStatusPrefetched () const
uint32_t	getROBId () const
uint32_t	getROBSize () const
uint32_t	getEncodedState () const
History	getHistory () const
Status	getStatus () const
void	print (std::ostream &os=std::cout) const

Private Attributes
uint32_t	m_rob_id
uint32_t	m_word

Friends
class	TrigMonROBDataCnv_p1
class	TrigMonROBDataCnv_p2

Detailed Description

Definition at line 26 of file TrigMonROBData.h.

Member Enumeration Documentation

History

enum TrigMonROBData::History

Enumerator
kUNCLASSIFIED
kRETRIEVED
kCACHED
kIGNORED
kDISABLED

Definition at line 30 of file TrigMonROBData.h.

               { 
    kUNCLASSIFIED = 0, // ROB was requested but never arrived at processor. History unknown. 
    kRETRIEVED    = 1, // ROB was retrieved from ROS by DataCollector
    kCACHED       = 2, // ROB was found already in the internal cache of the ROBDataProviderSvc
    kIGNORED      = 4, // ROB was on the "ignore" list and therefore not retrieved 
    kDISABLED     = 8  // ROB was disabled in OKS and therefore not retrieved
  };

Status

enum TrigMonROBData::Status

Enumerator
kUNKNOWN
kPREFETCH
kOK

Definition at line 37 of file TrigMonROBData.h.

              {
    kUNKNOWN  = 0x0,    // ROB status was unknown (default)
    kPREFETCH = 0x40,   // ROB was prefetched
    kOK       = 0x80    // ROB is StatusOk
  };

Constructor & Destructor Documentation

TrigMonROBData() [1/2]

TrigMonROBData::TrigMonROBData

(

)

Definition at line 23 of file TrigMonROBData.cxx.

  :m_rob_id(0),
   m_word(0)
{
}

TrigMonROBData() [2/2]

TrigMonROBData::TrigMonROBData	(	uint32_t	rob_id,
		uint32_t	rob_size
	)

Definition at line 30 of file TrigMonROBData.cxx.

  :m_rob_id(rob_id),
   m_word(0)
{
  if(rob_size >= 16777215) {
    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "TrigMonROBData")
      << "Size out of range";
  }
  else {
    m_word |= (rob_size << ROBbits::shiftSize);
  }
}

~TrigMonROBData()

TrigMonROBData::~TrigMonROBData ( )

inline

Definition at line 45 of file TrigMonROBData.h.

{}

Member Function Documentation

getEncodedState()

uint32_t TrigMonROBData::getEncodedState

(

)

const

Definition at line 99 of file TrigMonROBData.cxx.

{
  //
  // Return encoded Status and History integer
  //
  return (m_word & ROBbits::maskState);
}

getHistory()

TrigMonROBData::History TrigMonROBData::getHistory

(

)

const

Definition at line 108 of file TrigMonROBData.cxx.

{
  //
  // Mask history bits and get history
  //
  return Trig::getROBHistory(m_word);
}

getROBId()

uint32_t TrigMonROBData::getROBId ( ) const

inline

Definition at line 59 of file TrigMonROBData.h.

{ return m_rob_id; }

getROBSize()

uint32_t TrigMonROBData::getROBSize

(

)

const

Definition at line 90 of file TrigMonROBData.cxx.

{
  //
  // Get data size
  //
  return ((m_word & ROBbits::maskSize) >> ROBbits::shiftSize);
}

getStatus()

TrigMonROBData::Status TrigMonROBData::getStatus

(

)

const

Definition at line 117 of file TrigMonROBData.cxx.

{
  //
  // Mask status bits and get status
  //
  return Trig::getROBStatus(m_word);
}

isCached()

bool TrigMonROBData::isCached ( ) const

inline

Definition at line 52 of file TrigMonROBData.h.

{ return getHistory() == kCACHED; }

isDisabled()

bool TrigMonROBData::isDisabled ( ) const

inline

Definition at line 55 of file TrigMonROBData.h.

{ return getHistory() == kDISABLED; }

isIgnored()

bool TrigMonROBData::isIgnored ( ) const

inline

Definition at line 54 of file TrigMonROBData.h.

{ return getHistory() == kIGNORED; }

isRetrieved()

bool TrigMonROBData::isRetrieved ( ) const

inline

Definition at line 53 of file TrigMonROBData.h.

{ return getHistory() == kRETRIEVED; }

isStatusOk()

bool TrigMonROBData::isStatusOk

(

)

const

Definition at line 72 of file TrigMonROBData.cxx.

{
  //
  // Return status bit
  //
  return (m_word & kOK);
}

isStatusPrefetched()

bool TrigMonROBData::isStatusPrefetched

(

)

const

Definition at line 81 of file TrigMonROBData.cxx.

{
  //
  // Return status bit
  //
  return (m_word & kPREFETCH);
}

isUnclassified()

bool TrigMonROBData::isUnclassified ( ) const

inline

Definition at line 51 of file TrigMonROBData.h.

{ return getHistory() == kUNCLASSIFIED; }

print()

void TrigMonROBData::print

(

std::ostream &

os = std::cout

)

const

Definition at line 126 of file TrigMonROBData.cxx.

{
  os << str(*this) << "\n";
}

setHistory()

void TrigMonROBData::setHistory

(

History

hist

)

Definition at line 44 of file TrigMonROBData.cxx.

{
  //
  // Set history enum.
  //
  m_word  = m_word & (~ROBbits::maskHistory);
  m_word |= hist;
}

setStatusOK()

void TrigMonROBData::setStatusOK

(

)

Definition at line 54 of file TrigMonROBData.cxx.

{
  //
  // Set status bit
  //
  m_word |= kOK;
}

setStatusPREFETCH()

void TrigMonROBData::setStatusPREFETCH

(

)

Definition at line 63 of file TrigMonROBData.cxx.

{
  //
  // Set status bit
  //
  m_word |= kPREFETCH;
}

Friends And Related Function Documentation

TrigMonROBDataCnv_p1

friend class TrigMonROBDataCnv_p1

friend

Definition at line 68 of file TrigMonROBData.h.

TrigMonROBDataCnv_p2

friend class TrigMonROBDataCnv_p2

friend

Definition at line 69 of file TrigMonROBData.h.

Member Data Documentation

m_rob_id

uint32_t TrigMonROBData::m_rob_id

private

Definition at line 71 of file TrigMonROBData.h.

m_word

uint32_t TrigMonROBData::m_word

private

Definition at line 72 of file TrigMonROBData.h.

---

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

• TrigMonROBData.h
• TrigMonROBData.cxx