xAOD::CutBookkeeper_v1 Class Reference

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...
using	TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor
template<class T , class ALLOC = AuxAllocator_t<T>>
using	ConstAccessor = SG::ConstAccessor< T, ALLOC >
template<class T , class ALLOC = AuxAllocator_t<T>>
using	Accessor = SG::Accessor< T, ALLOC >
template<class T , class ALLOC = AuxAllocator_t<T>>
using	Decorator = SG::Decorator< T, ALLOC >

Public Member Functions
	CutBookkeeper_v1 ()
	Constructor. More...
	~CutBookkeeper_v1 ()
	Destructor. More...
bool	operator== (const CutBookkeeper_v1 &rhs)
	Equality operator. More...
bool	isEqualTo (const CutBookkeeper_v1 *eb) const
	Test for the equality of this CutBookkeeper with another one. More...
void	toPersistent ()
	Function preparing the object to be persistified. More...
const SG::AuxVectorData *	container () const
	Return the container holding this element. More...
SG::AuxVectorData *	container ()
	Return the container holding this element. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name)
	Fetch an aux data variable, as a non-const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name, const std::string &clsname)
	Fetch an aux data variable, as a non-const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for reading. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference. More...
void	makePrivateStore ()
	Create a new (empty) private store for this object. More...
template<class U1 >
void	makePrivateStore (const U1 &other)
	Create a new private store for this object and copy aux data. More...
template<class U1 >
void	makePrivateStore (const U1 *other)
	Create a new private store for this object and copy aux data. More...
void	releasePrivateStore ()
	Release and free any private store associated with this object. More...
void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...
void	setStore (SG::IAuxStore *store)
	Set the store associated with this object. More...
void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object. More...
void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for setStore with IConstAuxStore. More...
void	setNonConstStore (SG::IAuxStore *store)
	Synonym for setStore with IAuxStore. More...
bool	usingPrivateStore () const
	Test to see if this object is currently using a private store. More...
bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store. More...
const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface. More...
SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface. More...
void	clearCache ()
	Clear the cached aux data pointers. More...
const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object. More...
bool	hasStore () const
	Return true if this object has an associated store. More...
bool	hasNonConstStore () const
	Return true if this object has an associated non-const store. More...
bool	clearDecorations () const
	Clear all decorations. More...
bool	trackIndices () const
	Return true if index tracking is enabled for this object. More...
size_t	index () const
	Return the index of this element within its container. More...
size_t	index () const
	Return the index of this element within its container. More...
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. More...
void	setPayload (const Payload &payload)
	Set the whole payload object (which contains all counters) in one go. More...
uint64_t	nAcceptedEvents () const
	Get the number of accepted events that this CutBookkeeper has seen. More...
void	setNAcceptedEvents (uint64_t nEvents)
	Set the number of accepted events for this CutBookkeeper. More...
void	addNAcceptedEvents (uint64_t nEvents)
	Add seen events to the number of accepted events that this CutBookkeeper has seen. More...
double	sumOfEventWeights () const
	Get the sum-of-event-weights that this CutBookkeeper has seen. More...
void	setSumOfEventWeights (double nWeightedEvents)
	Set the sum-of-event-weights that this CutBookkeeper has seen. More...
void	addSumOfEventWeights (double nWeightedEvents)
	Add more sum-of-event-weights that this CutBookkeeper has seen. More...
double	sumOfEventWeightsSquared () const
	Get the sum-of-(event-weights-squared) that this CutBookkeeper has seen. More...
void	setSumOfEventWeightsSquared (double nWeightedEventsSquared)
	Set the sum-of-(event-weights-squared) that this CutBookkeeper has seen. More...
void	addSumOfEventWeightsSquared (double nWeightedEventsSquared)
	Add more sum-of-(event-weights-squared) that this CutBookkeeper has seen. More...
Handling of the child-parent relationship between different CutBookkeepers
bool	hasParent () const
	Check if there is a parent CutBookkeeper of this CutBookkeeper. More...
const xAOD::CutBookkeeper_v1 *	parent () const
	Get the parent CutBookkeeper. More...
void	setParent (const CutBookkeeper_v1 *parentEB)
	Set the parent CutBookkeeper of this CutBookkeeper. More...
std::size_t	nChildren () const
	Get the number of children CutBookkeepers of this CutBookkeeper. More...
bool	hasChild (const xAOD::CutBookkeeper_v1 *testCBK) const
	Test if a given child already exists. More...
const xAOD::CutBookkeeper_v1 *	child (std::size_t i) const
	Get the child at position i. More...
void	setChildren (const std::vector< CutBookkeeper_v1 * > &childrenEB)
	Set all children of this CutBookkeeper in one go. More...
void	addChildren (const std::vector< CutBookkeeper_v1 * > &childrenEB)
	Add multiple children in one go to this CutBookkeeper. More...
void	addChild (CutBookkeeper_v1 *childEB)
	Add one child to this CutBookkeeper. More...
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. More...
Handling of the usage of other CutBookkeepers by this one
std::size_t	nUsedOthers () const
	Check if this CutBookkeeper has used others. More...
bool	hasUsedOther (const xAOD::CutBookkeeper_v1 *testCBK) const
	Check if this CutBookkeeper has used others. More...
const xAOD::CutBookkeeper_v1 *	usedOther (std::size_t i) const
	Get the usedOther at position i. More...
void	setUsedOthers (const std::vector< CutBookkeeper_v1 * > &usedOthers)
	Set all CutBookkeeper that are used by this one in one go. More...
void	addUsedOthers (const std::vector< CutBookkeeper_v1 * > &usedOthers)
	Add multiple children in one go to this CutBookkeeper. More...
void	addUsedOther (CutBookkeeper_v1 *usedOtherEB)
	Add one other CutBookkeeper that is used by this one. More...
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. More...
bool	hasSibling (const xAOD::CutBookkeeper_v1 *testCBK) const
	Test if the provided CutBookkeeper is already a sibling. More...
const xAOD::CutBookkeeper_v1 *	sibling (std::size_t i) const
	Get the sibling number i. More...
void	setSiblings (const std::vector< CutBookkeeper_v1 * > &siblings)
	Set all CutBookkeeper that are siblings to this one in one go. More...
void	addSiblings (const std::vector< CutBookkeeper_v1 * > &siblings)
	Add multiple siblings in one go to this CutBookkeeper. More...
void	addSibling (CutBookkeeper_v1 *siblingsEB)
	Add one sibling CutBookkeeper to this one. More...

Static Public Attributes
static constexpr bool	supportsThinning = true
	Mark that this type supports thinning operations. More...

Protected Member Functions
bool	noPrivateData () const
	True if this element has no private data. More...
bool	havePrivateData () const
	True if this element currently has private data. More...
bool	hadPrivateData () const
	True if this element had private data before it was added to its current container. More...

Private Types
enum	PrivateStoreState : uint8_t { PrivateStoreState::NO_PRIVATE = 0, PrivateStoreState::HAVE_PRIVATE = 1, PrivateStoreState::HAD_PRIVATE = 2 }
	The current private data state. More...

Private Member Functions
void	releasePrivateStoreForDtor ()
	Out-of-line portion of destructor. More...
void	setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...
bool	setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...
void	makePrivateStore1 (const void *)
	Create a new private store for this object and copy aux data. More...
void	makePrivateStore1 (const AuxElement *other)
	Create a new private store for this object and copy aux data. More...
AuxElementStandaloneData *	setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...
void	clearAux ()
	Clear all aux data associated with this element. More...
void	copyAux (const ConstAuxElement &other)
	Copy aux data from another object. More...
void	setNoPrivateData ()
	Record that this element does not have private data. More...
void	setHavePrivateData ()
	Record that this element currently has private data. More...
void	setHadPrivateData ()
	Record that this element used to have private data. More...

Private Attributes
const SG::AuxVectorData *	m_container
	The container of which this object is an element. More...
size_t	m_index
	The index of this element within its container. More...
PrivateStoreState	m_privateStoreState

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

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 Typedef Documentation

Accessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Accessor = SG::Accessor<T, ALLOC>

inherited

Definition at line 548 of file AuxElement.h.

ConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::ConstAccessor = SG::ConstAccessor<T, ALLOC>

inherited

Definition at line 545 of file AuxElement.h.

Decorator

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Decorator = SG::Decorator<T, ALLOC>

inherited

Definition at line 551 of file AuxElement.h.

TypelessConstAccessor

using SG::AuxElement::TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

inherited

Definition at line 542 of file AuxElement.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,
    };

PrivateStoreState

enum SG::IAuxElement::PrivateStoreState : uint8_t

strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE
HAVE_PRIVATE
HAD_PRIVATE

Definition at line 131 of file IAuxElement.h.

  {
    NO_PRIVATE = 0,
    HAVE_PRIVATE = 1,
    HAD_PRIVATE = 2,
  };

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.

                                      {
  }

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.

auxdata() [1/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string &  name )

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

auxdata() [2/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string &  name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

auxdata() [3/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string &  name, const std::string &  clsname  )

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

auxdata() [4/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string &  name, const std::string &  clsname  ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

auxdataConst() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string &  name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

auxdataConst() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string &  name, const std::string &  clsname  ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

auxdecor() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string &  name ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

auxdecor() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string &  name, const std::string &  clsname  ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

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;
  }

clearAux()

void SG::AuxElement::clearAux ( )

privateinherited

Clear all aux data associated with this element.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 535 of file AuxElement.cxx.

{
  if (!m_container) return;
  if (!m_container->hasStore()) return;
  if (!m_container->hasNonConstStore())
    throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
 
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
    r.clear (auxid, *container(), index(), 1);
  }
}

clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

You should call this any time something changes in the aux store that could invalidate the vector pointers.

Definition at line 319 of file AuxElement.cxx.

{
  if (container())
    container()->clearCache();
}

clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

Erase all decorations from an associated store, restoring the state to when lock was called.

Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.

Definition at line 385 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->clearDecorations();
  return false;
}

container() [1/2]

SG::AuxVectorData* SG::AuxElement::container ( )

inherited

Return the container holding this element.

container() [2/2]

const SG::AuxVectorData* SG::AuxElement::container ( ) const

inherited

Return the container holding this element.

copyAux()

void SG::AuxElement::copyAux ( const ConstAuxElement &  other )

privateinherited

Copy aux data from another object.

Parameters

other

The object from which to copy.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)

Definition at line 561 of file AuxElement.cxx.

{
  if (!m_container) return;
  if (!m_container->hasStore()) return;
  if (!m_container->hasNonConstStore())
    throw SG::ExcConstAuxData ("copyAux");
 
  const SG::AuxVectorData* ocont = other.container();
 
  if (!ocont || !ocont->hasStore()) {
    this->clearAux();
    return;
  }
 
  size_t oindex = other.index();
  SG::auxid_set_t other_ids = ocont->getAuxIDs();
 
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
 
  SG::AuxVectorData& cont = *container();
  for (SG::auxid_t auxid : other_ids) {
    if (!r.isLinked (auxid)) {
      r.copy (auxid, cont, index(), *ocont, oindex, 1);
    }
  }
 
  for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
    if (!other_ids.test (auxid)) {
      r.clear (auxid, cont, index(), 1);
    }
  }
}

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);
  }

getAuxIDs()

const SG::auxid_set_t & SG::AuxElement::getAuxIDs ( ) const

inherited

Return a set of identifiers for existing data items for this object.

If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.

Definition at line 335 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData())
    return m_container->getConstStore()->getAuxIDs();
  if (container())
    return container()->getAuxIDs();
  static const SG::auxid_set_t null_set;
  return null_set;
#else
  return ConstAuxElement::getAuxIDs();
#endif
}

getConstStore()

const SG::IConstAuxStore * SG::AuxElement::getConstStore ( ) const

inherited

Return the current store, as a const interface.

This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 284 of file AuxElement.cxx.

{
  if (havePrivateData()) {
    return m_container->getConstStore();
  }
  return 0;
}

getStore()

SG::IAuxStore * SG::AuxElement::getStore ( ) const

inherited

Return the current store, as a non-const interface.

This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 299 of file AuxElement.cxx.

{
  if (havePrivateData()) {
#ifdef ATHCONTAINERS_R21_COMPAT
    SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
#else
    SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
#endif
    return container_nc->getStore();
  }
  return 0;
}

hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

True if this element had private data before it was added to its current container.

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;
  }

hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

Return true if this object has an associated non-const store.

This will be true for either a private or standalone store.

Definition at line 368 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->hasNonConstStore();
  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;
  }

hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

This will be true for either a private or standalone store.

Definition at line 355 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->hasStore();
  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;
  }

havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

index() [1/2]

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

index() [2/2]

size_t SG::IAuxElement::index

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

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);
  }

isAvailable()

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailable ( const std::string &  name, const std::string &  clsname = ""  ) const

inherited

Check if an aux variable is available for reading.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

isAvailableWritable()

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritable ( const std::string &  name, const std::string &  clsname = ""  )

inherited

Check if an aux variable is available for writing.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

isAvailableWritableAsDecoration()

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritableAsDecoration ( const std::string &  name, const std::string &  clsname = ""  ) const

inherited

Check if an aux variable is available for writing as a decoration.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

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));
  }

makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

inherited

Create a new (empty) private store for this object.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

Definition at line 172 of file AuxElement.cxx.

{
  if (m_container) {
    throw SG::ExcBadPrivateStore ("store already exists");
  }
 
  m_container = new SG::AuxElementPrivateData;
  IAuxElement::setIndex (0);
  IAuxElement::setHavePrivateData();
}

makePrivateStore() [2/3]

template<class U1 >

void SG::AuxElement::makePrivateStore ( const U1 &  other )

inherited

Create a new private store for this object and copy aux data.

Parameters

other

The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

makePrivateStore() [3/3]

template<class U1 >

void SG::AuxElement::makePrivateStore ( const U1 *  other )

inherited

Create a new private store for this object and copy aux data.

Parameters

other

The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

makePrivateStore1() [1/2]

void SG::AuxElement::makePrivateStore1 ( const AuxElement *  other )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other

The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does have aux data.

Definition at line 521 of file AuxElement.cxx.

{
  makePrivateStore();
  if (other)
    this->copyAux (*other);
}

makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1 ( const void *  )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other

The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does not have aux data.

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();
  }

noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

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;
  }

releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )

inherited

Release and free any private store associated with this object.

ExcBadPrivateStore will be thrown if this object does not have a private store.

Definition at line 190 of file AuxElement.cxx.

{
  if (hadPrivateData()) {
    // We had a private store, but it was released because this object
    // was added to a container.  Just forget about it.
    IAuxElement::setNoPrivateData();
    return;
  }
 
  if (!havePrivateData() ||
      !m_container ||
      typeid(*m_container) != typeid(AuxElementPrivateData))
  {
    throw SG::ExcBadPrivateStore ("no private store exists");
  }
 
  IAuxElement::setIndex (0);
  IAuxElement::setNoPrivateData();
  delete m_container;
  m_container = 0;
}

releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 398 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData()) {
    delete m_container;
  }
#else
  ConstAuxElement::releasePrivateStoreForDtor();
#endif
}

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);
  }

setConstStore()

void SG::AuxElement::setConstStore ( const SG::IConstAuxStore *  store )

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store

The new store.

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;
  }

setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

setIndex()

void SG::AuxElement::setIndex ( size_t  index, SG::AuxVectorData *  container  )

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.

setIndexPrivate()

bool SG::AuxElement::setIndexPrivate ( size_t  index, SG::AuxVectorData *  container  )

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

This is called from setIndex when we have a private store to deal with.

Definition at line 462 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (hadPrivateData()) {
    // We had a private store, but it was released because we were added
    // to a container.
 
    if (container == 0) {
      // We're being moved out of the container.  Make a new private
      // store, copy the data, and switch to it.
      auto privateData = new SG::AuxElementPrivateData;
      AuxElement to (privateData, 0);
      to.copyAux (*this);
      IAuxElement::setIndex (0);
      IAuxElement::setHavePrivateData();
      m_container = privateData;
      return true;
    }
  }
  else if (havePrivateData() &&
           typeid(*m_container) == typeid(AuxElementPrivateData))
  {
    // We currently have a private store.
 
    if (container != 0 && container != m_container) {
      // We're being added to a container.
      // Aux data has already been copied.
      // Release private store.
      IAuxElement::setIndex (index);
      IAuxElement::setHadPrivateData();
      delete m_container;
      m_container = container;
      return false;
    }
  }
  else {
    // We have a standalone store.
    throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
                                  "from a container.");
  }
 
  IAuxElement::setIndex (index);
  m_container = container;
  return false;
#else
  return ConstAuxElement::setIndexPrivate (index, container);
#endif
}

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;
  }

setNonConstStore()

void SG::AuxElement::setNonConstStore ( SG::IAuxStore *  store )

inherited

Synonym for setStore with IAuxStore.

Parameters

store

The new store.

setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )

privateinherited

Record that this element does not have private data.

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);
  }

setStore() [1/3]

void SG::AuxElement::setStore ( const DataLink< SG::IConstAuxStore > &  store )

inherited

Set the store associated with this object.

Parameters

store

The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Parameters

store

Link to the new store.

Definition at line 249 of file AuxElement.cxx.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

setStore() [2/3]

void SG::AuxElement::setStore ( const SG::IConstAuxStore *  store )

inherited

Set the store associated with this object.

Parameters

store

The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 221 of file AuxElement.cxx.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

setStore() [3/3]

void SG::AuxElement::setStore ( SG::IAuxStore *  store )

inherited

Set the store associated with this object.

Parameters

store

The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 237 of file AuxElement.cxx.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

setStore1()

AuxElementStandaloneData * SG::AuxElement::setStore1 ( const SG::IConstAuxStore *  store )

privateinherited

Set the store associated with this object.

Parameters

store

The new store.

Helper for setStore. Creates the AuxElementStandaloneData object if needed and returns it.

Parameters

store

The new store.

Helper for setStore. Creates the @x AuxElementStandaloneData object if needed and returns it.

Definition at line 418 of file AuxElement.cxx.

{
  if (store) {
    // Want this object be standalone.
    if (!m_container) {
      // Not in a container (and no private store).  Make a new object.
      AuxElementStandaloneData* data = new AuxElementStandaloneData;
      IAuxElement::setHavePrivateData();
      m_container = data;
      return data;
    }
    if (usingStandaloneStore()) {
      // Standalone --- return existing object.
      return static_cast<AuxElementStandaloneData*> (container());
    }
    // Otherwise, it's an error.
    throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
                              "object in a container or with a private store.");
  }
 
  else {
    // Getting rid of a standalone store.
    if (usingStandaloneStore()) {
      IAuxElement::setNoPrivateData();
      delete m_container;
      m_container = 0;
    }
    else if (m_container != 0)
      throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
                                "object in a container or with a private store.");
    return 0;
  }
}

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;
  }

trackIndices()

bool SG::AuxElement::trackIndices ( ) const

inherited

Return true if index tracking is enabled for this object.

Always returns true. Included here to be consistent with AuxVectorBase when standalone objects may be used as template parameters.

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;
  }

usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

Test to see if this object is currently using a private store.

Definition at line 260 of file AuxElement.cxx.

{
  return havePrivateData() && 
    typeid(*m_container) == typeid(AuxElementPrivateData);
}

usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

Test to see if this object is currently using a standalone store.

Test to see if this object is currently using a private store.

Definition at line 270 of file AuxElement.cxx.

{
  return havePrivateData() &&
    typeid(*m_container) == typeid(AuxElementStandaloneData);
}

Member Data Documentation

m_container

const SG::AuxVectorData* SG::ConstAuxElement::m_container

privateinherited

The container of which this object is an element.

Should be null if this object is not within a container, except that it may also point at a private store.

Definition at line 324 of file AuxElement.h.

m_index

size_t SG::IAuxElement::m_index

privateinherited

The index of this element within its container.

Should be 0 if this object is not within a container.

Definition at line 128 of file IAuxElement.h.

m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

supportsThinning

constexpr bool SG::AuxElement::supportsThinning = true

staticconstexprinherited

Mark that this type supports thinning operations.

See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.

Definition at line 920 of file AuxElement.h.

---

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

• CutBookkeeper_v1.h
• CutBookkeeper_v1.cxx