Header models the LVL1 ROD Header. More...

#include <Header.h>

Collaboration diagram for ROIB::Header:

Public Member Functions
	Header ()
	default constructor: empty object More...

	Header (std::vector< uint32_t > &&v)
	constructor which fully specifies the initialiser values More...

	Header (Header &&) noexcept=default

	Header (const Header &)=default

Header &	operator= (Header &&) noexcept=default

Header &	operator= (const Header &)=default

	Header (const uint32_t, const uint32_t, const uint32_t)
	constructor specifying subdet ID, event ID and version More...

	Header (const uint32_t, const uint32_t)
	constructor specifying subdet ID, event ID More...

	Header (const uint32_t)
	constructor specifying subdet ID only More...

	~Header ()=default
	empty default desctructor More...

const std::vector< uint32_t > &	header () const
	get full header More...

int	size () const
	get header(data) size More...

uint32_t	headerMarker () const
	get header marker word More...

uint32_t	headerSize () const
	get number of words in header More...

uint32_t	formatVersion () const
	get version of header format More...

uint32_t	sourceID () const
	get sub detector source ID More...

uint32_t	runNumber () const
	get run number More...

uint32_t	L1ID () const
	get extended LVL1 ID More...

uint32_t	BCID () const
	get bunch crossing ID More...

uint32_t	triggerType () const
	get LVL1 trigger type More...

uint32_t	eventType () const
	get LVL1 event type More...

void	setRunNumber (const uint32_t)
	set run number More...

void	setL1ID (const uint32_t)
	set extended LVL1 ID More...

void	setBCID (const uint32_t i)
	set bunch crossing ID More...

void	setTriggerType (const uint32_t i)
	set LVL1 trigger type More...

void	setEventType (const uint32_t i)
	set LVL1 event type 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
	print object content to default message stream More...

void	dumpData (MsgStream &) const
	print object content to given message stream More...

Static Public Attributes
static constexpr unsigned int	wordsPerHeader = 8
	a ROD header as used in the LVL1 has 8 words, not counting the one hardware word in the beginning More...

Private Attributes
std::vector< uint32_t >	m_header
	vector of unsigned ints - the only data member More...

Detailed Description

Header models the LVL1 ROD Header.

   Header is a class equivalent to the ROD header 
   from the eformat lib, just much simpler and adapted 
   to the LVL1 needs.

See also: ROIB::Header

Author: Thomas Schoerner-Sadenius thoma.nosp@m.s.sc.nosp@m.hoern.nosp@m.er@c.nosp@m.ern.c.nosp@m.h

Version: $Id: Header.h,v 1.11 2008-12-18 13:35:00 dquarrie Exp $

Definition at line 37 of file TrigT1Result/TrigT1Result/Header.h.

Constructor & Destructor Documentation

◆ Header() [1/7]

ROIB::Header::Header ( )

inline

default constructor: empty object

Definition at line 46 of file TrigT1Result/TrigT1Result/Header.h.

47 : m_header() {}

◆ Header() [2/7]

ROIB::Header::Header ( std::vector< uint32_t > && v )

inline

constructor which fully specifies the initialiser values

Definition at line 50 of file TrigT1Result/TrigT1Result/Header.h.

51 : m_header( std::move(v) ) {}

◆ Header() [3/7]

ROIB::Header::Header ( Header && )

defaultnoexcept

◆ Header() [4/7]

ROIB::Header::Header ( const Header & )

default

◆ Header() [5/7]

ROIB::Header::Header	(	const uint32_t	i1,
		const uint32_t	i2,
		const uint32_t	i3
	)

constructor specifying subdet ID, event ID and version

Definition at line 26 of file TrigT1Result/src/Header.cxx.

                                                                           {
  
     m_header.push_back( eformat::ROD );   // start of header marker      
     m_header.push_back( 8 );              // header size xxx needs update to adjusted
     m_header.push_back( i3 );         // format version number       
     m_header.push_back( i1 );         // source identifier            
     m_header.push_back( i2 );             // extended level 1 ID    
     m_header.push_back( 0 );              // bunch crossing ID 
     m_header.push_back( 0 );          // level 1 trigger type   
     m_header.push_back( 0 );          // detector event type       
  
     // m_header.push_back( 0 );       // run number xxx needs to be added for eformat v3
   }

◆ Header() [6/7]

ROIB::Header::Header	(	const uint32_t	i1,
		const uint32_t	i2
	)

constructor specifying subdet ID, event ID

Definition at line 40 of file TrigT1Result/src/Header.cxx.

                                                        {
  
     m_header.push_back( eformat::ROD );              // start of header marker       
     m_header.push_back( 8 );                 // header size xxx needs update 
     m_header.push_back( eformat::DEFAULT_VERSION );  // format version number        
     m_header.push_back( i1 );                // source identifier            
     m_header.push_back( i2 );                        // extended level 1 ID 
     m_header.push_back( 0 );                         // bunch crossing ID
     m_header.push_back( 0 );                         // level 1 trigger type    
     m_header.push_back( 0 );                     // detector event type       
  
     // m_header.push_back( 0 );       // run number xxx needs to be added for eformat v3
   }

◆ Header() [7/7]

ROIB::Header::Header ( const uint32_t i )

constructor specifying subdet ID only

Constructor specifying subdet ID only.

Definition at line 55 of file TrigT1Result/src/Header.cxx.

                                    {
  
     m_header.push_back( eformat::ROD );              // start of header marker
     m_header.push_back( 8 );                         // header size xxx needs update
     m_header.push_back( eformat::DEFAULT_VERSION );  // format version number
     m_header.push_back( i );                         // source identifier            
     m_header.push_back( 0 );                         // extended level 1 ID
     m_header.push_back( 0 );                         // bunch crossing ID
     m_header.push_back( 0 );                         // level 1 trigger type
     m_header.push_back( 0 );                         // detector event type       
  
     // m_header.push_back( 0 );       // run number xxx needs to be added for eformat v3
   }

◆ ~Header()

ROIB::Header::~Header ( )

default

empty default desctructor

Member Function Documentation

◆ BCID()

uint32_t ROIB::Header::BCID ( ) const

get bunch crossing ID

◆ dump()

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

dump raw object content to string

Definition at line 69 of file TrigT1Result/src/Header.cxx.

   {
     std::ostringstream s;
  
     for (std::vector< uint32_t >::size_type i(0); i < m_header.size(); ++i) {
       s << LVL1CTP::convertToHex(m_header[i]);
     }
     
     return s.str();
   }

◆ dumpData() [1/2]

void ROIB::Header::dumpData ( ) const

print object content to default message stream

Definition at line 103 of file TrigT1Result/src/Header.cxx.

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

◆ dumpData() [2/2]

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

print object content to given message stream

Definition at line 113 of file TrigT1Result/src/Header.cxx.

   {
     log << MSG::DEBUG << "*BEGIN* ROIB::Header" << endmsg;
     log << MSG::DEBUG << "Header marker           :  " << MSG::hex << headerMarker() << MSG::dec << endmsg;
     log << MSG::DEBUG << "Header size             :  " << headerSize() << endmsg;
     log << MSG::DEBUG << "Source ID               :  0x" << MSG::hex << sourceID() << MSG::dec << endmsg;
     log << MSG::DEBUG << "Ext. LVL1 ID            :  " << L1ID() << endmsg;
     log << MSG::DEBUG << "BCID                    :  " << BCID() << endmsg;
     log << MSG::DEBUG << "Trigger type            :  " << triggerType() << endmsg;
     log << MSG::DEBUG << "Det. event type         :  " << eventType() << endmsg;
     log << MSG::DEBUG << "*END* ROIB::Header" << endmsg;
   }

◆ eventType()

uint32_t ROIB::Header::eventType ( ) const

get LVL1 event type

◆ formatVersion()

uint32_t ROIB::Header::formatVersion ( ) const

get version of header format

◆ header()

const std::vector<uint32_t>& ROIB::Header::header ( ) const

get full header

◆ headerMarker()

uint32_t ROIB::Header::headerMarker ( ) const

get header marker word

◆ headerSize()

uint32_t ROIB::Header::headerSize ( ) const

get number of words in header

◆ L1ID()

uint32_t ROIB::Header::L1ID ( ) const

get extended LVL1 ID

◆ operator=() [1/2]

Header& ROIB::Header::operator= ( const Header & )

default

◆ operator=() [2/2]

Header& ROIB::Header::operator= ( Header && )

defaultnoexcept

◆ print()

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

print object content in a human readable format to string

Definition at line 80 of file TrigT1Result/src/Header.cxx.

   {
     std::ostringstream s;
  
     if (longFormat) {
       s << "Size: " << size() << std::endl;
       s << std::setw(2) << 0 << "Marker:" << headerMarker() << std::endl;
       s << std::setw(2) << 1 << "Size:" << headerSize() << std::endl;
       s << std::setw(2) << 2 << "Version:" << formatVersion() << std::endl;
       s << std::setw(2) << 3 << "SourceID:" << sourceID() << std::endl;
       s << std::setw(2) << 4 << "L1ID:" << L1ID() << std::endl;
       s << std::setw(2) << 5 << "BCID:" << BCID() << std::endl;
       s << std::setw(2) << 6 << "TriggerType:" << triggerType() << std::endl;
       s << std::setw(2) << 7 << "EventType:" << eventType() << std::endl;
     } else {
       for (size_t i(0); i < m_header.size(); ++i) {
     s << LVL1CTP::convertToHex(m_header[i]);
       }
     }
     
     return s.str();
   }

◆ runNumber()

uint32_t ROIB::Header::runNumber ( ) const

get run number

◆ setBCID()

void ROIB::Header::setBCID ( const uint32_t i )

set bunch crossing ID

◆ setEventType()

void ROIB::Header::setEventType ( const uint32_t i )

set LVL1 event type

◆ setL1ID()

void ROIB::Header::setL1ID ( const uint32_t )

set extended LVL1 ID

◆ setRunNumber()

void ROIB::Header::setRunNumber ( const uint32_t )

set run number

◆ setTriggerType()

void ROIB::Header::setTriggerType ( const uint32_t i )

set LVL1 trigger type

◆ size()

int ROIB::Header::size ( ) const

get header(data) size

◆ sourceID()

uint32_t ROIB::Header::sourceID ( ) const

get sub detector source ID

◆ triggerType()

uint32_t ROIB::Header::triggerType ( ) const

get LVL1 trigger type

Member Data Documentation

◆ m_header

std::vector< uint32_t > ROIB::Header::m_header

private

vector of unsigned ints - the only data member

Definition at line 120 of file TrigT1Result/TrigT1Result/Header.h.

◆ wordsPerHeader

constexpr unsigned int ROIB::Header::wordsPerHeader = 8

staticconstexpr

a ROD header as used in the LVL1 has 8 words, not counting the one hardware word in the beginning

number of words in header (Ref: ATL-DA-ES-0029)

Definition at line 43 of file TrigT1Result/TrigT1Result/Header.h.

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

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Header() [1/7]

◆ Header() [2/7]

◆ Header() [3/7]

◆ Header() [4/7]

◆ Header() [5/7]

◆ Header() [6/7]

◆ Header() [7/7]

◆ ~Header()

Member Function Documentation

◆ BCID()

◆ dump()

◆ dumpData() [1/2]

◆ dumpData() [2/2]

◆ eventType()

◆ formatVersion()

◆ header()

◆ headerMarker()

◆ headerSize()

◆ L1ID()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ print()

◆ runNumber()

◆ setBCID()

◆ setEventType()

◆ setL1ID()

◆ setRunNumber()

◆ setTriggerType()

◆ size()

◆ sourceID()

◆ triggerType()

Member Data Documentation

◆ m_header

◆ wordsPerHeader