Class holding the RoIs from the MuCTPI collected by the RoIB. More...

#include <MuCTPIResult.h>

Collaboration diagram for ROIB::MuCTPIResult:

Public Member Functions
	MuCTPIResult (Header &&head, Trailer &&trail, std::vector< MuCTPIRoI > &&roIVector)
	Constructor with header, trailer and RoI vector. More...

	MuCTPIResult ()
	Default constructor. More...

	~MuCTPIResult ()=default
	Destructor. More...

	MuCTPIResult (MuCTPIResult &&) noexcept=default

MuCTPIResult &	operator= (MuCTPIResult &&) noexcept=default

const Header &	header () const
	Member function returning the header. More...

const Trailer &	trailer () const
	Member function returning the trailer. More...

const std::vector< MuCTPIRoI > &	roIVec () const
	Member function returning the RoI vector. More...

const std::string	dump () const
	dump raw object content to string More...

const std::string	print (const bool longFormat=false) const
	print object content in a human readable format to string More...

void	dumpData () const
	Function dumping the stored information to the message stream. More...

void	dumpData (MsgStream &) const
	Function dumping the stored information to the message stream. More...

Private Attributes
Header	m_MuCTPIResultHeader
	Variable storing the header for the MuCTPI block. More...

Trailer	m_MuCTPIResultTrailer
	Variable storing the trailer for the MuCTPI block. More...

std::vector< MuCTPIRoI >	m_MuCTPIResultRoIVec
	Variable storing the MuCTPI RoIs collected by the RoIB. More...

Detailed Description

Class holding the RoIs from the MuCTPI collected by the RoIB.

Date: 2008-02-01 17:04:19

   The RoIBuilder receives input from the LVL1 calorimeter trigger,
   the CTP and the MuCTPI. In its output the RoIs coming from the
   MuCTPI are stored in one of these objects.

See also: ROIB::RoIBuilder; ROIB::RoIBResult; ROIB::Header; ROIB::Trailer; ROIB::MuCTPIRoI

Author: Thomas Schoerner-Sadenius thoma.nosp@m.s.sc.nosp@m.hoern.nosp@m.er@c.nosp@m.ern.c.nosp@m.h; Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h; David Berge David.nosp@m..Ber.nosp@m.ge@ce.nosp@m.rn.c.nosp@m.h

Version

Revision: 1.7

Definition at line 44 of file MuCTPIResult.h.

Constructor & Destructor Documentation

◆ MuCTPIResult() [1/3]

ROIB::MuCTPIResult::MuCTPIResult	(	Header &&	head,
		Trailer &&	trail,
		std::vector< MuCTPIRoI > &&	roIVector
	)

Constructor with header, trailer and RoI vector.

This constructor is used by the RoIB simulation to create the object from the class.

Parameters

head	Reference to the header to be used by the object
trail	Reference to the trailer to be used by the object
roIVector	Vector of muon RoIs collected from the MuCTPI

Definition at line 31 of file MuCTPIResult.cxx.

     : m_MuCTPIResultHeader( std::move(head) ), m_MuCTPIResultTrailer( std::move(trail) ),
       m_MuCTPIResultRoIVec( std::move(roIVector) ) {
  
   }

◆ MuCTPIResult() [2/3]

ROIB::MuCTPIResult::MuCTPIResult ( )

Default constructor.

Empty constructor needed by POOL to be able to stream the objects.

Definition at line 40 of file MuCTPIResult.cxx.

     : m_MuCTPIResultHeader(), m_MuCTPIResultTrailer(),
       m_MuCTPIResultRoIVec() {
  
   }

◆ ~MuCTPIResult()

ROIB::MuCTPIResult::~MuCTPIResult ( )

default

Destructor.

◆ MuCTPIResult() [3/3]

ROIB::MuCTPIResult::MuCTPIResult ( MuCTPIResult && )

defaultnoexcept

Member Function Documentation

◆ dump()

const std::string ROIB::MuCTPIResult::dump ( ) const

dump raw object content to string

method used for read/write testing and T/P separation

Definition at line 73 of file MuCTPIResult.cxx.

   {
     std::ostringstream s;
  
     s << " [" << this->header().dump() << "] ";
     s << " [";
       for (std::vector<MuCTPIRoI>::size_type i(0); i < roIVec().size(); ++i) {
     s << LVL1CTP::convertToHex(roIVec()[i].roIWord());
       }
     s << "] ";
     s << " [" << this->trailer().dump() << "] ";
     
     return s.str();
   }

◆ dumpData() [1/2]

void ROIB::MuCTPIResult::dumpData ( ) const

Function dumping the stored information to the message stream.

This function is not responsible for actually printing the information, it just creates a message stream to print the information to with MuCTPIResult::dumpData(MsgStream&) const.

Definition at line 140 of file MuCTPIResult.cxx.

                                     {
  
     SmartIF<IMessageSvc> msgSvc{Gaudi::svcLocator()->service("MessageSvc")};
     if ( !msgSvc ) {
       return;
     }
     MsgStream log( msgSvc, "MuCTPIResult" );
     dumpData( log );
  
     return;
   }

◆ dumpData() [2/2]

void ROIB::MuCTPIResult::dumpData ( MsgStream & log ) const

Function dumping the stored information to the message stream.

Function printing the information stored in the object in an easy-to-read fashion.

It calls Header::dumpData(MsgStream&) const and Trailer::dumpData(MsgStream&) const to print their information as well.

Parameters

log	A message stream to print the information to

Definition at line 159 of file MuCTPIResult.cxx.

                                                     {
  
     log << MSG::DEBUG << "*BEGIN* MuCTPIResult" << endmsg;
  
     m_MuCTPIResultHeader.dumpData( log );
     int counter = 0;
     std::vector< MuCTPIRoI >::const_iterator it = m_MuCTPIResultRoIVec.begin();
     for( ; it != m_MuCTPIResultRoIVec.end(); ++it, ++counter ) {
  
       std::string loc = "UNDEFINED";
       if( it->getSectorLocation() == MuCTPI_RDO::ENDCAP )
     loc = "ENDCAP";
       else if( it->getSectorLocation() == MuCTPI_RDO::FORWARD )
     loc = "FORWARD";
       else if( it->getSectorLocation() == MuCTPI_RDO::BARREL )
     loc = "BARREL";
  
       log << MSG::DEBUG << "RoI word[" << counter << "]        : 0x"
       << MSG::hex << it->roIWord() << MSG::dec << endmsg;
       log << MSG::DEBUG << "Threshold               :  pt" << it->pt() << endmsg;
       log << MSG::DEBUG << "Sector location         :  " << loc << endmsg;
       log << MSG::DEBUG << "Sector ID               :  " << it->getSectorID() << endmsg;
       log << MSG::DEBUG << "Sector addr             :  0x" << MSG::hex
       << it->getSectorID() << MSG::dec << endmsg;
       log << MSG::DEBUG << "Sector overflow         :  " << it->getSectorOverflow() << endmsg;
       log << MSG::DEBUG << "RoI overflow            :  " << it->getRoiOverflow() << endmsg;
       log << MSG::DEBUG << "RoI number              :  " << it->getRoiNumber() << endmsg;
       //log << MSG::DEBUG << "IsHighestPt             :  " << it->getCandidateIsHighestPt() << endmsg;
       log << MSG::DEBUG << "Overlap                 :  " << it->getOverlapBits() << endmsg;
  
     }
     m_MuCTPIResultTrailer.dumpData( log );
     log << MSG::DEBUG << "*END* MuCTPIResult" << endmsg;
  
     return;
   }

◆ header()

const Header & ROIB::MuCTPIResult::header ( ) const

Member function returning the header.

Simply returning a constant reference to the variable.

Returns: Constant reference to the header

Definition at line 51 of file MuCTPIResult.cxx.

                                            {
     return m_MuCTPIResultHeader;
   }

◆ operator=()

MuCTPIResult& ROIB::MuCTPIResult::operator= ( MuCTPIResult && )

defaultnoexcept

◆ print()

const std::string ROIB::MuCTPIResult::print ( const bool longFormat = false ) const

print object content in a human readable format to string

Definition at line 88 of file MuCTPIResult.cxx.

   {
     std::ostringstream s;
  
     s << "header [" << this->header().print(longFormat) << "] ";
     if (longFormat) s << std::endl;
  
     for(std::vector< MuCTPIRoI >::size_type i(0); i < roIVec().size(); ++i ) {
  
       std::string loc = "UNDEFINED";
       if( roIVec()[i].getSectorLocation() == MuCTPI_RDO::ENDCAP )
     loc = "ENDCAP";
       else if( roIVec()[i].getSectorLocation() == MuCTPI_RDO::FORWARD )
     loc = "FORWARD";
       else if( roIVec()[i].getSectorLocation() == MuCTPI_RDO::BARREL )
     loc = "BARREL";
  
       if (i == 0 || longFormat) s << "data";
       if (longFormat) s << "[" << std::setw(2) << i << "]";
  
       s << " [";
       if (longFormat) s << LVL1CTP::convertToHex(roIVec()[i].roIWord());
       if (longFormat) s << std::setw(12) << "\n Threshold: ";
       s << " " << roIVec()[i].pt();
       if (longFormat) s << std::setw(12) << "\n Sector location: ";
       s << " " << loc;
       if (longFormat) s << std::setw(12) << "\n Sector ID:";
       s << " " << roIVec()[i].getSectorID();
       if (longFormat) s << std::setw(12) << "\n Sector addr:";
       s << " " << LVL1CTP::convertToHex(roIVec()[i].getSectorID());
       if (longFormat) s << std::setw(12) << "\n Sector overflow:";
       s << " " << roIVec()[i].getSectorOverflow();
       if (longFormat) s << std::setw(12) << "\n RoI overflow:";
       s << " " << roIVec()[i].getRoiOverflow();
       if (longFormat) s << std::setw(12) << "\n RoI number:";
       s << " " << roIVec()[i].getRoiNumber();
       //if (longFormat) s << std::setw(12) << "\n IsHighestPt:";
       //s << " " << roIVec()[i].getCandidateIsHighestPt();
       if (longFormat) s << std::setw(12) << "\n Overlap:";
       s << " " << roIVec()[i].getOverlapBits();
       s << "] ";
     }
     s << "trailer [" << this->trailer().print(longFormat) << "] ";
  
     return s.str();
   }

◆ roIVec()

const vector< MuCTPIRoI > & ROIB::MuCTPIResult::roIVec ( ) const

Member function returning the RoI vector.

Simply returning a constant reference to the variable.

Returns: Constant reference to the RoI vector

Definition at line 69 of file MuCTPIResult.cxx.

                                                         {
     return m_MuCTPIResultRoIVec;
   }

◆ trailer()

const Trailer & ROIB::MuCTPIResult::trailer ( ) const

Member function returning the trailer.

Simply returning a constant reference to the variable.

Returns: Constant reference to the trailer

Definition at line 60 of file MuCTPIResult.cxx.

                                              {
     return m_MuCTPIResultTrailer;
   }

Member Data Documentation

◆ m_MuCTPIResultHeader

Header ROIB::MuCTPIResult::m_MuCTPIResultHeader

private

Variable storing the header for the MuCTPI block.

Definition at line 77 of file MuCTPIResult.h.

◆ m_MuCTPIResultRoIVec

std::vector< MuCTPIRoI > ROIB::MuCTPIResult::m_MuCTPIResultRoIVec

private

Variable storing the MuCTPI RoIs collected by the RoIB.

Definition at line 81 of file MuCTPIResult.h.

◆ m_MuCTPIResultTrailer

Trailer ROIB::MuCTPIResult::m_MuCTPIResultTrailer

private

Variable storing the trailer for the MuCTPI block.

Definition at line 79 of file MuCTPIResult.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MuCTPIResult() [1/3]

◆ MuCTPIResult() [2/3]

◆ ~MuCTPIResult()

◆ MuCTPIResult() [3/3]

Member Function Documentation

◆ dump()

◆ dumpData() [1/2]

◆ dumpData() [2/2]

◆ header()

◆ operator=()

◆ print()

◆ roIVec()

◆ trailer()

Member Data Documentation

◆ m_MuCTPIResultHeader

◆ m_MuCTPIResultRoIVec

◆ m_MuCTPIResultTrailer