In This Package:

GenPruneTool Class Reference

#include <GenPruneTool.h>

Inheritance diagram for GenPruneTool:

[legend]Collaboration diagram for GenPruneTool:[legend]List of all members.

Public Types
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
enum	Status
Public Member Functions
	GenPruneTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~GenPruneTool ()
StatusCode	prune (DayaBay::GenHeader *genHeader)
	Modify the event.
StatusCode	setMaxVertices (int MaxVertices)
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
INTupleSvc *	ntupleSvc () const
INTupleSvc *	evtColSvc () const
IDataProviderSvc *	detSvc () const
IDataProviderSvc *	evtSvc () const
IIncidentSvc *	incSvc () const
IChronoStatSvc *	chronoSvc () const
IHistogramSvc *	histoSvc () const
IAlgContextSvc *	contextSvc () const
DataObject *	put (IDataProviderSvc *svc, DataObject *object, const std::string &address, const bool useRootInTES=true) const
DataObject *	put (DataObject *object, const std::string &address, const bool useRootInTES=true) const
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
Gaudi::Utils::GetData< TYPE >::return_type	get (const std::string &location, const bool useRootInTES=true) const
TYPE *	getDet (IDataProviderSvc *svc, const std::string &location) const
TYPE *	getDet (const std::string &location) const
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
bool	exist (const std::string &location, const bool useRootInTES=true) const
bool	existDet (IDataProviderSvc *svc, const std::string &location) const
bool	existDet (const std::string &location) const
TYPE *	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
TYPE *	getOrCreate (const std::string &location, const bool useRootInTES=true) const
TOOL *	tool (const std::string &type, const std::string &name, const IInterface *parent=0, bool create=true) const
TOOL *	tool (const std::string &type, const IInterface *parent=0, bool create=true) const
SERVICE *	svc (const std::string &name, const bool create=true) const
IUpdateManagerSvc *	updMgrSvc () const
IDataProviderSvc *	fastContainersSvc () const
StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
StatusCode	Print (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const
StatusCode	Assert (const bool ok, const std::string &message="", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
StatusCode	Assert (const bool ok, const char *message, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
StatusCode	Exception (const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
StatusCode	Exception (const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
StatusCode	Exception (const std::string &msg="no message", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
MsgStream &	msgStream (const MSG::Level level) const
MsgStream &	always () const
MsgStream &	fatal () const
MsgStream &	err () const
MsgStream &	error () const
MsgStream &	warning () const
MsgStream &	info () const
MsgStream &	debug () const
MsgStream &	verbose () const
MsgStream &	msg () const
const Statistics &	counters () const
StatEntity &	counter (const std::string &tag) const
MSG::Level	msgLevel () const
bool	msgLevel (const MSG::Level level) const
void	resetMsgStream () const
bool	typePrint () const
bool	propsPrint () const
bool	statPrint () const
bool	errorsPrint () const
long	printStat (const MSG::Level level=MSG::ALWAYS) const
long	printErrors (const MSG::Level level=MSG::ALWAYS) const
long	printProps (const MSG::Level level=MSG::ALWAYS) const
void	registerCondition (const std::string &condition, StatusCode(CallerClass::*mf)()=NULL)
void	registerCondition (const std::string &condition, CondType *&condPtrDest, StatusCode(CallerClass::*mf)()=NULL)
void	registerCondition (char *condition, StatusCode(CallerClass::*mf)()=NULL)
void	registerCondition (TargetClass *condition, StatusCode(CallerClass::*mf)()=NULL)
StatusCode	runUpdate ()
TransientFastContainer< T > *	getFastContainer (const std::string &location, typename TransientFastContainer< T >::size_type initial=0)
StatusCode	release (const IInterface *interface) const
virtual unsigned long	release ()
const std::string &	context () const
const std::string &	rootInTES () const
double	globalTimeOffset () const
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvUnknown)
virtual unsigned long	addRef ()
virtual const std::string &	name () const
virtual const std::string &	type () const
virtual const IInterface *	parent () const
virtual StatusCode	configure ()
virtual StatusCode	start ()
virtual StatusCode	stop ()
virtual StatusCode	terminate ()
virtual StatusCode	reinitialize ()
virtual StatusCode	restart ()
virtual Gaudi::StateMachine::State	FSMState () const
virtual Gaudi::StateMachine::State	targetFSMState () const
virtual StatusCode	sysInitialize ()
virtual StatusCode	sysStart ()
virtual StatusCode	sysStop ()
virtual StatusCode	sysFinalize ()
virtual StatusCode	sysReinitialize ()
virtual StatusCode	sysRestart ()
virtual StatusCode	setProperty (const Property &p)
virtual StatusCode	setProperty (const std::string &s)
virtual StatusCode	setProperty (const std::string &n, const std::string &v)
StatusCode	setProperty (const std::string &name, const TYPE &value)
virtual StatusCode	getProperty (Property *p) const
virtual const Property &	getProperty (const std::string &name) const
virtual StatusCode	getProperty (const std::string &n, std::string &v) const
virtual const std::vector< Property * > &	getProperties () const
PropertyMgr *	getPropertyMgr ()
ISvcLocator *	serviceLocator () const
ISvcLocator *	svcLoc () const
IMessageSvc *	msgSvc () const
IToolSvc *	toolSvc () const
StatusCode	setProperties ()
StatusCode	service (const std::string &name, T *&svc, bool createIf=true) const
StatusCode	service (const std::string &type, const std::string &name, T *&svc) const
void	declInterface (const InterfaceID &, void *)
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
IAuditorSvc *	auditorSvc () const
IMonitorSvc *	monitorSvc () const
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
virtual const std::string &	type () const =0
virtual const IInterface *	parent () const =0
virtual StatusCode	configure ()=0
virtual StatusCode	start ()=0
virtual StatusCode	stop ()=0
virtual StatusCode	terminate ()=0
virtual StatusCode	reinitialize ()=0
virtual StatusCode	restart ()=0
virtual Gaudi::StateMachine::State	FSMState () const =0
virtual StatusCode	sysInitialize ()=0
virtual StatusCode	sysStart ()=0
virtual StatusCode	sysStop ()=0
virtual StatusCode	sysFinalize ()=0
virtual StatusCode	sysReinitialize ()=0
virtual StatusCode	sysRestart ()=0
virtual unsigned long	refCount () const =0
virtual const std::string &	name () const =0
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)=0
virtual unsigned long	addRef ()=0
virtual unsigned long	release ()=0
Static Public Member Functions
static const InterfaceID &	interfaceID ()
static const InterfaceID &	interfaceID ()
static const InterfaceID &	interfaceID ()
static const InterfaceID &	interfaceID ()
	Retrieve interface ID.
Public Attributes
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
Protected Types
typedef std::map< std::string, StatEntity >	Statistics
typedef std::map< std::string, unsigned int >	Counter
typedef std::vector< IAlgTool * >	AlgTools
typedef std::pair< IInterface *, std::string >	ServiceEntry
typedef std::vector< ServiceEntry >	Services
Protected Member Functions
StatusCode	releaseTool (const IAlgTool *tool) const
StatusCode	releaseSvc (const IInterface *svc) const
int	outputLevel () const
virtual unsigned long	refCount () const
IntegerProperty &	outputLevelProperty ()
void	initOutputLevel (Property &prop)
Static Protected Attributes
static const bool	IgnoreRootInTES
static const bool	UseRootInTES
Private Attributes
int	m_maxVertices
	Property: MaxVertices.

---

Detailed Description

Definition at line 16 of file GenPruneTool.h.

---

Constructor & Destructor Documentation

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

Definition at line 7 of file GenPruneTool.cc.

    : GaudiTool(type,name,parent)
{
  declareInterface< IGenPruneTool >(this) ;

  declareProperty("MaxVertices", m_maxVertices = -1,
                  "Negative: no touch. Otherwise, the number of vertices must be <= the MaxVertices");
}

GenPruneTool::~GenPruneTool

(

)

[virtual]

Definition at line 18 of file GenPruneTool.cc.

{}

---

Member Function Documentation

StatusCode GenPruneTool::prune

(

DayaBay::GenHeader *

genHeader

)

[virtual]

Modify the event.

Implements IGenPruneTool.

Definition at line 32 of file GenPruneTool.cc.

{
  if (m_maxVertices < 0) return StatusCode::SUCCESS;

  HepMC::GenEvent* event = genHeader->event();
  if (!event) {
    debug() << "GenHeader has null event, my work here is already done" << endreq;
    return StatusCode::SUCCESS;
  }

  int nverts = genHeader->event()->vertices_size();
  if (nverts <= m_maxVertices) {
    debug() << "GenHeader has " << nverts << " <= " << m_maxVertices
            << ", my work here is already done."
            << endreq;
    return StatusCode::SUCCESS;
  }

  genHeader->setEvent(0);
  debug() << "nullified GenHeader's event pointer" << endreq;
  return StatusCode::SUCCESS;
}

StatusCode GenPruneTool::setMaxVertices

(

int

MaxVertices

)

[inline, virtual]

Implements IGenPruneTool.

Definition at line 29 of file GenPruneTool.h.

                                               {
      m_maxVertices = MaxVertices;
      return StatusCode::SUCCESS;
    }

StatusCode GenPruneTool::initialize

(

)

[virtual]

Reimplemented from GaudiTool.

Definition at line 21 of file GenPruneTool.cc.

{
  return StatusCode::SUCCESS;
}

StatusCode GenPruneTool::finalize

(

)

[virtual]

Reimplemented from GaudiTool.

Definition at line 26 of file GenPruneTool.cc.

{
  return StatusCode::SUCCESS;
}

const InterfaceID & IGenPruneTool::interfaceID

(

)

[static, inherited]

Retrieve interface ID.

Reimplemented from IAlgTool.

Definition at line 8 of file IGenPruneTool.cc.

{
  return IID_IGenPruneTool;
}

---

Member Data Documentation

int GenPruneTool::m_maxVertices [private]

Property: MaxVertices.

The maximum number of vertices allowed to remain in the GenEvent. A value less than zero will be interpreted as to not touch the data. For non-negative values, if the number of vertices are less than or equal to the MaxVertices the GenHeader is left along, otherwise the GenEvent is deleted and GenHeader's pointer to GenEvent is zeroed.

Definition at line 47 of file GenPruneTool.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DybTool/src/components/GenPruneTool.h
• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DybTool/src/components/GenPruneTool.cc

---