Description of the class that is used to keep track of event counts. More...

#include <CutBookkeeper_v1.h>

Inheritance diagram for xAOD::CutBookkeeper_v1:

Collaboration diagram for xAOD::CutBookkeeper_v1:

Classes
struct	Payload
	Add struct for payload and implement operator ,/....=,... More...

Public Types
enum	CutLogic { UNKNOWN = 0 , ALLEVENTSPROCESSED = 1 , ALLEVENTSWRITTEN = 2 , OTHER = 3 , ACCEPT = 4 , REQUIRE = 5 , VETO = 6 }
	Enumeration of the logic of a cut. More...

Public Member Functions
	CutBookkeeper_v1 ()
	Constructor.
	~CutBookkeeper_v1 ()
	Destructor.
bool	operator== (const CutBookkeeper_v1 &rhs)
	Equality operator.
bool	isEqualTo (const CutBookkeeper_v1 *eb) const
	Test for the equality of this CutBookkeeper with another one.
void	toPersistent ()
	Function preparing the object to be persistified.
Getters and setters for the payload information, i.e., event coutners and weights
Payload	payload () const
	Get the whole payload object (which contains all counters) in one go.
void	setPayload (const Payload &payload)
	Set the whole payload object (which contains all counters) in one go.
uint64_t	nAcceptedEvents () const
	Get the number of accepted events that this CutBookkeeper has seen.
void	setNAcceptedEvents (uint64_t nEvents)
	Set the number of accepted events for this CutBookkeeper.
void	addNAcceptedEvents (uint64_t nEvents)
	Add seen events to the number of accepted events that this CutBookkeeper has seen.
double	sumOfEventWeights () const
	Get the sum-of-event-weights that this CutBookkeeper has seen.
void	setSumOfEventWeights (double nWeightedEvents)
	Set the sum-of-event-weights that this CutBookkeeper has seen.
void	addSumOfEventWeights (double nWeightedEvents)
	Add more sum-of-event-weights that this CutBookkeeper has seen.
double	sumOfEventWeightsSquared () const
	Get the sum-of-(event-weights-squared) that this CutBookkeeper has seen.
void	setSumOfEventWeightsSquared (double nWeightedEventsSquared)
	Set the sum-of-(event-weights-squared) that this CutBookkeeper has seen.
void	addSumOfEventWeightsSquared (double nWeightedEventsSquared)
	Add more sum-of-(event-weights-squared) that this CutBookkeeper has seen.
Handling of the child-parent relationship between different CutBookkeepers
bool	hasParent () const
	Check if there is a parent CutBookkeeper of this CutBookkeeper.
const xAOD::CutBookkeeper_v1 *	parent () const
	Get the parent CutBookkeeper.
void	setParent (const CutBookkeeper_v1 *parentEB)
	Set the parent CutBookkeeper of this CutBookkeeper.
std::size_t	nChildren () const
	Get the number of children CutBookkeepers of this CutBookkeeper.
bool	hasChild (const xAOD::CutBookkeeper_v1 *testCBK) const
	Test if a given child already exists.
const xAOD::CutBookkeeper_v1 *	child (std::size_t i) const
	Get the child at position i.
void	setChildren (const std::vector< CutBookkeeper_v1 * > &childrenEB)
	Set all children of this CutBookkeeper in one go.
void	addChildren (const std::vector< CutBookkeeper_v1 * > &childrenEB)
	Add multiple children in one go to this CutBookkeeper.
void	addChild (CutBookkeeper_v1 *childEB)
	Add one child to this CutBookkeeper.
CutBookkeeper_v1 *	addNewChild (const std::string &name, const std::string &description)
	Create a new CutBookkeeper (using the given name and description) and add this new CutBookkeeper to this one as a child.
Handling of the usage of other CutBookkeepers by this one
std::size_t	nUsedOthers () const
	Check if this CutBookkeeper has used others.
bool	hasUsedOther (const xAOD::CutBookkeeper_v1 *testCBK) const
	Check if this CutBookkeeper has used others.
const xAOD::CutBookkeeper_v1 *	usedOther (std::size_t i) const
	Get the usedOther at position i.
void	setUsedOthers (const std::vector< CutBookkeeper_v1 * > &usedOthers)
	Set all CutBookkeeper that are used by this one in one go.
void	addUsedOthers (const std::vector< CutBookkeeper_v1 * > &usedOthers)
	Add multiple children in one go to this CutBookkeeper.
void	addUsedOther (CutBookkeeper_v1 *usedOtherEB)
	Add one other CutBookkeeper that is used by this one.
Handling of the siblings of this CutBookkeepers, i.e., the cuts
that happen at the same cut stage as this one, but in another (control) region
std::size_t	nSiblings () const
	Check if this CutBookkeeper has siblings.
bool	hasSibling (const xAOD::CutBookkeeper_v1 *testCBK) const
	Test if the provided CutBookkeeper is already a sibling.
const xAOD::CutBookkeeper_v1 *	sibling (std::size_t i) const
	Get the sibling number i.
void	setSiblings (const std::vector< CutBookkeeper_v1 * > &siblings)
	Set all CutBookkeeper that are siblings to this one in one go.
void	addSiblings (const std::vector< CutBookkeeper_v1 * > &siblings)
	Add multiple siblings in one go to this CutBookkeeper.
void	addSibling (CutBookkeeper_v1 *siblingsEB)
	Add one sibling CutBookkeeper to this one.

Getters and setters for the (sort of) 'static' information of the CutBookkeeper
unsigned int	nameIdentifier () const
	Get the nameIdentifier for this CutBookkeeper.
unsigned int	uniqueIdentifier () const
	Get the uniqueIdentifier for this CutBookkeeper.
const std::string &	name () const
	Get the name of this CutBookkeeper.
void	setName (const std::string &name)
	Set the name of this CutBookkeeper.
const std::string &	description () const
	Get the description of this CutBookkeeper.
void	setDescription (const std::string &description)
	Set the description of this CutBookkeeper.
bool	isTopFilter () const
	Check if this CutBookkeeper was a top filter.
void	setTopFilter (bool isTopFilter)
	Set the top-filter property of this CutBookkeeper.
CutLogic	cutLogic () const
	Get the cut logic of this CutBookkeeper, e.g., ACCEPT, REQUIRE, VETO.
void	setCutLogic (CutLogic logic)
	Set the cut logic of this CutBookkeeper, e.g., ACCEPT, REQUIRE, VETO.
int	cycle () const
	Get the skimming cycle that this CutBookkeeper was running in.
void	setCycle (int cycle)
	Set the skimming cycle that this CutBookkeeper is running in.
const std::string &	inputStream () const
	Get the name of the input-file stream object that was seen by this CutBookkeeper.
void	setInputStream (const std::string &inputstream)
	Set the name of the current input-file stream object for this CutBookkeeper.
const std::vector< std::string > &	outputStreams () const
	Get the names of the output-file stream objects that were seen by this CutBookkeeper.
bool	hasOutputStream (const std::string &outputstream) const
	Check if the given output stream name is known to this CutBookkeeper.
void	addOutputStream (const std::string &outputstream)
	Add the name of an output-file stream object for this CutBookkeeper.
void addOutputStreamForAllUsed	ATLAS_NOT_THREAD_SAFE (const std::string &outputstream)
	Add the name of an output-file stream object for this CutBookkeeper.
void	setOutputStreams (const std::vector< std::string > &outputstreams)
	Set the names of the output-file stream objects for this CutBookkeeper.
void	setNameIdentifier (unsigned int hash)
	Set the nameIdentifier for this CutBookkeeper.
void	setUniqueIdentifier (unsigned int hash)
	Set the uniqueIdentifier for this CutBookkeeper.

Detailed Description

Description of the class that is used to keep track of event counts.

Author: Karsten Koeneke karst.nosp@m.en.k.nosp@m.oenek.nosp@m.e@ce.nosp@m.rn.ch

$Revision$ $Date$

Definition at line 29 of file CutBookkeeper_v1.h.

Member Enumeration Documentation

◆ CutLogic

enum xAOD::CutBookkeeper_v1::CutLogic

Enumeration of the logic of a cut.

Enumerator
UNKNOWN
ALLEVENTSPROCESSED
ALLEVENTSWRITTEN
OTHER
ACCEPT
REQUIRE
VETO

Definition at line 34 of file CutBookkeeper_v1.h.

                  {
      UNKNOWN            = 0,
      ALLEVENTSPROCESSED = 1,
      ALLEVENTSWRITTEN   = 2,
      OTHER              = 3,
      ACCEPT             = 4,
      REQUIRE            = 5,
      VETO               = 6,
    };

Constructor & Destructor Documentation

◆ CutBookkeeper_v1()

xAOD::CutBookkeeper_v1::CutBookkeeper_v1 ( )

Constructor.

Definition at line 71 of file CutBookkeeper_v1.cxx.

  : SG::AuxElement()
    // m_cycle(-1),
    // m_parentIndex(-1),
    // m_childrenIndices()
  {
    // Create a private store all the time for this object.
    // This is OK since it only happens in initialize that we create new objects
    // of this type or when merging files.
    this->makePrivateStore();
 
    // Set default data members
    nameIdentifierAcc(*this)           = 0;
    uniqueIdentifierAcc(*this)         = 0;
    nameAcc(*this)                     = std::string("");
    descriptionAcc(*this)              = std::string("");
    cutLogicAcc(*this)                 = 0;
    isTopFilterAcc(*this)              = false;
    cycleAcc(*this)                    = -1;
    inputStreamAcc(*this)              = std::string("");
    outputStreamsAcc(*this)            = std::vector< std::string >();
    parentLinkAcc(*this)               = xAOD::CutBookkeeperLink_t();
    childrenLinksAcc(*this)            = xAOD::CutBookkeeperLinks_t();
    othersLinksAcc(*this)              = xAOD::CutBookkeeperLinks_t();
    siblingsLinksAcc(*this)            = xAOD::CutBookkeeperLinks_t();
    nAcceptedEventsAcc(*this)          = 0;
    sumOfEventWeightsAcc(*this)        = 0.0;
    sumOfEventWeightsSquaredAcc(*this) = 0.0;
  }

◆ ~CutBookkeeper_v1()

xAOD::CutBookkeeper_v1::~CutBookkeeper_v1 ( )

Destructor.

Definition at line 103 of file CutBookkeeper_v1.cxx.

103 {

104 }

Member Function Documentation

◆ addChild()

void xAOD::CutBookkeeper_v1::addChild ( CutBookkeeper_v1 * childEB )

Add one child to this CutBookkeeper.

Definition at line 442 of file CutBookkeeper_v1.cxx.

                                                        {
    // See if the provided CutBookkeeper is already a child.
    // If so, just do nothing
    if ( this->hasChild(childEB) ) {
      return;
    }
 
    //synchronize contextual info with the parent
    childEB->setInputStream( this->inputStream() );
    childEB->setCycle( this->cycle() );
    childEB->setOutputStreams( this->outputStreams() );
    childEB->setParent( this );
 
    // Create the needed ElementLink
    std::size_t ebIdx = childEB->index();
    const xAOD::CutBookkeeperContainer_v1* ebCont =
      dynamic_cast<const xAOD::CutBookkeeperContainer_v1*>(childEB->container());
    if ( !ebCont ) {
      throw std::runtime_error( "ERROR: Could not find the container for the child CutBookkeeper" );
    }
 
    // Finally, add the provided CutBookkeeper as a child
    childrenLinksAcc(*this).emplace_back(*ebCont, ebIdx );
 
    return;
  }

◆ addChildren()

void xAOD::CutBookkeeper_v1::addChildren ( const std::vector< CutBookkeeper_v1 * > & childrenEB )

Add multiple children in one go to this CutBookkeeper.

Definition at line 429 of file CutBookkeeper_v1.cxx.

                                                                                  {
    // Reserve the space for the children vector
    childrenLinksAcc(*this).reserve( childrenLinksAcc(*this).size() + childrenEB.size() );
 
    // Add all children
    for ( std::size_t i=0; i<childrenEB.size(); ++i ) {
      this->addChild( childrenEB.at(i) );
    }
    return;
  }

◆ addNAcceptedEvents()

void xAOD::CutBookkeeper_v1::addNAcceptedEvents ( uint64_t nEvents )

Add seen events to the number of accepted events that this CutBookkeeper has seen.

Definition at line 302 of file CutBookkeeper_v1.cxx.

                                                            {
    nAcceptedEventsAcc(*this) += nEvents;
    return;
  }

◆ addNewChild()

CutBookkeeper_v1 * xAOD::CutBookkeeper_v1::addNewChild	(	const std::string &	name,
		const std::string &	description )

Create a new CutBookkeeper (using the given name and description) and add this new CutBookkeeper to this one as a child.

Definition at line 471 of file CutBookkeeper_v1.cxx.

                                                                 {
    // Get the container where this CutBookkeeper lives in.
    // Throw an exception if we cannot find it
    CutBookkeeperContainer_v1* ebCont = dynamic_cast<xAOD::CutBookkeeperContainer_v1*>(this->container());
    if ( !ebCont ) {
      throw std::runtime_error( "ERROR: Could not find the container for this CutBookkeeper" );
    }
 
    // Create a new CutBookkeeper and add it to the same container as this one
    CutBookkeeper_v1* eb = new CutBookkeeper_v1();
    ebCont->push_back(eb);
 
    // Set the properties of the new CutBookkeeper
    eb->setName(name);
    eb->setDescription(description);
 
    addChild(eb);
    return eb;
  }

◆ addOutputStream()

void xAOD::CutBookkeeper_v1::addOutputStream ( const std::string & outputstream )

Add the name of an output-file stream object for this CutBookkeeper.

Definition at line 250 of file CutBookkeeper_v1.cxx.

                                                                        {
    for ( std::size_t i=0; i<outputStreamsAcc(*this).size(); ++i ) {
      if ( outputstream == outputStreamsAcc(*this).at(i) ) {
        return;
      }
    }
    outputStreamsAcc(*this).push_back(outputstream);
  }

◆ addSibling()

void xAOD::CutBookkeeper_v1::addSibling ( CutBookkeeper_v1 * siblingsEB )

Add one sibling CutBookkeeper to this one.

Definition at line 642 of file CutBookkeeper_v1.cxx.

                                                            {
    if ( this->hasSibling(siblingEB) ) {
      return;
    }
 
    // Create the needed ElementLink
    std::size_t ebIdx = siblingEB->index();
    const xAOD::CutBookkeeperContainer_v1* ebCont =
      dynamic_cast<const xAOD::CutBookkeeperContainer_v1*>(siblingEB->container());
    if ( !ebCont ) {
      throw std::runtime_error( "ERROR: Could not find the container for the sibling CutBookkeeper" );
    }
 
    // Finally, add the provided CutBookkeeper as a sibling
    siblingsLinksAcc(*this).emplace_back(*ebCont, ebIdx );
 
    //synchronize contextual info with the sibling
    siblingEB->addSibling( this );
 
    return;
  }

◆ addSiblings()

void xAOD::CutBookkeeper_v1::addSiblings ( const std::vector< CutBookkeeper_v1 * > & siblings )

Add multiple siblings in one go to this CutBookkeeper.

Definition at line 629 of file CutBookkeeper_v1.cxx.

                                                                                {
    // Reserve the space for the siblings vector
    siblingsLinksAcc(*this).reserve( siblingsLinksAcc(*this).size() + siblings.size() );
 
    // Add all siblings
    for ( std::size_t i=0; i<siblings.size(); ++i ) {
      this->addSibling( siblings.at(i) );
    }
    return;
  }

◆ addSumOfEventWeights()

void xAOD::CutBookkeeper_v1::addSumOfEventWeights ( double nWeightedEvents )

Add more sum-of-event-weights that this CutBookkeeper has seen.

Definition at line 320 of file CutBookkeeper_v1.cxx.

                                                                      {
    sumOfEventWeightsAcc(*this) += sumOfEventWeights;
    return;
  }

◆ addSumOfEventWeightsSquared()

void xAOD::CutBookkeeper_v1::addSumOfEventWeightsSquared ( double nWeightedEventsSquared )

Add more sum-of-(event-weights-squared) that this CutBookkeeper has seen.

Definition at line 338 of file CutBookkeeper_v1.cxx.

                                                                                    {
    sumOfEventWeightsSquaredAcc(*this) += sumOfEventWeightsSquared;
    return;
  }

◆ addUsedOther()

void xAOD::CutBookkeeper_v1::addUsedOther ( CutBookkeeper_v1 * usedOtherEB )

Add one other CutBookkeeper that is used by this one.

Definition at line 555 of file CutBookkeeper_v1.cxx.

                                                                {
    if ( this->hasUsedOther(usedOtherEB) ) {
      return;
    }
 
    // I don't think I need this as the others should have already been properly registered
    // //synchronize contextual info with the used-other
    // usedOtherEB->setInputStream( m_inputstream );
    // usedOtherEB->setCycle( m_cycle );
    // usedOtherEB->setOutputStream( m_outputstream );
 
    // Create the needed ElementLink
    std::size_t ebIdx = usedOtherEB->index();
    const xAOD::CutBookkeeperContainer_v1* ebCont =
      dynamic_cast<const xAOD::CutBookkeeperContainer_v1*>(usedOtherEB->container());
    if ( !ebCont ) {
      throw std::runtime_error( "ERROR: Could not find the container for the usedOthers CutBookkeeper" );
    }
 
    // Finally, add the provided CutBookkeeper as a usedOther
    othersLinksAcc(*this).emplace_back(*ebCont, ebIdx );
 
    return;
  }

◆ addUsedOthers()

void xAOD::CutBookkeeper_v1::addUsedOthers ( const std::vector< CutBookkeeper_v1 * > & usedOthers )

Add multiple children in one go to this CutBookkeeper.

Definition at line 542 of file CutBookkeeper_v1.cxx.

                                                                                    {
    // Reserve the space for the used-other vector
    othersLinksAcc(*this).reserve( othersLinksAcc(*this).size() + usedOthers.size() );
 
    // Add all used ones
    for ( std::size_t i=0; i<usedOthers.size(); ++i ) {
      this->addUsedOther( usedOthers.at(i) );
    }
    return;
  }

◆ ATLAS_NOT_THREAD_SAFE()

void addOutputStreamForAllUsed xAOD::CutBookkeeper_v1::ATLAS_NOT_THREAD_SAFE ( const std::string & outputstream )

Add the name of an output-file stream object for this CutBookkeeper.

◆ child()

const xAOD::CutBookkeeper_v1 * xAOD::CutBookkeeper_v1::child ( std::size_t i ) const

Get the child at position i.

Definition at line 408 of file CutBookkeeper_v1.cxx.

                                                                         {
    if ( i >= childrenLinksAcc(*this).size() ) {
      throw std::runtime_error( "ERROR: Got an index out of the range of childred CutBookkeepers" );
    }
    const xAOD::CutBookkeeperLink_t& tmpLink = childrenLinksAcc(*this).at(i);
    if ( !(tmpLink.isValid()) ) {
      throw std::runtime_error( "ERROR: Got an invalid child CutBookkeeper" );
    }
    const xAOD::CutBookkeeper_v1* tmpBK = *tmpLink;
    return tmpBK;
  }

◆ cutLogic()

CutBookkeeper_v1::CutLogic xAOD::CutBookkeeper_v1::cutLogic ( ) const

Get the cut logic of this CutBookkeeper, e.g., ACCEPT, REQUIRE, VETO.

Definition at line 195 of file CutBookkeeper_v1.cxx.

                                                            {
    return static_cast<CutBookkeeper_v1::CutLogic>(cutLogicAcc(*this));
  }

◆ cycle()

int xAOD::CutBookkeeper_v1::cycle ( ) const

Get the skimming cycle that this CutBookkeeper was running in.

Definition at line 205 of file CutBookkeeper_v1.cxx.

                                    {
    return cycleAcc(*this);
  }

◆ description()

const std::string & xAOD::CutBookkeeper_v1::description ( ) const

Get the description of this CutBookkeeper.

Definition at line 172 of file CutBookkeeper_v1.cxx.

                                                       {
    return descriptionAcc(*this);
  }

◆ hasChild()

bool xAOD::CutBookkeeper_v1::hasChild ( const xAOD::CutBookkeeper_v1 * testCBK ) const

Test if a given child already exists.

Definition at line 392 of file CutBookkeeper_v1.cxx.

                                                                             {
    // Search for the child in the existing chidren
    for ( std::size_t i=0; i<childrenLinksAcc(*this).size(); ++i ) {
      const xAOD::CutBookkeeperLink_t& tmpLink = childrenLinksAcc(*this).at(i);
      if ( !(tmpLink.isValid()) ) {
        throw std::runtime_error( "ERROR: Got an invalid child CutBookkeeper" );
      }
      const xAOD::CutBookkeeper_v1* tmpBK = *tmpLink;
      if ( tmpBK->isEqualTo(testCBK) ) {
        return true;
      }
    }
    return false;
  }

◆ hasOutputStream()

bool xAOD::CutBookkeeper_v1::hasOutputStream ( const std::string & outputstream ) const

Check if the given output stream name is known to this CutBookkeeper.

Definition at line 240 of file CutBookkeeper_v1.cxx.

                                                                              {
    for ( std::size_t i=0; i<outputStreamsAcc(*this).size(); ++i ) {
      if ( outputstream == outputStreamsAcc(*this).at(i) ) {
        return true;
      }
    }
    return false;
  }

◆ hasParent()

bool xAOD::CutBookkeeper_v1::hasParent ( ) const

Check if there is a parent CutBookkeeper of this CutBookkeeper.

Definition at line 359 of file CutBookkeeper_v1.cxx.

                                         {
    return ( parentLinkAcc(*this).isValid() );
  }

◆ hasSibling()

bool xAOD::CutBookkeeper_v1::hasSibling ( const xAOD::CutBookkeeper_v1 * testCBK ) const

Test if the provided CutBookkeeper is already a sibling.

Definition at line 592 of file CutBookkeeper_v1.cxx.

                                                                               {
    // Search for the sibling in the existing sibings
    for ( std::size_t i=0; i<siblingsLinksAcc(*this).size(); ++i ) {
      const xAOD::CutBookkeeperLink_t& tmpLink = siblingsLinksAcc(*this).at(i);
      if ( !(tmpLink.isValid()) ) {
        throw std::runtime_error( "ERROR: Got an invalid sibling CutBookkeeper" );
      }
      const xAOD::CutBookkeeper_v1* tmpBK = *tmpLink;
      if ( tmpBK->isEqualTo(testCBK) ) {
        return true;
      }
    }
    return false;
  }

◆ hasUsedOther()

bool xAOD::CutBookkeeper_v1::hasUsedOther ( const xAOD::CutBookkeeper_v1 * testCBK ) const

Check if this CutBookkeeper has used others.

Definition at line 505 of file CutBookkeeper_v1.cxx.

                                                                                 {
    // Search for the usedOther in the existing usedOthers
    for ( std::size_t i=0; i<othersLinksAcc(*this).size(); ++i ) {
      const xAOD::CutBookkeeperLink_t& tmpLink = othersLinksAcc(*this).at(i);
      if ( !(tmpLink.isValid()) ) {
        throw std::runtime_error( "ERROR: Got an invalid usedOther CutBookkeeper" );
      }
      const xAOD::CutBookkeeper_v1* tmpBK = *tmpLink;
      if ( tmpBK->isEqualTo(testCBK) ) {
        return true;
      }
    }
    return false;
  }

◆ inputStream()

const std::string & xAOD::CutBookkeeper_v1::inputStream ( ) const

Get the name of the input-file stream object that was seen by this CutBookkeeper.

Definition at line 220 of file CutBookkeeper_v1.cxx.

                                                       {
    return inputStreamAcc(*this);
  }

◆ isEqualTo()

bool xAOD::CutBookkeeper_v1::isEqualTo ( const CutBookkeeper_v1 * eb ) const

Test for the equality of this CutBookkeeper with another one.

Definition at line 348 of file CutBookkeeper_v1.cxx.

                                                                     {
    //This function is mostly a placeholder in case we decide to complexify later.
    return ( this->uniqueIdentifier() == eb->uniqueIdentifier() );
  }

◆ isTopFilter()

bool xAOD::CutBookkeeper_v1::isTopFilter ( ) const

Check if this CutBookkeeper was a top filter.

Definition at line 184 of file CutBookkeeper_v1.cxx.

                                           {
    return static_cast<bool>(isTopFilterAcc(*this));
  }

◆ nAcceptedEvents()

uint64_t xAOD::CutBookkeeper_v1::nAcceptedEvents ( ) const

Get the number of accepted events that this CutBookkeeper has seen.

Definition at line 291 of file CutBookkeeper_v1.cxx.

                                                   {
    return nAcceptedEventsAcc(*this);
  }

◆ name()

const std::string & xAOD::CutBookkeeper_v1::name ( ) const

Get the name of this CutBookkeeper.

Definition at line 156 of file CutBookkeeper_v1.cxx.

                                                {
    return nameAcc(*this);
  }

◆ nameIdentifier()

unsigned int xAOD::CutBookkeeper_v1::nameIdentifier ( ) const

Get the nameIdentifier for this CutBookkeeper.

Definition at line 133 of file CutBookkeeper_v1.cxx.

                                                      {
    return nameIdentifierAcc(*this);
  }

◆ nChildren()

std::size_t xAOD::CutBookkeeper_v1::nChildren ( ) const

Get the number of children CutBookkeepers of this CutBookkeeper.

Definition at line 387 of file CutBookkeeper_v1.cxx.

                                              {
    return childrenLinksAcc(*this).size();
  }

◆ nSiblings()

std::size_t xAOD::CutBookkeeper_v1::nSiblings ( ) const

Check if this CutBookkeeper has siblings.

Definition at line 587 of file CutBookkeeper_v1.cxx.

                                              {
    return siblingsLinksAcc(*this).size();
  }

◆ nUsedOthers()

std::size_t xAOD::CutBookkeeper_v1::nUsedOthers ( ) const

Check if this CutBookkeeper has used others.

Definition at line 500 of file CutBookkeeper_v1.cxx.

                                                {
    return othersLinksAcc(*this).size();
  }

◆ operator==()

bool xAOD::CutBookkeeper_v1::operator== ( const CutBookkeeper_v1 & rhs )

inline

Equality operator.

Definition at line 82 of file CutBookkeeper_v1.h.

                                                 {
      return this->isEqualTo( &rhs );
    }

◆ outputStreams()

const std::vector< std::string > & xAOD::CutBookkeeper_v1::outputStreams ( ) const

Get the names of the output-file stream objects that were seen by this CutBookkeeper.

Definition at line 235 of file CutBookkeeper_v1.cxx.

                                                                    {
    return outputStreamsAcc(*this);
  }

◆ parent()

const xAOD::CutBookkeeper_v1 * xAOD::CutBookkeeper_v1::parent ( ) const

Get the parent CutBookkeeper.

Definition at line 364 of file CutBookkeeper_v1.cxx.

                                                             {
    if ( parentLinkAcc(*this).isValid() ) {
      return *(parentLinkAcc(*this));
    }
    return nullptr;
  }

◆ payload()

CutBookkeeper_v1::Payload xAOD::CutBookkeeper_v1::payload ( ) const

Get the whole payload object (which contains all counters) in one go.

Return it by value as it only contains three numbers.

Definition at line 112 of file CutBookkeeper_v1.cxx.

                                                          {
    CutBookkeeper_v1::Payload payload;
    payload.nAcceptedEvents             = this->nAcceptedEvents();
    payload.sumOfEventWeights           = this->sumOfEventWeights();
    payload.sumOfEventWeightsSquared    = this->sumOfEventWeightsSquared();
    return payload;
  }

◆ setChildren()

void xAOD::CutBookkeeper_v1::setChildren ( const std::vector< CutBookkeeper_v1 * > & childrenEB )

Set all children of this CutBookkeeper in one go.

Definition at line 422 of file CutBookkeeper_v1.cxx.

                                                                                  {
    childrenLinksAcc(*this).clear();
    return this->addChildren(childrenEB);
  }

◆ setCutLogic()

void xAOD::CutBookkeeper_v1::setCutLogic ( CutBookkeeper_v1::CutLogic val )

Set the cut logic of this CutBookkeeper, e.g., ACCEPT, REQUIRE, VETO.

Definition at line 199 of file CutBookkeeper_v1.cxx.

                                                                   {
    cutLogicAcc( *this ) = static_cast<unsigned int>(val);
  }

◆ setCycle()

void xAOD::CutBookkeeper_v1::setCycle ( int cycle )

Set the skimming cycle that this CutBookkeeper is running in.

Definition at line 209 of file CutBookkeeper_v1.cxx.

                                           {
    static const SG::AuxElement::Accessor< int > cycleAcc( "cycle" );
    cycleAcc(*this) = cycle;
    std::ostringstream str;
    str << name() << inputStream() << cycle;
    this->setUniqueIdentifier( ::UtilsHash( str.str() ) );
    return;
  }

◆ setDescription()

void xAOD::CutBookkeeper_v1::setDescription ( const std::string & description )

Set the description of this CutBookkeeper.

Definition at line 177 of file CutBookkeeper_v1.cxx.

                                                                    {
    descriptionAcc( *this ) = description;
    return;
  }

◆ setInputStream()

void xAOD::CutBookkeeper_v1::setInputStream ( const std::string & inputstream )

Set the name of the current input-file stream object for this CutBookkeeper.

Definition at line 225 of file CutBookkeeper_v1.cxx.

                                                                    {
    inputStreamAcc(*this) = inputstream;
    std::ostringstream str;
    str << name() << inputstream << cycle();
    this->setUniqueIdentifier( ::UtilsHash( str.str() ) );
    return;
  }

◆ setNAcceptedEvents()

void xAOD::CutBookkeeper_v1::setNAcceptedEvents ( uint64_t nEvents )

Set the number of accepted events for this CutBookkeeper.

Definition at line 295 of file CutBookkeeper_v1.cxx.

                                                          {
    nAcceptedEventsAcc( *this ) = val;
    return;
  }

◆ setName()

void xAOD::CutBookkeeper_v1::setName ( const std::string & name )

Set the name of this CutBookkeeper.

Definition at line 161 of file CutBookkeeper_v1.cxx.

                                                      {
    nameAcc( *this ) = name;
    this->setNameIdentifier( ::UtilsHash( name ) );
    std::ostringstream str;
    str << name << inputStream() << cycle();
    this->setUniqueIdentifier( ::UtilsHash( str.str() ) );
    return;
  }

◆ setNameIdentifier()

void xAOD::CutBookkeeper_v1::setNameIdentifier ( unsigned int hash )

private

Set the nameIdentifier for this CutBookkeeper.

Definition at line 137 of file CutBookkeeper_v1.cxx.

                                                                        {
    nameIdentifierAcc( *this ) = nameIdentifier;
    return;
  }

◆ setOutputStreams()

void xAOD::CutBookkeeper_v1::setOutputStreams ( const std::vector< std::string > & outputstreams )

Set the names of the output-file stream objects for this CutBookkeeper.

Definition at line 280 of file CutBookkeeper_v1.cxx.

                                                                                   {
    outputStreamsAcc(*this) = outputstreams;
    return;
  }

◆ setParent()

void xAOD::CutBookkeeper_v1::setParent ( const CutBookkeeper_v1 * parentEB )

Set the parent CutBookkeeper of this CutBookkeeper.

Definition at line 372 of file CutBookkeeper_v1.cxx.

                                                                     {
    // Get the index of the provided CutBookkeeper in its container
    std::size_t ebIdx = parentEB->index();
    const xAOD::CutBookkeeperContainer_v1* ebCont =
      dynamic_cast<const xAOD::CutBookkeeperContainer_v1*>(parentEB->container());
    if ( !ebCont ) {
      throw std::runtime_error( "ERROR: Could not find the container for the parent CutBookkeeper" );
    }
    parentLinkAcc(*this) = xAOD::CutBookkeeperLink_t( *ebCont, ebIdx );
    return;
  }

◆ setPayload()

void xAOD::CutBookkeeper_v1::setPayload ( const Payload & payload )

Set the whole payload object (which contains all counters) in one go.

Definition at line 121 of file CutBookkeeper_v1.cxx.

                                                                            {
    this->setNAcceptedEvents( payload.nAcceptedEvents );
    this->setSumOfEventWeights( payload.sumOfEventWeights );
    this->setSumOfEventWeightsSquared( payload.sumOfEventWeightsSquared );
  }

◆ setSiblings()

void xAOD::CutBookkeeper_v1::setSiblings ( const std::vector< CutBookkeeper_v1 * > & siblings )

Set all CutBookkeeper that are siblings to this one in one go.

Definition at line 622 of file CutBookkeeper_v1.cxx.

                                                                                {
    siblingsLinksAcc(*this).clear();
    return this->addSiblings(siblings);
  }

◆ setSumOfEventWeights()

void xAOD::CutBookkeeper_v1::setSumOfEventWeights ( double nWeightedEvents )

Set the sum-of-event-weights that this CutBookkeeper has seen.

Definition at line 313 of file CutBookkeeper_v1.cxx.

                                                          {
    sumOfEventWeightsAcc( *this ) = val;
    return;
  }

◆ setSumOfEventWeightsSquared()

void xAOD::CutBookkeeper_v1::setSumOfEventWeightsSquared ( double nWeightedEventsSquared )

Set the sum-of-(event-weights-squared) that this CutBookkeeper has seen.

Definition at line 331 of file CutBookkeeper_v1.cxx.

                                                                 {
    sumOfEventWeightsSquaredAcc( *this ) = val;
    return;
  }

◆ setTopFilter()

void xAOD::CutBookkeeper_v1::setTopFilter ( bool isTopFilter )

Set the top-filter property of this CutBookkeeper.

Definition at line 188 of file CutBookkeeper_v1.cxx.

                                                {
    isTopFilterAcc( *this ) = static_cast<int>(val);
    return;
  }

◆ setUniqueIdentifier()

void xAOD::CutBookkeeper_v1::setUniqueIdentifier ( unsigned int hash )

private

Set the uniqueIdentifier for this CutBookkeeper.

Definition at line 148 of file CutBookkeeper_v1.cxx.

                                                                            {
    uniqueIdentifierAcc( *this ) = uniqueIdentifier;
    return;
  }

◆ setUsedOthers()

void xAOD::CutBookkeeper_v1::setUsedOthers ( const std::vector< CutBookkeeper_v1 * > & usedOthers )

Set all CutBookkeeper that are used by this one in one go.

Definition at line 535 of file CutBookkeeper_v1.cxx.

                                                                                    {
    othersLinksAcc(*this).clear();
    return this->addUsedOthers(usedOthers);
  }

◆ sibling()

const xAOD::CutBookkeeper_v1 * xAOD::CutBookkeeper_v1::sibling ( std::size_t i ) const

Get the sibling number i.

Definition at line 608 of file CutBookkeeper_v1.cxx.

                                                                           {
    if ( i >= siblingsLinksAcc(*this).size() ) {
      throw std::runtime_error( "ERROR: Got an index out of the range of sibling CutBookkeepers" );
    }
    const xAOD::CutBookkeeperLink_t& tmpLink = siblingsLinksAcc(*this).at(i);
    if ( !(tmpLink.isValid()) ) {
      throw std::runtime_error( "ERROR: Got an invalid sibling CutBookkeeper" );
    }
    const xAOD::CutBookkeeper_v1* tmpBK = *tmpLink;
    return tmpBK;
  }

◆ sumOfEventWeights()

double xAOD::CutBookkeeper_v1::sumOfEventWeights ( ) const

Get the sum-of-event-weights that this CutBookkeeper has seen.

Definition at line 309 of file CutBookkeeper_v1.cxx.

                                                   {
    return sumOfEventWeightsAcc(*this);
  }

◆ sumOfEventWeightsSquared()

double xAOD::CutBookkeeper_v1::sumOfEventWeightsSquared ( ) const

Get the sum-of-(event-weights-squared) that this CutBookkeeper has seen.

Definition at line 327 of file CutBookkeeper_v1.cxx.

                                                          {
    return sumOfEventWeightsSquaredAcc(*this);
  }

◆ toPersistent()

void xAOD::CutBookkeeper_v1::toPersistent ( )

Function preparing the object to be persistified.

Definition at line 670 of file CutBookkeeper_v1.cxx.

                                      {
    if( parentLinkAcc.isAvailableWritable(*this) ) {
      parentLinkAcc(*this).toPersistent();
    }
    if( childrenLinksAcc.isAvailableWritable(*this) ) {
      xAOD::CutBookkeeperLinks_t::iterator itr    = childrenLinksAcc(*this).begin();
      xAOD::CutBookkeeperLinks_t::iterator itrEnd = childrenLinksAcc(*this).end();
      for( ; itr != itrEnd; ++itr ) {
        itr->toPersistent();
      }
    }
    if( othersLinksAcc.isAvailableWritable(*this) ) {
      xAOD::CutBookkeeperLinks_t::iterator itr    = othersLinksAcc(*this).begin();
      xAOD::CutBookkeeperLinks_t::iterator itrEnd = othersLinksAcc(*this).end();
      for( ; itr != itrEnd; ++itr ) {
        itr->toPersistent();
      }
    }
    if( siblingsLinksAcc.isAvailableWritable(*this) ) {
      xAOD::CutBookkeeperLinks_t::iterator itr    = siblingsLinksAcc(*this).begin();
      xAOD::CutBookkeeperLinks_t::iterator itrEnd = siblingsLinksAcc(*this).end();
      for( ; itr != itrEnd; ++itr ) {
        itr->toPersistent();
      }
    }
    return;
  }

◆ uniqueIdentifier()

unsigned int xAOD::CutBookkeeper_v1::uniqueIdentifier ( ) const

Get the uniqueIdentifier for this CutBookkeeper.

Definition at line 144 of file CutBookkeeper_v1.cxx.

                                                        {
    return uniqueIdentifierAcc(*this);
  }

◆ usedOther()

const xAOD::CutBookkeeper_v1 * xAOD::CutBookkeeper_v1::usedOther ( std::size_t i ) const

Get the usedOther at position i.

Definition at line 521 of file CutBookkeeper_v1.cxx.

                                                                             {
    if ( i >= othersLinksAcc(*this).size() ) {
      throw std::runtime_error( "ERROR: Got an index out of the range of usedOthers CutBookkeepers" );
    }
    const xAOD::CutBookkeeperLink_t& tmpLink = othersLinksAcc(*this).at(i);
    if ( !(tmpLink.isValid()) ) {
      throw std::runtime_error( "ERROR: Got an invalid usedOther CutBookkeeper" );
    }
    const xAOD::CutBookkeeper_v1* tmpBK = *tmpLink;
    return tmpBK;
  }

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

Classes

Public Types

Public Member Functions

Getters and setters for the (sort of) 'static' information of the CutBookkeeper