EventBookkeeper Class Reference

#include <EventBookkeeper.h>

Collaboration diagram for EventBookkeeper:

Public Member Functions
	EventBookkeeper ()
	Constructors. More...
	EventBookkeeper (const std::string &name)
	EventBookkeeper (const std::string &name, const std::string &description, const std::string &logic)
	EventBookkeeper (const EventBookkeeper &rhs)
EventBookkeeper &	operator= (const EventBookkeeper &rhs)
	~EventBookkeeper ()
void	Print (const std::string &indent="", std::ostream &out=std::cout)
void	PrintToMsg (MsgStream &, const std::string &indent="")
void	PrintFamily (const std::string &indent="")
const std::string &	getName () const
void	setName (const std::string &name)
const std::string &	getInputStream () const
void	setInputStream (const std::string &inputstream)
const std::string &	getOutputStream () const
void	setOutputStream (const std::string &outputstream)
void	setOutputStreamOfFamily (const std::string &outputstream)
const std::string &	getDescription () const
void	setDescription (const std::string &description)
const std::string &	getLogic () const
void	setLogic (const std::string &logic)
uint64_t	getNAcceptedEvents () const
void	setNAcceptedEvents (uint64_t nEvents)
void	addNAcceptedEvents (uint64_t nEvents)
double	getNWeightedAcceptedEvents () const
void	setNWeightedAcceptedEvents (double nWeightedEvents)
void	addNWeightedAcceptedEvents (double nWeightedEvents)
void	updateAcceptedEventsIncludingFamily (const EventBookkeeper *eb)
int	getCycle () const
void	setCycle (int cycle)
const std::vector< EventBookkeeper * > *	getChildrenEventBookkeepers () const
void	fillWithWholeFamily (EventBookkeeperCollection *family)
void	setChildrenEventBookkeepers (std::vector< EventBookkeeper * > *childrenEB)
void	AddChild (EventBookkeeper *eb)
void	AddChildren (std::vector< EventBookkeeper * > *children)
EventBookkeeper *	AddNewChild (const std::string &name, const std::string &description)
bool	isEqualTo (const EventBookkeeper *eb)

Private Member Functions
void	SetDefaultDataMemberValues ()
EventBookkeeper *	DeepCopyForFlatStructure (EventBookkeeperCollection *collFLAT)

Private Attributes
std::string	m_name
std::string	m_description
std::string	m_inputstream
std::string	m_outputstream
std::string	m_logic
uint64_t	m_nAcceptedEvents
double	m_nWeightedAcceptedEvents
int	m_cycle
std::vector< EventBookkeeper * > *	m_childrenEB
int	m_parentIndex
std::vector< unsigned int > *	m_childrenIndices
bool	m_declaredChildFilter
bool	m_declaredTopFilter

Friends
class	CutFlowSvc
class	EventBookkeeperCollection

Detailed Description

Definition at line 23 of file EventBookkeeper.h.

Constructor & Destructor Documentation

EventBookkeeper() [1/4]

EventBookkeeper::EventBookkeeper

(

)

Constructors.

Definition at line 16 of file EventBookkeeper.cxx.

{ 
  SetDefaultDataMemberValues();
}

EventBookkeeper() [2/4]

EventBookkeeper::EventBookkeeper

(

const std::string &

name

)

Definition at line 21 of file EventBookkeeper.cxx.

{ 
  SetDefaultDataMemberValues();
  m_name=name;
}

EventBookkeeper() [3/4]

EventBookkeeper::EventBookkeeper	(	const std::string &	name,
		const std::string &	description,
		const std::string &	logic
	)

Definition at line 27 of file EventBookkeeper.cxx.

{ 
  SetDefaultDataMemberValues();
  m_name=name;
  m_description=description;
  m_logic=logic;
}

EventBookkeeper() [4/4]

EventBookkeeper::EventBookkeeper

(

const EventBookkeeper &

rhs

)

Definition at line 37 of file EventBookkeeper.cxx.

  : m_name (rhs.m_name),
    m_description (rhs.m_description),
    m_inputstream (rhs.m_inputstream),
    m_outputstream (rhs.m_outputstream),
    m_logic (rhs.m_logic),
    m_nAcceptedEvents (rhs.m_nAcceptedEvents),
    m_nWeightedAcceptedEvents (rhs.m_nWeightedAcceptedEvents),
    m_cycle (rhs.m_cycle),
    m_parentIndex (rhs.m_parentIndex),
    m_declaredChildFilter (rhs.m_declaredChildFilter),
    m_declaredTopFilter (rhs.m_declaredTopFilter)
{
  //Make a new deep copy of the children, as these will be owned by this
  m_childrenEB = new std::vector<EventBookkeeper*>; 
  m_childrenEB->reserve(rhs.m_childrenEB->size());
  for(unsigned int i=0; i<rhs.m_childrenEB->size(); i++){ 
    EventBookkeeper* child=new EventBookkeeper(*rhs.m_childrenEB->at(i));
    m_childrenEB->push_back(child); 
  }
  m_childrenIndices = new std::vector<unsigned int>;
  m_childrenIndices->reserve(rhs.m_childrenIndices->size());
  for(unsigned int i=0; i<rhs.m_childrenIndices->size(); i++){ 
    m_childrenIndices->push_back(rhs.m_childrenIndices->at(i));
  }
}

~EventBookkeeper()

EventBookkeeper::~EventBookkeeper

(

)

Definition at line 146 of file EventBookkeeper.cxx.

{
  //std::cout<<"Destructing "<<m_name<<std::endl;
  for(unsigned int i=0; i<m_childrenEB->size(); i++){ delete m_childrenEB->at(i); }
  m_childrenEB->clear(); 
  delete m_childrenEB;
 
  m_childrenIndices->clear();
  delete m_childrenIndices;
}

Member Function Documentation

AddChild()

void EventBookkeeper::AddChild

(

EventBookkeeper *

eb

)

Definition at line 248 of file EventBookkeeper.cxx.

{
  //synchronize contextual info with the parent
  eb->setInputStream( m_inputstream );
  eb->setCycle( m_cycle );
  eb->setOutputStream(m_outputstream);
  bool notFound=true;
  for(unsigned int i=0; (i<m_childrenEB->size()) && notFound; i++){ 
    if(m_childrenEB->at(i)==eb){
      notFound=false;
    } 
  }
  if(notFound){ m_childrenEB->push_back(eb); }
  //else{ ATH_MSG_WARNING("Two requests for the same child. Second one ignored."); }
  return;
}

AddChildren()

void EventBookkeeper::AddChildren

(

std::vector< EventBookkeeper * > *

children

)

Definition at line 264 of file EventBookkeeper.cxx.

                                                                        {
  for(unsigned int i=0; i<children->size(); i++){
    AddChild( children->at(i) );
  }
  return;
}

addNAcceptedEvents()

void EventBookkeeper::addNAcceptedEvents

(

uint64_t

nEvents

)

Definition at line 205 of file EventBookkeeper.cxx.

{ 
  m_nAcceptedEvents+=nEvents;
}

AddNewChild()

EventBookkeeper * EventBookkeeper::AddNewChild	(	const std::string &	name,
		const std::string &	description
	)

Definition at line 271 of file EventBookkeeper.cxx.

{
  EventBookkeeper* eb = new EventBookkeeper(name,description,"Child");
  AddChild(eb);
  return eb;
}

addNWeightedAcceptedEvents()

void EventBookkeeper::addNWeightedAcceptedEvents

(

double

nWeightedEvents

)

Definition at line 217 of file EventBookkeeper.cxx.

{ 
  m_nWeightedAcceptedEvents+=nWeightedEvents;
}

DeepCopyForFlatStructure()

EventBookkeeper * EventBookkeeper::DeepCopyForFlatStructure ( EventBookkeeperCollection *  collFLAT )

private

Definition at line 115 of file EventBookkeeper.cxx.

{
  EventBookkeeper* book = new EventBookkeeper();
  book->m_name = m_name;
  book->m_description = m_description;
  book->m_inputstream = m_inputstream;
  book->m_outputstream = m_outputstream;
  book->m_logic = m_logic;
  book->m_nAcceptedEvents = m_nAcceptedEvents; 
  book->m_nWeightedAcceptedEvents = m_nWeightedAcceptedEvents; 
  book->m_cycle = m_cycle;
  book->m_declaredChildFilter = m_declaredChildFilter;
  book->m_declaredTopFilter = m_declaredTopFilter;
 
  //now deal here with the flat indices from collFLAT. Only the direct children are filled, NOT the whole family.
  for(unsigned int i=0; i<m_childrenEB->size(); i++){ 
    bool notFound=true;
    for(unsigned int j=0; (j<collFLAT->size() && notFound); j++){ 
      if(m_childrenEB->at(i)==collFLAT->at(j)){ 
        book->m_childrenIndices->push_back(j); 
        notFound=false;
      }
    }
  }
  //parentIndex is dealt in a separate function of EventBookkeeperCollection
  book->m_parentIndex=m_parentIndex;
 
  //the caller now owns book
  return book;
}

fillWithWholeFamily()

void EventBookkeeper::fillWithWholeFamily

(

EventBookkeeperCollection *

family

)

Definition at line 317 of file EventBookkeeper.cxx.

{
 
  //family does not include self
  for(unsigned int i=0; i<m_childrenEB->size(); i++){
    family->push_back(m_childrenEB->at(i));
    m_childrenEB->at(i)->fillWithWholeFamily(family);
  }
  
  return;
}

getChildrenEventBookkeepers()

const std::vector<EventBookkeeper*>* EventBookkeeper::getChildrenEventBookkeepers ( ) const

inline

Definition at line 73 of file EventBookkeeper.h.

{ return m_childrenEB; }

getCycle()

int EventBookkeeper::getCycle ( ) const

inline

Definition at line 70 of file EventBookkeeper.h.

{ return m_cycle; }

getDescription()

const std::string& EventBookkeeper::getDescription ( ) const

inline

Definition at line 54 of file EventBookkeeper.h.

{ return m_description; }

getInputStream()

const std::string& EventBookkeeper::getInputStream ( ) const

inline

Definition at line 47 of file EventBookkeeper.h.

{ return m_inputstream; }

getLogic()

const std::string& EventBookkeeper::getLogic ( ) const

inline

Definition at line 57 of file EventBookkeeper.h.

{ return m_logic; }

getNAcceptedEvents()

uint64_t EventBookkeeper::getNAcceptedEvents ( ) const

inline

Definition at line 60 of file EventBookkeeper.h.

{ return m_nAcceptedEvents; }

getName()

const std::string& EventBookkeeper::getName ( ) const

inline

Definition at line 44 of file EventBookkeeper.h.

{ return m_name; }

getNWeightedAcceptedEvents()

double EventBookkeeper::getNWeightedAcceptedEvents ( ) const

inline

Definition at line 64 of file EventBookkeeper.h.

{ return m_nWeightedAcceptedEvents; }

getOutputStream()

const std::string& EventBookkeeper::getOutputStream ( ) const

inline

Definition at line 50 of file EventBookkeeper.h.

{ return m_outputstream; }

isEqualTo()

bool EventBookkeeper::isEqualTo

(

const EventBookkeeper *

eb

)

Definition at line 280 of file EventBookkeeper.cxx.

                                                          {
  //This function is mostly a placeholder in case we decide to complexify later.
  return (m_name==eb->getName() && m_cycle==eb->getCycle());
}

operator=()

EventBookkeeper & EventBookkeeper::operator=

(

const EventBookkeeper &

rhs

)

Definition at line 65 of file EventBookkeeper.cxx.

{
  if (this != &rhs) {
    m_name=rhs.m_name;
    m_description=rhs.m_description;
    m_inputstream=rhs.m_inputstream;
    m_outputstream = rhs.m_outputstream;
    m_logic = rhs.m_logic;
    m_nAcceptedEvents=rhs.m_nAcceptedEvents;
    m_nWeightedAcceptedEvents=rhs.m_nWeightedAcceptedEvents;
    m_cycle=rhs.m_cycle;
    m_parentIndex=rhs.m_parentIndex;
    //Make a new deep copy of the children, as these will be owned by this
    m_childrenEB = new std::vector<EventBookkeeper*>; 
    m_childrenEB->reserve(rhs.m_childrenEB->size());
    for(unsigned int i=0; i<rhs.m_childrenEB->size(); i++){ 
      EventBookkeeper* child=new EventBookkeeper(*rhs.m_childrenEB->at(i));
      m_childrenEB->push_back(child); 
    }
    m_childrenIndices = new std::vector<unsigned int>;
    m_childrenIndices->reserve(rhs.m_childrenIndices->size());
    for(unsigned int i=0; i<rhs.m_childrenIndices->size(); i++){ 
      m_childrenIndices->push_back(rhs.m_childrenIndices->at(i));
    }
    m_declaredChildFilter=rhs.m_declaredChildFilter;
    m_declaredTopFilter=rhs.m_declaredTopFilter;
  }
  return *this;
}

Print()

void EventBookkeeper::Print	(	const std::string &	indent = "",
		std::ostream &	out = std::cout
	)

Definition at line 299 of file EventBookkeeper.cxx.

{
  out<<indent<<m_name<<" "<<m_inputstream<<" "<<m_outputstream<<" "<<m_logic<<" "<<m_cycle<<" ("<<m_childrenEB->size()<<" children) "<<": "<<m_description<<" ==> "<<m_nAcceptedEvents<<" "<<m_nWeightedAcceptedEvents<<std::endl;
  return;
}

PrintFamily()

void EventBookkeeper::PrintFamily

(

const std::string &

indent = ""

)

Definition at line 306 of file EventBookkeeper.cxx.

{
  Print(indent);
  std::string indent_ = indent + "     ";
  for(unsigned int i=0; i<m_childrenEB->size(); i++){
    m_childrenEB->at(i)->PrintFamily(indent_);
  }
  return;
}

PrintToMsg()

void EventBookkeeper::PrintToMsg	(	MsgStream &	log,
		const std::string &	indent = ""
	)

Definition at line 286 of file EventBookkeeper.cxx.

{
  if(log.level()==MSG::DEBUG){
    log<<MSG::DEBUG<<indent<<m_name<<" "<<m_inputstream<<" "<<m_outputstream<<" "<<m_logic<<" "<<m_cycle<<" ("<<m_childrenEB->size()<<" children) "<<": "<<m_description<<" ==> "<<m_nAcceptedEvents<<" "<<m_nWeightedAcceptedEvents<<endmsg;
  }
  else{
    log<<MSG::INFO<<indent<<m_name<<": "<<m_description<<" ==> "<<m_nAcceptedEvents<<endmsg;
  }
  
  return;
}

setChildrenEventBookkeepers()

void EventBookkeeper::setChildrenEventBookkeepers

(

std::vector< EventBookkeeper * > *

childrenEB

)

Definition at line 242 of file EventBookkeeper.cxx.

{ 
  m_childrenEB=childrenEB;
}

setCycle()

void EventBookkeeper::setCycle

(

int

cycle

)

Definition at line 236 of file EventBookkeeper.cxx.

{ 
  m_cycle=cycle;
}

SetDefaultDataMemberValues()

void EventBookkeeper::SetDefaultDataMemberValues ( )

private

Definition at line 96 of file EventBookkeeper.cxx.

{
  m_name="";
  m_description="";
  m_inputstream="unkwn";
  m_outputstream="unkwn";
  m_logic="unkwn";
  m_nAcceptedEvents=0; 
  m_nWeightedAcceptedEvents=0.0; 
  m_cycle=-1;
  m_childrenEB = new std::vector<EventBookkeeper*>; 
  m_parentIndex=-1;
  m_childrenIndices = new std::vector<unsigned int>;
  m_declaredChildFilter=false;
  m_declaredTopFilter=false;
  return;
}

setDescription()

void EventBookkeeper::setDescription

(

const std::string &

description

)

Definition at line 165 of file EventBookkeeper.cxx.

{ 
  m_description=description;
}

setInputStream()

void EventBookkeeper::setInputStream

(

const std::string &

inputstream

)

Definition at line 171 of file EventBookkeeper.cxx.

{ 
  m_inputstream=inputstream;
}

setLogic()

void EventBookkeeper::setLogic

(

const std::string &

logic

)

Definition at line 193 of file EventBookkeeper.cxx.

{ 
  m_logic=logic;
}

setNAcceptedEvents()

void EventBookkeeper::setNAcceptedEvents

(

uint64_t

nEvents

)

Definition at line 199 of file EventBookkeeper.cxx.

{ 
  m_nAcceptedEvents=nEvents;
}

setName()

void EventBookkeeper::setName

(

const std::string &

name

)

Definition at line 159 of file EventBookkeeper.cxx.

{ 
  m_name=name; 
}

setNWeightedAcceptedEvents()

void EventBookkeeper::setNWeightedAcceptedEvents

(

double

nWeightedEvents

)

Definition at line 211 of file EventBookkeeper.cxx.

{ 
  m_nWeightedAcceptedEvents=nWeightedEvents;
}

setOutputStream()

void EventBookkeeper::setOutputStream

(

const std::string &

outputstream

)

Definition at line 177 of file EventBookkeeper.cxx.

{ 
  m_outputstream=outputstream;
}

setOutputStreamOfFamily()

void EventBookkeeper::setOutputStreamOfFamily

(

const std::string &

outputstream

)

Definition at line 183 of file EventBookkeeper.cxx.

{
  setOutputStream(outputstream);
  for(unsigned int i=0; i<m_childrenEB->size(); i++){
    m_childrenEB->at(i)->setOutputStreamOfFamily(outputstream);
  }
  return;
}

updateAcceptedEventsIncludingFamily()

void EventBookkeeper::updateAcceptedEventsIncludingFamily

(

const EventBookkeeper *

eb

)

Definition at line 223 of file EventBookkeeper.cxx.

{
  addNAcceptedEvents( eb->getNAcceptedEvents() );
  addNWeightedAcceptedEvents( eb->getNWeightedAcceptedEvents() );
 
  const std::vector<EventBookkeeper*>* eb_children = eb->getChildrenEventBookkeepers();
  for(unsigned int i=0; i<m_childrenEB->size(); i++){
    m_childrenEB->at(i)->updateAcceptedEventsIncludingFamily(eb_children->at(i));
  }
  return;
}

Friends And Related Function Documentation

CutFlowSvc

friend class CutFlowSvc

friend

Definition at line 99 of file EventBookkeeper.h.

EventBookkeeperCollection

friend class EventBookkeeperCollection

friend

Definition at line 100 of file EventBookkeeper.h.

Member Data Documentation

m_childrenEB

std::vector<EventBookkeeper*>* EventBookkeeper::m_childrenEB

private

Definition at line 94 of file EventBookkeeper.h.

m_childrenIndices

std::vector<unsigned int>* EventBookkeeper::m_childrenIndices

private

Definition at line 103 of file EventBookkeeper.h.

m_cycle

int EventBookkeeper::m_cycle

private

Definition at line 93 of file EventBookkeeper.h.

m_declaredChildFilter

bool EventBookkeeper::m_declaredChildFilter

private

Definition at line 106 of file EventBookkeeper.h.

m_declaredTopFilter

bool EventBookkeeper::m_declaredTopFilter

private

Definition at line 107 of file EventBookkeeper.h.

m_description

std::string EventBookkeeper::m_description

private

Definition at line 87 of file EventBookkeeper.h.

m_inputstream

std::string EventBookkeeper::m_inputstream

private

Definition at line 88 of file EventBookkeeper.h.

m_logic

std::string EventBookkeeper::m_logic

private

Definition at line 90 of file EventBookkeeper.h.

m_nAcceptedEvents

uint64_t EventBookkeeper::m_nAcceptedEvents

private

Definition at line 91 of file EventBookkeeper.h.

m_name

std::string EventBookkeeper::m_name

private

Definition at line 86 of file EventBookkeeper.h.

m_nWeightedAcceptedEvents

double EventBookkeeper::m_nWeightedAcceptedEvents

private

Definition at line 92 of file EventBookkeeper.h.

m_outputstream

std::string EventBookkeeper::m_outputstream

private

Definition at line 89 of file EventBookkeeper.h.

m_parentIndex

int EventBookkeeper::m_parentIndex

private

Definition at line 102 of file EventBookkeeper.h.

---

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

• EventBookkeeper.h
• EventBookkeeper.cxx