TrigMonAlg Class Reference

Summary of single agorithm execution. Algorithm is identified by position within parent sequence. Class stores stop and start time as encoded words from TrigMonTimer class, so timers are constructed on fly and returned by value. Class can also store (uint16_t, float) pairs of variables. More...

#include <TrigMonAlg.h>

Collaboration diagram for TrigMonAlg:

Public Member Functions
	TrigMonAlg ()
	TrigMonAlg (unsigned int position, bool is_cached)
	~TrigMonAlg ()
void	addTimer (const TrigMonTimer &tbeg, const TrigMonTimer &tend)
void	addRoiId (unsigned int roiId)
void	addWord (unsigned int word)
uint8_t	getPosition () const
uint8_t	getNRoi () const
uint8_t	getRoiId (unsigned int i=0) const
const std::set< uint8_t >	getRoiIdSet () const
bool	isCached () const
bool	isCalled () const
const std::vector< uint8_t > &	getByte () const
const std::vector< uint32_t > &	getWord () const
const TrigMonTimer	start () const
const TrigMonTimer	stop () const
double	getTimer () const
double	elapsed () const

Private Attributes
std::vector< uint8_t >	m_byte
std::vector< uint32_t >	m_word

Friends
class	TrigMonAlgCnv_p1

Detailed Description

Summary of single agorithm execution. Algorithm is identified by position within parent sequence. Class stores stop and start time as encoded words from TrigMonTimer class, so timers are constructed on fly and returned by value. Class can also store (uint16_t, float) pairs of variables.

Author

Rustem Ospanov

Date

July 2009

Definition at line 29 of file TrigMonAlg.h.

Constructor & Destructor Documentation

TrigMonAlg() [1/2]

TrigMonAlg::TrigMonAlg

(

)

Definition at line 21 of file TrigMonAlg.cxx.

  :m_byte(1, 0)
{
}

TrigMonAlg() [2/2]

TrigMonAlg::TrigMonAlg	(	unsigned int	position,
		bool	is_cached
	)

Definition at line 27 of file TrigMonAlg.cxx.

  :m_byte(1, 0)
{
  if(position < 128) {
    m_byte[0] = position;
  }
  else {
    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "TrigMonAlg")
      << "ctor error! Position is out of allowed range.";
  }
 
  if(is_cached) {
    //
    // Set top bit for caching state
    //
    m_byte[0] |= AlgBits::maskCache;
  }
}

~TrigMonAlg()

TrigMonAlg::~TrigMonAlg ( )

inline

Definition at line 35 of file TrigMonAlg.h.

{}

Member Function Documentation

addRoiId()

void TrigMonAlg::addRoiId

(

unsigned int

roiId

)

Definition at line 68 of file TrigMonAlg.cxx.

{
  //
  // Add roid id, check that id is less than 256
  // 
  if(roi_id < 256) {
    m_byte.push_back(static_cast<uint8_t>(roi_id)); 
  }
  else if (roi_id == 256) {
    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "TrigMonAlg")
      << "addRoiId error! RoiId value is out of range! (only reported for ID=256)";
  }
}

addTimer()

void TrigMonAlg::addTimer	(	const TrigMonTimer &	tbeg,
		const TrigMonTimer &	tend
	)

Definition at line 47 of file TrigMonAlg.cxx.

{
  //
  // Save start and stop time for one algorithm call
  //
  if(isCached()) {
    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "TrigMonAlg")
      << "addTimers error! Cached algorithm has no timers.";
    return;
  }
  else if(!m_word.empty()) {
    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "TrigMonAlg")
      << "addTimers error! Timers already added!";
    return;
  }
 
  m_word.push_back(tbeg.getEncoded());
  m_word.push_back(tend.getEncoded());
}

addWord()

void TrigMonAlg::addWord

(

unsigned int

word

)

Definition at line 83 of file TrigMonAlg.cxx.

{
  //
  // Save start and stop time for one algorithm call
  //
  if(m_word.size() != 2 && !isCached()) {
    REPORT_MESSAGE_WITH_CONTEXT(MSG::ERROR, "TrigMonAlg")
      << "addWord error! Timers must be added first.";
    return;
  }
 
  m_word.push_back(word);
}

elapsed()

double TrigMonAlg::elapsed ( ) const

inline

Definition at line 57 of file TrigMonAlg.h.

{ return stop().getElapsed(start()); }

getByte()

const std::vector<uint8_t>& TrigMonAlg::getByte ( ) const

inline

Definition at line 50 of file TrigMonAlg.h.

{ return m_byte; }

getNRoi()

uint8_t TrigMonAlg::getNRoi

(

)

const

Definition at line 107 of file TrigMonAlg.cxx.

{
  //
  // Get number of RoIs
  //
  return m_byte.size()-1;
}

getPosition()

uint8_t TrigMonAlg::getPosition

(

)

const

Definition at line 98 of file TrigMonAlg.cxx.

{
  //
  // Return algorithm position with top bit set to zero
  //
  return (m_byte[0] & AlgBits::maskPos);
}

getRoiId()

uint8_t TrigMonAlg::getRoiId

(

unsigned int

i = 0

)

const

Definition at line 116 of file TrigMonAlg.cxx.

{
  //
  // Return roi id
  //
  if(i+1 < m_byte.size()) return m_byte[i+1];
 
  return Trig::getRoiId_Unknown();
}

getRoiIdSet()

const std::set< uint8_t > TrigMonAlg::getRoiIdSet

(

)

const

Definition at line 127 of file TrigMonAlg.cxx.

{
  //
  // Return set of all roi ids
  //
  return std::set<uint8_t>(m_byte.begin()+1, m_byte.end());
}

getTimer()

double TrigMonAlg::getTimer ( ) const

inline

Definition at line 56 of file TrigMonAlg.h.

{ return stop().getElapsed(start()); }

getWord()

const std::vector<uint32_t>& TrigMonAlg::getWord ( ) const

inline

Definition at line 51 of file TrigMonAlg.h.

{ return m_word; }

isCached()

bool TrigMonAlg::isCached

(

)

const

Definition at line 136 of file TrigMonAlg.cxx.

{
  //
  // check top bit for caching state
  //
  return (m_byte[0] & AlgBits::maskCache);
}

isCalled()

bool TrigMonAlg::isCalled

(

)

const

Definition at line 145 of file TrigMonAlg.cxx.

{
  //
  // check top bit for caching state
  //
  return !isCached();
}

start()

const TrigMonTimer TrigMonAlg::start

(

)

const

Definition at line 154 of file TrigMonAlg.cxx.

{
  //
  // This function only make sense when timers exists, so first check isCalled()=false
  //
  if(!isCached() && m_word.size() >= 2) {
    return TrigMonTimer(m_word[0]);
  }
  
  return TrigMonTimer(0);
}

stop()

const TrigMonTimer TrigMonAlg::stop

(

)

const

Definition at line 167 of file TrigMonAlg.cxx.

{
  //
  // This function only make sense when timers exists, so first check isCalled()=true
  //
  if(!isCached() && m_word.size() >= 2) {
    return TrigMonTimer(m_word[1]);
  }
  
  return TrigMonTimer(0);
}

Friends And Related Function Documentation

TrigMonAlgCnv_p1

friend class TrigMonAlgCnv_p1

friend

Definition at line 60 of file TrigMonAlg.h.

Member Data Documentation

m_byte

std::vector<uint8_t> TrigMonAlg::m_byte

private

Definition at line 62 of file TrigMonAlg.h.

m_word

std::vector<uint32_t> TrigMonAlg::m_word

private

Definition at line 63 of file TrigMonAlg.h.

---

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

• TrigMonAlg.h
• TrigMonAlg.cxx