PileUpXingFolder Class Reference

specify time interval we want to study pileup for a set of data objs More...

#include <PileUpXingFolder.h>

Inheritance diagram for PileUpXingFolder:

Collaboration diagram for PileUpXingFolder:

Public Member Functions
access folder items
virtual const_iterator	begin () const
virtual const_iterator	end () const
define and access xing range for dobjs in this folder. No data should be returned for xings outside this range
void	setXings (int firstXing, int lastXing)
int	firstXing () const
int	lastXing () const
float	cacheRefreshFrequency () const
	controls the rate at which we clear data objs in this folder at the end of event More...
bool	contains (int iCrossing) const
	is iCrossing in the xing range? More...

Private Attributes
Properties
ToolHandle< SG::IFolder >	m_folder
Gaudi::Property< int >	m_firstXing
Gaudi::Property< int >	m_lastXing
Gaudi::Property< std::vector< std::string > >	m_itemList
	this must match SG::Folder::m_itemList More...
Gaudi::CheckedProperty< double >	m_cacheRefreshFrequency
	Bound property [0.0, 1.0]: frequency with which data objs in this folder should be cleared from bkg caches at end of event. More...

structors and AlgTool implementation
typedef IPileUpXingFolder::const_iterator	const_iterator
	PileUpXingFolder (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize ()

Detailed Description

specify time interval we want to study pileup for a set of data objs

Typically this will be the sensitive time of a detector read-out system. Implemented as SG::Folder with an attached bunch crossing interval

Definition at line 22 of file PileUpXingFolder.h.

Member Typedef Documentation

const_iterator

typedef IPileUpXingFolder::const_iterator PileUpXingFolder::const_iterator

Definition at line 32 of file PileUpXingFolder.h.

Constructor & Destructor Documentation

PileUpXingFolder()

PileUpXingFolder::PileUpXingFolder	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 8 of file PileUpXingFolder.cxx.

                                                              :
  base_class(type, name, parent),
  m_folder( "SG::Folder/SGF", this ),
  m_firstXing(-999),
  m_lastXing(999),
  m_itemList(),
  m_cacheRefreshFrequency(0.0)
{
  declareProperty("FirstXing", m_firstXing);
  declareProperty("LastXing", m_lastXing);
  declareProperty("ItemList", m_itemList);
  m_cacheRefreshFrequency.verifier().setBounds(0.0, 1.0);
  declareProperty("CacheRefreshFrequency", m_cacheRefreshFrequency,
                  "frequency with which data objs in this folder should be cleared from bkg caches at end of event. Default 0 (never clear), range [0.0, 1.0]");
}

Member Function Documentation

begin()

virtual const_iterator PileUpXingFolder::begin ( ) const

inlinevirtual

Definition at line 35 of file PileUpXingFolder.h.

{ return m_folder->begin(); }

cacheRefreshFrequency()

float PileUpXingFolder::cacheRefreshFrequency ( ) const

inline

controls the rate at which we clear data objs in this folder at the end of event

Definition at line 56 of file PileUpXingFolder.h.

{return m_cacheRefreshFrequency.value();}

contains()

bool PileUpXingFolder::contains ( int  iCrossing ) const

inline

is iCrossing in the xing range?

Definition at line 60 of file PileUpXingFolder.h.

                                     {
    return firstXing() <= iCrossing && iCrossing <= lastXing();
  }

end()

virtual const_iterator PileUpXingFolder::end ( ) const

inlinevirtual

Definition at line 36 of file PileUpXingFolder.h.

{ return m_folder->end(); }

firstXing()

int PileUpXingFolder::firstXing ( ) const

inline

Definition at line 52 of file PileUpXingFolder.h.

{ return m_firstXing.value(); }

initialize()

StatusCode PileUpXingFolder::initialize ( )

virtual

Definition at line 26 of file PileUpXingFolder.cxx.

                                        {
  if (!(m_folder.retrieve()).isSuccess()) return StatusCode::FAILURE;
  return (dynamic_cast<IProperty&>(*m_folder)).setProperty(m_itemList);
}

lastXing()

int PileUpXingFolder::lastXing ( ) const

inline

Definition at line 53 of file PileUpXingFolder.h.

{ return m_lastXing.value(); }

setXings()

void PileUpXingFolder::setXings ( int  firstXing, int  lastXing  )

inline

Definition at line 49 of file PileUpXingFolder.h.

                                             {
    m_firstXing.setValue(firstXing); m_lastXing.setValue(lastXing);
  } 

Member Data Documentation

m_cacheRefreshFrequency

Gaudi::CheckedProperty<double> PileUpXingFolder::m_cacheRefreshFrequency

private

Bound property [0.0, 1.0]: frequency with which data objs in this folder should be cleared from bkg caches at end of event.

Default 0 (never clear)

Definition at line 73 of file PileUpXingFolder.h.

m_firstXing

Gaudi::Property<int> PileUpXingFolder::m_firstXing

private

Definition at line 68 of file PileUpXingFolder.h.

m_folder

ToolHandle<SG::IFolder> PileUpXingFolder::m_folder

private

Definition at line 67 of file PileUpXingFolder.h.

m_itemList

Gaudi::Property<std::vector<std::string> > PileUpXingFolder::m_itemList

private

this must match SG::Folder::m_itemList

Definition at line 70 of file PileUpXingFolder.h.

m_lastXing

Gaudi::Property<int> PileUpXingFolder::m_lastXing

private

Definition at line 69 of file PileUpXingFolder.h.

---

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

• PileUpXingFolder.h
• PileUpXingFolder.cxx