EventStreamInfo Class Reference

This class provides the summary information stored for data written as a Event Stream. More...

#include <EventStreamInfo.h>

Collaboration diagram for EventStreamInfo:

Public Member Functions
	EventStreamInfo ()
	Default Constructor. More...
virtual	~EventStreamInfo ()
	Destructor. More...
unsigned int	getNumberOfEvents () const
const std::set< unsigned int > &	getRunNumbers () const
const std::set< unsigned int > &	getLumiBlockNumbers () const
const std::set< std::string > &	getProcessingTags () const
const std::set< std::pair< CLID, std::string > > &	getItemList () const
const std::set< EventType > &	getEventTypes () const
void	addEvent (unsigned int number=1)
	Increase Event Counter. More...
void	setNumberOfEvents (unsigned int number)
	Set number of events. More...
void	insertRunNumber (unsigned int run)
	Insert new Run Number into a set. More...
void	insertLumiBlockNumber (unsigned int lumiBlock)
	Insert new Luminosity Block Number into a set. More...
void	insertProcessingTag (const std::string &process)
	Insert new Processing Tag into a set. More...
void	insertItemList (CLID type, const std::string &key)
	Insert new ItemList Entry into a set. More...
void	insertEventType (const EventType &event)
	Insert new Event Type into a set. More...
void	print (MsgStream &log) const
	Print a EventStreamInfo to the log file. More...
void	reset ()

Private Attributes
unsigned int	m_numberOfEvents
std::set< unsigned int >	m_runNumbers
std::set< unsigned int >	m_lumiBlockNumbers
std::set< std::string >	m_processingTags
std::set< std::pair< CLID, std::string > >	m_itemList
std::set< EventType >	m_eventTypes

Detailed Description

This class provides the summary information stored for data written as a Event Stream.

Definition at line 28 of file EventStreamInfo.h.

Constructor & Destructor Documentation

EventStreamInfo()

EventStreamInfo::EventStreamInfo ( )

inline

Default Constructor.

Definition at line 86 of file EventStreamInfo.h.

                                        : m_numberOfEvents(0),
  m_runNumbers(),
  m_lumiBlockNumbers(),
  m_processingTags(),
  m_itemList(),
  m_eventTypes() {}

~EventStreamInfo()

EventStreamInfo::~EventStreamInfo ( )

inlinevirtual

Destructor.

Definition at line 92 of file EventStreamInfo.h.

{}

Member Function Documentation

addEvent()

void EventStreamInfo::addEvent

(

unsigned int

number = 1

)

Increase Event Counter.

Definition at line 53 of file EventStreamInfo.cxx.

                                             {
  m_numberOfEvents += number;
}

getEventTypes()

const std::set< EventType > & EventStreamInfo::getEventTypes

(

)

const

Returns

a set of Event Types

Definition at line 47 of file EventStreamInfo.cxx.

                                     {
  return(m_eventTypes);
}

getItemList()

const std::set< std::pair< CLID, std::string > > & EventStreamInfo::getItemList

(

)

const

Returns

a set of ItemList Entries

Definition at line 41 of file EventStreamInfo.cxx.

                                   {
  return(m_itemList);
}

getLumiBlockNumbers()

const std::set< unsigned int > & EventStreamInfo::getLumiBlockNumbers

(

)

const

Returns

a set of Luminosity Block Numbers

Definition at line 29 of file EventStreamInfo.cxx.

                                           {
  return(m_lumiBlockNumbers);
}

getNumberOfEvents()

unsigned int EventStreamInfo::getNumberOfEvents

(

)

const

Returns

the Number of Events

Definition at line 17 of file EventStreamInfo.cxx.

                                         {
  return(m_numberOfEvents);
}

getProcessingTags()

const std::set< std::string > & EventStreamInfo::getProcessingTags

(

)

const

Returns

a set of Processing Tags

Definition at line 35 of file EventStreamInfo.cxx.

                                         {
  return(m_processingTags);
}

getRunNumbers()

const std::set< unsigned int > & EventStreamInfo::getRunNumbers

(

)

const

Returns

a set of Run Numbers

Definition at line 23 of file EventStreamInfo.cxx.

                                     {
  return(m_runNumbers);
}

insertEventType()

void EventStreamInfo::insertEventType

(

const EventType &

event

)

Insert new Event Type into a set.

Parameters

event

[IN] EventType object of the Event to be inserted.

Definition at line 88 of file EventStreamInfo.cxx.

                                                       {
  m_eventTypes.insert(event);
}

insertItemList()

void EventStreamInfo::insertItemList	(	CLID	type,
		const std::string &	key
	)

Insert new ItemList Entry into a set.

Parameters

type	[IN] CLID for type to be inserted.
key	[IN] string with key to be inserted.

Definition at line 82 of file EventStreamInfo.cxx.

                                                               {
  m_itemList.insert(std::pair<CLID, std::string>(type, key));
}

insertLumiBlockNumber()

void EventStreamInfo::insertLumiBlockNumber

(

unsigned int

lumiBlock

)

Insert new Luminosity Block Number into a set.

Parameters

lumiBlock

[IN] the Luminosity Block Number to be inserted.

Definition at line 70 of file EventStreamInfo.cxx.

                                                             {
  m_lumiBlockNumbers.insert(lumiBlock);
}

insertProcessingTag()

void EventStreamInfo::insertProcessingTag

(

const std::string &

process

)

Insert new Processing Tag into a set.

Parameters

process

[IN] string with the Processing Tag to be inserted.

Definition at line 76 of file EventStreamInfo.cxx.

                                                             {
  m_processingTags.insert(process);
}

insertRunNumber()

void EventStreamInfo::insertRunNumber

(

unsigned int

run

)

Insert new Run Number into a set.

Parameters

run	[IN] the Run Number to be inserted.

Definition at line 64 of file EventStreamInfo.cxx.

                                                 {
  m_runNumbers.insert(run);
}

print()

void EventStreamInfo::print

(

MsgStream &

log

)

const

Print a EventStreamInfo to the log file.

Definition at line 94 of file EventStreamInfo.cxx.

                                           {
  log << MSG::DEBUG << (*this) << endmsg;
  return;
}

reset()

void EventStreamInfo::reset

(

)

Definition at line 132 of file EventStreamInfo.cxx.

                       {
  m_numberOfEvents = 0;
  m_runNumbers.clear();
  m_lumiBlockNumbers.clear();
  m_processingTags.clear();
  m_itemList.clear();
  m_eventTypes.clear();
  return;
}

setNumberOfEvents()

void EventStreamInfo::setNumberOfEvents

(

unsigned int

number

)

Set number of events.

Definition at line 58 of file EventStreamInfo.cxx.

                                                           {
  m_numberOfEvents = number;
}

Member Data Documentation

m_eventTypes

std::set<EventType> EventStreamInfo::m_eventTypes

private

Definition at line 81 of file EventStreamInfo.h.

m_itemList

std::set<std::pair<CLID, std::string> > EventStreamInfo::m_itemList

private

Definition at line 80 of file EventStreamInfo.h.

m_lumiBlockNumbers

std::set<unsigned int> EventStreamInfo::m_lumiBlockNumbers

private

Definition at line 78 of file EventStreamInfo.h.

m_numberOfEvents

unsigned int EventStreamInfo::m_numberOfEvents

private

Definition at line 76 of file EventStreamInfo.h.

m_processingTags

std::set<std::string> EventStreamInfo::m_processingTags

private

Definition at line 79 of file EventStreamInfo.h.

m_runNumbers

std::set<unsigned int> EventStreamInfo::m_runNumbers

private

Definition at line 77 of file EventStreamInfo.h.

---

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

• EventStreamInfo.h
• EventStreamInfo.cxx