In This Package:

Prescaler Class Reference

#include <Prescaler.h>

Inheritance diagram for Prescaler:

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


Public Types
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
enum	Status
Public Member Functions
	Prescaler (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor(s).
	~Prescaler ()
	Destructor.
StatusCode	initialize ()
	standard initialization method
StatusCode	execute ()
	standard execution method
StatusCode	finalize ()
	standard finalization method
virtual StatusCode	sysExecute ()
	the generic actions for the execution.
void	put (IDataProviderSvc svc, DataObject object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store.
void	put (DataObject *object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store.
template<class TYPE>
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store.
template<class TYPE>
Gaudi::Utils::GetData< TYPE >::return_type	get (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data from Gaudi Event Transient Store.
template<class TYPE>
TYPE *	getDet (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store.
template<class TYPE>
TYPE *	getDet (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store.
template<class TYPE>
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store.
template<class TYPE>
bool	exist (const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store.
template<class TYPE>
bool	existDet (IDataProviderSvc *svc, const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store.
template<class TYPE>
bool	existDet (const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store.
template<class TYPE, class TYPE2>
TYPE *	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store.
template<class TYPE, class TYPE2>
TYPE *	getOrCreate (const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store.
bool	registerContext () const
	register for Algorithm Context Service ?
INTupleSvc *	evtColSvc () const
	Access the standard event collection service.
IAlgContextSvc *	contextSvc () const
	Access the standard Algorithm Context Service.
TOOL *	tool (const std::string &type, const std::string &name, const IInterface *parent=0, bool create=true) const
	Useful method for the easy location of tools.
TOOL *	tool (const std::string &type, const IInterface *parent=0, bool create=true) const
	A useful method for the easy location of tools.
SERVICE *	svc (const std::string &name, const bool create=true) const
	A useful method for the easy location of services.
IUpdateManagerSvc *	updMgrSvc () const
	Short-cut to locate the Update Manager Service.
IDataProviderSvc *	fastContainersSvc () const
	Short-cut to locate the Fast Containers Service.
StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the error message and return with the given StatusCode.
StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the warning message and return with the given StatusCode.
StatusCode	Print (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const
	Print the message and return with the given StatusCode.
StatusCode	Assert (const bool ok, const std::string &message="", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled.
StatusCode	Assert (const bool ok, const char *message, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled.
StatusCode	Exception (const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given GaudiException.
StatusCode	Exception (const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given exception.
StatusCode	Exception (const std::string &msg="no message", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and throw an exception with the given message.
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.
MsgStream &	always () const
	shortcut for the method msgStream ( MSG::ALWAYS )
MsgStream &	fatal () const
	shortcut for the method msgStream ( MSG::FATAL )
MsgStream &	err () const
	shortcut for the method msgStream ( MSG::ERROR )
MsgStream &	error () const
	shortcut for the method msgStream ( MSG::ERROR )
MsgStream &	warning () const
	shortcut for the method msgStream ( MSG::WARNING )
MsgStream &	info () const
	shortcut for the method msgStream ( MSG::INFO )
MsgStream &	debug () const
	shortcut for the method msgStream ( MSG::DEBUG )
MsgStream &	verbose () const
	shortcut for the method msgStream ( MSG::VERBOSE )
MsgStream &	msg () const
	shortcut for the method msgStream ( MSG::INFO )
const Statistics &	counters () const
	accessor to all counters
StatEntity &	counter (const std::string &tag) const
	accessor to certain counter by name
MSG::Level	msgLevel () const
	The current message service output level.
bool	msgLevel (const MSG::Level level) const
	Test the output level.
void	resetMsgStream () const
	Reset (delete) the current message stream object.
bool	typePrint () const
	Insert the actual C++ type of the algorithm/tool in the messages ?
bool	propsPrint () const
	Print properties at initalization ?
bool	statPrint () const
	Print statistical counters at finalization ?
bool	errorsPrint () const
	Print error counters at finalization ?
long	printStat (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of statistical counters
long	printErrors (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of error counters
long	printProps (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of properties
void	registerCondition (const std::string &condition, StatusCode(CallerClass::*mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition.
void	registerCondition (const std::string &condition, CondType &condPtrDest, StatusCode(CallerClass::mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition.
void	registerCondition (char condition, StatusCode(CallerClass::mf)()=NULL)
	just to avoid conflicts with the version using a pointer to a template class.
void	registerCondition (TargetClass condition, StatusCode(CallerClass::mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition.
StatusCode	runUpdate ()
	asks the UpdateManagerSvc to perform an update of the instance (if needed) without waiting the next BeginEvent incident.
TransientFastContainer< T > *	getFastContainer (const std::string &location, typename TransientFastContainer< T >::size_type initial=0)
	Return a new TransientFastContainer for objects of type T.
StatusCode	release (const IInterface *interface) const
	Manual forced (and 'safe') release of the active tool or service.
unsigned long	release ()
const std::string &	context () const
	Returns the "context" string. Used to indentify different processing states.
const std::string &	rootInTES () const
	Returns the "rootInTES" string.
double	globalTimeOffset () const
	Returns the "globalTimeOffset" double.
virtual StatusCode	sysStart ()
virtual StatusCode	sysInitialize ()
virtual StatusCode	sysReinitialize ()
virtual StatusCode	sysRestart ()
virtual StatusCode	sysStop ()
virtual StatusCode	sysFinalize ()
virtual StatusCode	sysBeginRun ()
virtual StatusCode	sysEndRun ()
virtual const std::string &	name () const
virtual const std::string &	version () const
virtual StatusCode	configure ()
virtual StatusCode	terminate ()
virtual StatusCode	start ()
virtual StatusCode	stop ()
virtual StatusCode	reinitialize ()
virtual StatusCode	restart ()
virtual bool	isExecuted () const
virtual void	setExecuted (bool state)
virtual void	resetExecuted ()
virtual StatusCode	beginRun ()
virtual StatusCode	endRun ()
virtual Gaudi::StateMachine::State	FSMState () const
virtual Gaudi::StateMachine::State	targetFSMState () const
virtual bool	isEnabled () const
virtual bool	filterPassed () const
virtual void	setFilterPassed (bool state)
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
void	setOutputLevel (int level)
IAuditorSvc *	auditorSvc () const
IChronoStatSvc *	chronoSvc () const
IChronoStatSvc *	chronoStatService () const
IDataProviderSvc *	detSvc () const
IDataProviderSvc *	detDataService () const
IConversionSvc *	detCnvSvc () const
IConversionSvc *	detDataCnvService () const
IDataProviderSvc *	eventSvc () const
IDataProviderSvc *	evtSvc () const
IDataProviderSvc *	eventDataService () const
IConversionSvc *	eventCnvSvc () const
IConversionSvc *	eventDataCnvService () const
IHistogramSvc *	histoSvc () const
IHistogramSvc *	histogramDataService () const
IMessageSvc *	msgSvc () const
IMessageSvc *	messageService () const
INTupleSvc *	ntupleSvc () const
INTupleSvc *	ntupleService () const
IRndmGenSvc *	randSvc () const
IToolSvc *	toolSvc () const
IExceptionSvc *	exceptionSvc () const
ISvcLocator *	serviceLocator () const
ISvcLocator *	svcLoc () const
StatusCode	createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
std::vector< Algorithm * > *	subAlgorithms () const
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
StatusCode	setProperties ()
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
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
unsigned long	addRef ()
StatusCode	queryInterface (const InterfaceID &riid, void **)
Static Public Member Functions
static const InterfaceID &	interfaceID ()
static const InterfaceID &	interfaceID ()
static const InterfaceID &	interfaceID ()
Public Attributes
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
Protected Types
typedef std::map< std::string, StatEntity >	Statistics
	the actual type of general counters
typedef std::map< std::string, unsigned int >	Counter
	the actual type error/warning counter
typedef std::vector< IAlgTool * >	AlgTools
	storage for active tools
typedef std::pair< IInterface *, std::string >	ServiceEntry
	Service pointer and name.
typedef std::vector< ServiceEntry >	Services
	storage for active services
Protected Member Functions
StatusCode	releaseTool (const IAlgTool *tool) const
	manual forced (and 'safe') release of the tool
StatusCode	releaseSvc (const IInterface *svc) const
	manual forced (and 'safe') release of the service
bool	isInitialized () const
bool	isFinalized () const
int	outputLevel () const
IntegerProperty &	outputLevelProperty ()
void	initOutputLevel (Property &prop)
Static Protected Attributes
static const bool	IgnoreRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods.
static const bool	UseRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods.
Private Attributes
DoubleProperty	m_percentPass
	Percentage of events that should be passed.
int	m_pass
	Number of events passed.
int	m_seen
	Number of events seen.

Detailed Description

Definition at line 5 of file Prescaler.h.

Member Typedef Documentation

typedef std::map<std::string,StatEntity> GaudiCommon< Algorithm >::Statistics [protected, inherited]

the actual type of general counters

Definition at line 83 of file GaudiCommon.h.

typedef std::map<std::string,unsigned int> GaudiCommon< Algorithm >::Counter [protected, inherited]

the actual type error/warning counter

Definition at line 85 of file GaudiCommon.h.

typedef std::vector<IAlgTool*> GaudiCommon< Algorithm >::AlgTools [protected, inherited]

storage for active tools

Definition at line 87 of file GaudiCommon.h.

typedef std::pair<IInterface*,std::string> GaudiCommon< Algorithm >::ServiceEntry [protected, inherited]

Service pointer and name.

Definition at line 89 of file GaudiCommon.h.

typedef std::vector<ServiceEntry> GaudiCommon< Algorithm >::Services [protected, inherited]

storage for active services

Definition at line 91 of file GaudiCommon.h.

Constructor & Destructor Documentation

Prescaler::Prescaler	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Constructor(s).

Definition at line 6 of file Prescaler.cpp.

00006                                                                     :
00007   GaudiAlgorithm(name, pSvcLocator) ,
00008   m_pass( 0 ),
00009   m_seen( 0 )
00010 {
00011   declareProperty( "PercentPass", m_percentPass=100.0 );
00012   m_percentPass.verifier().setBounds( 0.0, 100.0 );
00013 }

Prescaler::~Prescaler ( )

Destructor.

Definition at line 15 of file Prescaler.cpp.

00016 {
00017 }

Member Function Documentation

StatusCode Prescaler::initialize ( ) [virtual]

standard initialization method

See also:: Algorithm
IAlgorithm

Returns:: status code

Reimplemented from GaudiAlgorithm.

Definition at line 20 of file Prescaler.cpp.

00021 {
00022   const StatusCode sc = GaudiAlgorithm::initialize();
00023   if ( !sc) return sc;
00024 
00025   info() << name( ) << ":Prescaler::Initialize - pass: " << m_percentPass << endreq;
00026  
00027  return sc;
00028 }

StatusCode Prescaler::execute ( ) [virtual]

standard execution method

See also:: Algorithm
IAlgorithm

Returns:: status code

Reimplemented from GaudiAlgorithm.

Definition at line 31 of file Prescaler.cpp.

00032 {
00033   ++m_seen;
00034   float fraction = (float(100.0) * (float)(m_pass+1)) / (float)m_seen;
00035   if ( fraction > m_percentPass ) {
00036     setFilterPassed( false );
00037     info() << name() << ":Prescaler::execute - filter failed" << endreq;
00038   } else {
00039     info() << name() << ":Prescaler::execute - filter passed" << endreq;
00040     ++m_pass;
00041   }
00042   return StatusCode::SUCCESS;
00043 }

StatusCode Prescaler::finalize ( ) [virtual]

standard finalization method

See also:: Algorithm
IAlgorithm

Returns:: status code

Reimplemented from GaudiAlgorithm.

Definition at line 46 of file Prescaler.cpp.

00047 {
00048   info() << name( ) << ":Prescaler::finalize - total events: "
00049          << m_seen << ", passed events: " << m_pass << endreq;
00050   return GaudiAlgorithm::finalize();
00051 }

StatusCode GaudiAlgorithm::sysExecute ( ) [virtual, inherited]

the generic actions for the execution.

See also:

Algorithm

IAlgorithm

Algorithm::sysExecute

Returns:: status code

< guard/sentry

Reimplemented from Algorithm.

Definition at line 131 of file GaudiAlgorithm.cpp.

00132 {
00133   IAlgContextSvc* ctx = 0 ;
00134   if ( registerContext() ) { ctx = contextSvc() ; }
00135   // Lock the context 
00136   Gaudi::Utils::AlgContext cnt ( ctx , this ) ;  
00137 
00138   // Do not execute if one or more of the m_vetoObjs exist in TES
00139   for( std::vector<std::string>::iterator it  = m_vetoObjs.begin();
00140                                           it != m_vetoObjs.end(); it++ ) {
00141     if( exist<DataObject>(*it) ) {
00142       debug() << *it << " found, skipping event " << endmsg;
00143       return StatusCode::SUCCESS;
00144     }
00145   }
00146 
00147   // Execute if m_requireObjs is empty
00148   bool doIt = m_requireObjs.empty() ? true : false;
00149 
00150   // Execute also if one or more of the m_requireObjs exist in TES
00151   for( std::vector<std::string>::iterator it  = m_requireObjs.begin();
00152                                           it != m_requireObjs.end(); it++ ) {
00153     if( exist<DataObject>(*it) ) {
00154       doIt = true;
00155       break;
00156     }
00157   }
00158 
00159   if( doIt )
00160     // execute the generic method:
00161     return Algorithm::sysExecute() ;
00162   else
00163     return StatusCode::SUCCESS;
00164 }

void GaudiAlgorithm::put	(	IDataProviderSvc *	svc,
		DataObject *	object,
		const std::string &	address,
		const bool	useRootInTES = `true`
	)			const `[inline, inherited]`

  MCHits * hits = new MCHits();
  put( evtSvc(), hits, "/Event/MC/Hits" );

Attention:: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behaviour can be suppressed by passing the arguement useRootInTES = false

See also:: IDataProviderSvc

Parameters:

	svc	Pointer to data provider service
	object	Data object or container to be registered
	address	Address in Gaudi Event Transient Store ("/Event" could be omitted )
	useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Exceptions:

	GaudiException	for invalid event data service
	GaudiException	for invalid object
	GaudiException	for error result from event data service

Returns:: StatusCode

Return values:

	StatusCode::SUCCESS	Data was successfully placed in the TES.
	StatusCode::FAILURE	Failed to store data in the TES.

Reimplemented from GaudiCommon< Algorithm >.

Definition at line 170 of file GaudiAlgorithm.h.

00174   {
00175     GaudiCommon<Algorithm>::put ( svc , object , address , useRootInTES ) ;
00176   }

void GaudiAlgorithm::put	(	DataObject *	object,
		const std::string &	address,
		const bool	useRootInTES = `true`
	)			const `[inline, inherited]`

See also:: IDataProviderSvc

  MCHits * hits = new MCHits();
  put( hits, "/Event/MC/Hits" );

Attention:: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behaviour can be suppressed by passing the arguement useRootInTES = false

Parameters:

	object	Data object or container to be registered
	address	Address in Gaudi Event Transient Store ("/Event" could be omitted )
	useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Exceptions:

	GaudiException	for invalid event data service
	GaudiException	for invalid object
	GaudiException	for error result from event data service

Returns:: StatusCode

Return values:

	StatusCode::SUCCESS	Data was successfully placed in the TES.
	StatusCode::FAILURE	Failed to store data in the TES.

Definition at line 209 of file GaudiAlgorithm.h.

00212   {
00213     GaudiCommon<Algorithm>::put ( evtSvc() , object , address , useRootInTES ) ;
00214   }

template<class TYPE>

Gaudi::Utils::GetData<TYPE>::return_type GaudiAlgorithm::get	(	IDataProviderSvc *	svc,
		const std::string &	location,
		const bool	useRootInTES = `true`
	)			const `[inline, inherited]`

Templated access to the data in Gaudi Transient Store.

Quick and safe access to the data in Gaudi transient store. The method located the data at given address and perform the debug printout about located data

  MCHits* hits = get<MCHits>( evtSvc() , "/Event/MC/Hits" );

Attention:: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behaviour can be suppressed by passing the arguement useRootInTES = false

See also:: IDataProviderSvc
SmartDataPtr

Exceptions:

	GaudiException	for Invalid Data Provider Service
	GaudiException	for invalid/unavailable data

Parameters:

	svc	Pointer to data service (data provider)
	location	data location/address in Gaudi Transient Store
	useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns:: pointer to the data object

Reimplemented from GaudiCommon< Algorithm >.

Definition at line 250 of file GaudiAlgorithm.h.

00253   {
00254     return GaudiCommon<Algorithm>::get<TYPE> ( svc , location , useRootInTES ) ;
00255   }

template<class TYPE>

Gaudi::Utils::GetData<TYPE>::return_type GaudiAlgorithm::get	(	const std::string &	location,
		const bool	useRootInTES = `true`
	)			const `[inline, inherited]`

Templated access to the data from Gaudi Event Transient Store.

Quick and safe access to the data in Gaudi transient store.

The method located the data at the given address and perform the debug printout about located data.

  MCParticles* mcps = get<MCParticles>( MCParticleLocation::Default );

Attention:: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behaviour can be suppressed by passing the arguement useRootInTES = false

Parameters:

	location	Data location/address in Gaudi Transient Store
	useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns:: Pointer to the data object

Definition at line 285 of file GaudiAlgorithm.h.

00287   {
00288     return GaudiCommon<Algorithm>::get<TYPE> ( evtSvc() , location , useRootInTES ) ;
00289   }

template<class TYPE>

TYPE* GaudiAlgorithm::getDet	(	IDataProviderSvc *	svc,
		const std::string &	location
	)			const `[inline, inherited]`

Templated access to the detector data from the Gaudi Detector Transient Store.

Quick and safe access to the detector data in Gaudi transient store.

The method located the detector at the given address and perform the debug printout about located detector.

  MyDet* mdet = getDet<MyDet>( detSvc() , "/dd/Structure/LHCb/MyDet" );

Parameters:

	svc	Pointer to data service (data provider)
	location	Detector location/address in Gaudi Transient Store

Returns:: Pointer to the detector object

Definition at line 310 of file GaudiAlgorithm.h.

00312   {
00313     return GaudiCommon<Algorithm>::get<TYPE> ( svc , location , false ) ;
00314   }

template<class TYPE>

TYPE* GaudiAlgorithm::getDet ( const std::string & location ) const [inline, inherited]

Templated access to the detector data from the Gaudi Detector Transient Store.

Quick and safe access to the detector data in Gaudi transient store.

The method located the detector at the given address and perform the debug printout about located detector.

  MyDet* mdet = getDet<MyDet>( "/dd/Structure/LHCb/MyDet" );

Parameters:

location

Detector location/address in Gaudi Transient Store

Returns:: Pointer to the detector object

Definition at line 334 of file GaudiAlgorithm.h.

00335   {
00336     return GaudiCommon<Algorithm>::get<TYPE> ( detSvc() , location , false ) ;
00337   }

template<class TYPE>

bool GaudiAlgorithm::exist	(	IDataProviderSvc *	svc,
		const std::string &	location,
		const bool	useRootInTES = `true`
	)			const `[inline, inherited]`

Check the existence of a data object or container in the Gaudi Transient Event Store.

  bool a1 = exist<DataObject>( evtSvc(), "/Event/MyObject" ) ;
  bool a2 = exist<MyHits>    ( evtSvc(), "/Event/MyHits"   ) ;

Attention:: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behaviour can be suppressed by passing the arguement useRootInTES = false

Parameters:

	svc	Pointer to data service (data provider)
	location	Address in Gaudi Transient Event Store
	useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns:: Boolean indicating status of the request

Return values:

	true	Data object or container exists and implements a proper interface
	true	Failed to locate the data object or container

Reimplemented from GaudiCommon< Algorithm >.

Definition at line 366 of file GaudiAlgorithm.h.

00369   {
00370     return GaudiCommon<Algorithm>::exist<TYPE> ( svc , location , useRootInTES ) ;
00371   }

template<class TYPE>

bool GaudiAlgorithm::exist	(	const std::string &	location,
		const bool	useRootInTES = `true`
	)			const `[inline, inherited]`

Check the existence of a data object or container in the Gaudi Transient Event Store.

  bool a1 = exist<DataObject>( "/Event/MyObject" ) ;
  bool a2 = exist<MyHits>    ( "/Event/MyHits"   ) ;

Attention:: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behaviour can be suppressed by passing the arguement useRootInTES = false

Parameters:

	location	Address in Gaudi Transient Event Store
	useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns:: Boolean indicating status of the request

Return values:

	true	Data object or container exists and implements a proper interface
	true	Failed to locate the data object or container

Definition at line 399 of file GaudiAlgorithm.h.

00401   {
00402     return GaudiCommon<Algorithm>::exist<TYPE> ( evtSvc() , location , useRootInTES ) ;
00403   }

template<class TYPE>

bool GaudiAlgorithm::existDet	(	IDataProviderSvc *	svc,
		const std::string &	location
	)			const `[inline, inherited]`

Check the existence of detector objects in the Gaudi Transient Detector Store.

  bool a1 = existDet<DataObject> ( detSvc(), "/dd/Structure/MyObject"     ) ;
  bool a2 = existDet<Material>   ( detSvc(), "/dd/Structure/Material/Air" ) ;

Parameters:

	svc	Pointer to data service (data provider)
	location	Address in Gaudi Transient Detector Store

Returns:: Boolean indicating status of the request

Return values:

	true	Detector object exists and implements a proper interface
	false	Failed to locate the data object

Definition at line 422 of file GaudiAlgorithm.h.

00424   {
00425     return GaudiCommon<Algorithm>::exist<TYPE> ( svc , location , false ) ;
00426   }

template<class TYPE>

bool GaudiAlgorithm::existDet ( const std::string & location ) const [inline, inherited]

Check the existence of detector objects in the Gaudi Transient Detector Store.

  bool a1 = existDet<DataObject> ( "/dd/Structure/MyObject"     ) ;
  bool a2 = existDet<Material>   ( "/dd/Structure/Material/Air" ) ;

Parameters:

location

Address in Gaudi Transient Detector Store

Returns:: Boolean indicating status of the request

Return values:

	true	Detector object exists and implements a proper interface
	false	Failed to locate the data object

Definition at line 444 of file GaudiAlgorithm.h.

00445   {
00446     return GaudiCommon<Algorithm>::exist<TYPE> ( detSvc() , location , false ) ;
00447   }

template<class TYPE, class TYPE2>

TYPE* GaudiAlgorithm::getOrCreate	(	IDataProviderSvc *	svc,
		const std::string &	location,
		const bool	useRootInTES = `true`
	)			const `[inline, inherited]`

Get the existing data object from Gaudi Event Transient store.

Alternatively, create new object and register it in TES and return if object does not exist.

  MyHits* hits = getOrCreate<MyHits,MyHits>( evtSvc() , "/Event/MyHits" ) ;

Attention:: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behaviour can be suppressed by passing the arguement useRootInTES = false

Exceptions:

	GaudiException	for Invalid Data Provider Service
	GaudiException	for invalid/unavailable data

Parameters:

	svc	Pointer to data service (data provider)
	location	Location in Gaudi Transient Event Store
	useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns:: A valid pointer to the object

Reimplemented from GaudiCommon< Algorithm >.

Definition at line 477 of file GaudiAlgorithm.h.

00480   {
00481     return GaudiCommon<Algorithm>::getOrCreate<TYPE,TYPE2> ( svc , location , useRootInTES ) ;
00482   }

template<class TYPE, class TYPE2>

TYPE* GaudiAlgorithm::getOrCreate	(	const std::string &	location,
		const bool	useRootInTES = `true`
	)			const `[inline, inherited]`

Get the existing data object from Gaudi Event Transient store.

Alternatively, create new object and register it in TES and return if object does not exist.

  MyHits* hits = getOrCreate<MyHits,MyHits>( "/Event/MyHits" ) ;

Attention:: The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behaviour can be suppressed by passing the arguement useRootInTES = false

Exceptions:

	GaudiException	for Invalid Data Provider Service
	GaudiException	for invalid/unavailable data

Parameters:

	location	Location in Gaudi Transient Event Store
	useRootInTES	Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property

Returns:: A valid pointer to the object

Definition at line 511 of file GaudiAlgorithm.h.

00513   {
00514     return GaudiCommon<Algorithm>::getOrCreate<TYPE,TYPE2> ( evtSvc() , location , useRootInTES ) ;
00515   }

bool GaudiAlgorithm::registerContext ( ) const [inline, inherited]

Definition at line 532 of file GaudiAlgorithm.h.

00532 { return m_registerContext ; }

INTupleSvc * GaudiAlgorithm::evtColSvc ( ) const [inherited]

Access the standard event collection service.

Returns:: pointer to the event collection service

Definition at line 104 of file GaudiAlgorithm.cpp.

00105 {
00106   if ( 0 == m_evtColSvc )
00107   {
00108     m_evtColSvc = svc< INTupleSvc > ( "EvtTupleSvc" , true ) ;
00109   }
00110   return m_evtColSvc ;
00111 }

IAlgContextSvc * GaudiAlgorithm::contextSvc ( ) const [inherited]

Access the standard Algorithm Context Service.

Returns:: pointer to the Algorithm Context Service

Definition at line 115 of file GaudiAlgorithm.cpp.

00116 {
00117   if ( 0 == m_contextSvc )
00118   {
00119     m_contextSvc = svc< IAlgContextSvc > ( m_contextSvcName , true ) ;
00120   }
00121   return m_contextSvc ;
00122 }

TOOL* GaudiCommon< Algorithm >::tool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent = `0`,
		bool	create = `true`
	)			const `[inherited]`

Useful method for the easy location of tools.

  IMyTool* myTool =
      tool<IMyTool>( "MyToolType", "MyToolName", this );

Attention:: The tools located with this method will be released automatically

See also:: IToolSvc
IAlgTool

Exceptions:

	GaudiException	for invalid Tool Service
	GaudiException	for error from Tool Service
	GaudiException	for invalid tool

Parameters:

	type	Tool type
	name	Tool name
	parent	Tool parent
	create	Flag for creation of nonexisting tools

Returns:: A pointer to the tool

TOOL* GaudiCommon< Algorithm >::tool	(	const std::string &	type,
		const IInterface *	parent = `0`,
		bool	create = `true`
	)			const `[inherited]`

A useful method for the easy location of tools.

  IMyTool* myTool = tool<IMyTool>( "PublicToolType" );

Attention:: The tools located with this method will be released automatically

See also:: IToolSvc
IAlgTool

Exceptions:

	GaudiException	for invalid Tool Service
	GaudiException	for error from Tool Service
	GaudiException	for invalid tool

Parameters:

	type	Tool type, could be of "Type/Name" format
	parent	Tool parent
	create	Flag for creation of nonexisting tools

Returns:: A pointer to the tool

SERVICE* GaudiCommon< Algorithm >::svc	(	const std::string &	name,
		const bool	create = `true`
	)			const `[inherited]`

A useful method for the easy location of services.

  IMyService* mySvc = svc<IMyService>( "MyServiceType" );

Attention:: The services located with this method will be released automatically

See also:

IService

ISevcLocator

Service

Exceptions:

	GaudiException	for error in Algorithms::service
	GaudiException	for invalid service

Parameters:

	name	service type name
	create	Flag for creation of non-existing services

Returns:: A pointer to the service

IUpdateManagerSvc* GaudiCommon< Algorithm >::updMgrSvc ( ) const [inline, inherited]

Short-cut to locate the Update Manager Service.

IDataProviderSvc* GaudiCommon< Algorithm >::fastContainersSvc ( ) const [inline, inherited]

Short-cut to locate the Fast Containers Service.

StatusCode GaudiCommon< Algorithm >::Error	(	const std::string &	msg,
		const StatusCode	st = `StatusCode::FAILURE`,
		const size_t	mx = `10`
	)			const `[inherited]`

Print the error message and return with the given StatusCode.

Also performs statistical analysis of the error messages and suppression after the defined number of error instances.

   if( a < 0 ) { return Error("a is negative!") ;}
   if( b < 0 ) { return Error("b is illegal!" , StatusCode(25) );
   if( c < 0 )
      { return Error("c is negative" , StatusCode(35) , 50 );

See also:

MsgStream

IMessageSvc

StatusCode

Parameters:

	msg	Error message
	st	StatusCode to return
	mx	Maximum number of printouts for this message

Returns:: StatusCode

StatusCode GaudiCommon< Algorithm >::Warning	(	const std::string &	msg,
		const StatusCode	st = `StatusCode::FAILURE`,
		const size_t	mx = `10`
	)			const `[inherited]`

Print the warning message and return with the given StatusCode.

Also performs statistical analysis of the error messages and suppression after the defined number of error instances.

   if( a < 0 ) { return Warning("a is negative!") ;}
   if( b < 0 ) { return Warning("b is illegal!" , StatusCode(25) );
   if( c < 0 )
      { return Warning("c is negative" , StatusCode(35) , 50 );

See also:

MsgStream

IMessageSvc

StatusCode

Parameters:

	msg	Warning message
	st	StatusCode to return
	mx	Maximum number of printouts for this message

Returns:: The given StatusCode

StatusCode GaudiCommon< Algorithm >::Print	(	const std::string &	msg,
		const StatusCode	st = `StatusCode::SUCCESS`,
		const MSG::Level	lev = `MSG::INFO`
	)			const `[inherited]`

Print the message and return with the given StatusCode.

See also:

MsgStream

IMessageSvc

StatusCode

Parameters:

	msg	Message to print
	st	StatusCode to return
	lev	Printout level for the given message

Returns:: The given StatusCode

StatusCode GaudiCommon< Algorithm >::Assert	(	const bool	ok,
		const std::string &	message = `""`,
		const StatusCode	sc = `StatusCode(StatusCode::FAILURE, true)`
	)			const `[inline, inherited]`

Assertion - throw exception if the given condition is not fulfilled.

See also:: GaudiException

Exceptions:

Exception

for invalid condition

Parameters:

	ok	Condition which should be "true"
	message	Message to be associated with the exception
	sc	StatusCode to be returned (artificial)

Returns:: StatusCode

StatusCode GaudiCommon< Algorithm >::Assert	(	const bool	ok,
		const char *	message,
		const StatusCode	sc = `StatusCode(StatusCode::FAILURE, true)`
	)			const `[inline, inherited]`

Assertion - throw exception if the given condition is not fulfilled.

See also:: GaudiException

Exceptions:

Exception

for invalid condition

Parameters:

	ok	Condition which should be "true"
	message	Message to be associated with the exception
	sc	StatusCode to be returned (artificial)

Returns:: StatusCode

StatusCode GaudiCommon< Algorithm >::Exception	(	const std::string &	msg,
		const GaudiException &	exc,
		const StatusCode	sc = `StatusCode(StatusCode::FAILURE, true)`
	)			const `[inherited]`

Create and (re)-throw a given GaudiException.

See also:: GaudiException

Exceptions:

CaudiException

always thrown!

Parameters:

	msg	Exception message
	exc	(previous) exception of type GaudiException
	sc	StatusCode

Returns:: StatusCode (fictive)

StatusCode GaudiCommon< Algorithm >::Exception	(	const std::string &	msg,
		const std::exception &	exc,
		const StatusCode	sc = `StatusCode(StatusCode::FAILURE, true)`
	)			const `[inherited]`

Create and (re)-throw a given exception.

See also:: GaudiException

Exceptions:

std::exception

always thrown!

Parameters:

	msg	Exception message
	exc	(previous) exception of type std::exception
	sc	StatusCode

Returns:: StatusCode (fictive)

StatusCode GaudiCommon< Algorithm >::Exception	(	const std::string &	msg = `"no message"`,
		const StatusCode	sc = `StatusCode(StatusCode::FAILURE, true)`
	)			const `[inherited]`

Create and throw an exception with the given message.

See also:: GaudiException

Exceptions:

GaudiException

always thrown!

Parameters:

	msg	Exception message
	sc	StatusCode

Returns:: StatusCode (fictive)

MsgStream& GaudiCommon< Algorithm >::msgStream ( const MSG::Level level ) const [inline, inherited]

Predefined configurable message stream for the efficient printouts.

  if ( a < 0 ) { msgStream( MSG::ERROR ) << "a = " << endreq ; }

Returns:: Reference to the predefined stream

MsgStream& GaudiCommon< Algorithm >::always ( ) const [inline, inherited]

shortcut for the method msgStream ( MSG::ALWAYS )

Definition at line 457 of file GaudiCommon.h.

00457 { return msgStream ( MSG::  ALWAYS ) ; }

MsgStream& GaudiCommon< Algorithm >::fatal ( ) const [inline, inherited]

shortcut for the method msgStream ( MSG::FATAL )

Definition at line 459 of file GaudiCommon.h.

00459 { return msgStream ( MSG::   FATAL ) ; }

MsgStream& GaudiCommon< Algorithm >::err ( ) const [inline, inherited]

shortcut for the method msgStream ( MSG::ERROR )

Definition at line 461 of file GaudiCommon.h.

00461 { return msgStream ( MSG::   ERROR ) ; }

MsgStream& GaudiCommon< Algorithm >::error ( ) const [inline, inherited]

shortcut for the method msgStream ( MSG::ERROR )

Definition at line 463 of file GaudiCommon.h.

00463 { return msgStream ( MSG::   ERROR ) ; }

MsgStream& GaudiCommon< Algorithm >::warning ( ) const [inline, inherited]

shortcut for the method msgStream ( MSG::WARNING )

Definition at line 465 of file GaudiCommon.h.

00465 { return msgStream ( MSG:: WARNING ) ; }

MsgStream& GaudiCommon< Algorithm >::info ( ) const [inline, inherited]

shortcut for the method msgStream ( MSG::INFO )

Definition at line 467 of file GaudiCommon.h.

00467 { return msgStream ( MSG::    INFO ) ; }

MsgStream& GaudiCommon< Algorithm >::debug ( ) const [inline, inherited]

shortcut for the method msgStream ( MSG::DEBUG )

Definition at line 469 of file GaudiCommon.h.

00469 { return msgStream ( MSG::   DEBUG ) ; }

MsgStream& GaudiCommon< Algorithm >::verbose ( ) const [inline, inherited]

shortcut for the method msgStream ( MSG::VERBOSE )

Definition at line 471 of file GaudiCommon.h.

00471 { return msgStream ( MSG:: VERBOSE ) ; }

MsgStream& GaudiCommon< Algorithm >::msg ( ) const [inline, inherited]

shortcut for the method msgStream ( MSG::INFO )

Definition at line 473 of file GaudiCommon.h.

00473 { return msgStream ( MSG::    INFO ) ; }

const Statistics& GaudiCommon< Algorithm >::counters ( ) const [inline, inherited]

accessor to all counters

Definition at line 476 of file GaudiCommon.h.

00476 { return m_counters ; }

StatEntity& GaudiCommon< Algorithm >::counter ( const std::string & tag ) const [inline, inherited]

accessor to certain counter by name

  if ( OK ) { ++counter("OK") ; }

  // additive counter ('Flag')
  counter("#Tracks") += tracks->size() ;

  // multiplicative counter  ('Weight')
  counter("ProbTot") *= probability ;

See also:: StatEntuty

Parameters:

tag

counter name

Returns:: the counter itself

Definition at line 495 of file GaudiCommon.h.

00495 { return m_counters[tag] ; }

MSG::Level GaudiCommon< Algorithm >::msgLevel ( ) const [inline, inherited]

The current message service output level.

Returns:: The current message level

Definition at line 500 of file GaudiCommon.h.

00500 { return m_msgLevel ; }

bool GaudiCommon< Algorithm >::msgLevel ( const MSG::Level level ) const [inline, inherited]

Test the output level.

Parameters:

level

The message level to test against

Returns:: boolean Indicting if messages at given level will be printed

Return values:

	true	Messages at level "level" will be printed
	true	Messages at level "level" will NOT be printed

Definition at line 507 of file GaudiCommon.h.

00507 { return msgLevel() <= level ; }

void GaudiCommon< Algorithm >::resetMsgStream ( ) const [inherited]

Reset (delete) the current message stream object.

Useful for example to force a new object following a change in the message level settings

bool GaudiCommon< Algorithm >::typePrint ( ) const [inline, inherited]

Insert the actual C++ type of the algorithm/tool in the messages ?

Definition at line 514 of file GaudiCommon.h.

00514 { return m_typePrint    ; }

bool GaudiCommon< Algorithm >::propsPrint ( ) const [inline, inherited]

Print properties at initalization ?

Definition at line 516 of file GaudiCommon.h.

00516 { return m_propsPrint   ; }

bool GaudiCommon< Algorithm >::statPrint ( ) const [inline, inherited]

Print statistical counters at finalization ?

Definition at line 518 of file GaudiCommon.h.

00518 { return m_statPrint    ; }

bool GaudiCommon< Algorithm >::errorsPrint ( ) const [inline, inherited]

Print error counters at finalization ?

Definition at line 520 of file GaudiCommon.h.

00520 { return m_errorsPrint  ; }

long GaudiCommon< Algorithm >::printStat ( const MSG::Level level = MSG::ALWAYS ) const [inherited]

perform the actual printout of statistical counters

Parameters:

level

The message level to print at

Returns:: number of active statistical counters

long GaudiCommon< Algorithm >::printErrors ( const MSG::Level level = MSG::ALWAYS ) const [inherited]

perform the actual printout of error counters

Parameters:

level

The message level to print at

Returns:: number of error counters

long GaudiCommon< Algorithm >::printProps ( const MSG::Level level = MSG::ALWAYS ) const [inherited]

perform the actual printout of properties

Parameters:

level

The message level to print at

Returns:: number of properties

void GaudiCommon< Algorithm >::registerCondition	(	const std::string &	condition,
		StatusCode(CallerClass::*)()	mf = `NULL`
	)			`[inline, inherited]`

Parameters:

	condition	the path inside the Transient Detector Store to the condition object.
	mf	optional pointer to the member function to call when the condition object is updated. If the pointer is omitted the user must explicitely provide the class name to the method. StatusCode MyAlg::initialize(){ // ... registerCondition("/dd/Conditions/Readout/MyDet/MyCond",&MyAlg::i_CallBack); registerCondition<MyAlg>("/dd/Conditions/Readout/MyDet/MyOtherCond"); // ... return StatusCode.SUCCESS; }

Definition at line 560 of file GaudiCommon.h.

00560                                                                                                   {
00561     updMgrSvc()->registerCondition(dynamic_cast<CallerClass*>(this),condition,mf);
00562   }

void GaudiCommon< Algorithm >::registerCondition	(	const std::string &	condition,
		CondType *&	condPtrDest,
		StatusCode(CallerClass::*)()	mf = `NULL`
	)			`[inline, inherited]`

This version of the method allow the user to specify where to put a copy of the pointer to the condition object.

Parameters:

	condition	the path inside the Transient Detector Store to the condition object.
	condPtrDest	pointer to fill with the location of the condition object. Note: the pointer can be safely used only in the execute method or in the member function triggered by the update.
	mf	optional pointer to the member function to call when the condition object is updated. If the pointer is omitted the user must explicitely provide the class name to the method. class MyAlg: public GaudiAlgorithm { // ... public: virtual StatusCode i_CallBack(); private: Condition m_MyCond; SpecialCondition m_MyOtherCond; // ... }; StatusCode MyAlg::initialize(){ // ... registerCondition("/dd/Conditions/Readout/MyDet/MyCond",m_MyCond,&MyAlg::i_CallBack); registerCondition<MyAlg>("/dd/Conditions/Readout/MyDet/MyOtherCond",m_MyOtherCond); // ... return StatusCode.SUCCESS; }

Definition at line 594 of file GaudiCommon.h.

00595                                                                       {
00596     updMgrSvc()->registerCondition(dynamic_cast<CallerClass*>(this),condition,mf,condPtrDest);
00597   }

void GaudiCommon< Algorithm >::registerCondition	(	char *	condition,
		StatusCode(CallerClass::*)()	mf = `NULL`
	)			`[inline, inherited]`

just to avoid conflicts with the version using a pointer to a template class.

Definition at line 600 of file GaudiCommon.h.

00600                                                                                        {
00601     updMgrSvc()->registerCondition(dynamic_cast<CallerClass*>(this),std::string(condition),mf);
00602   }

void GaudiCommon< Algorithm >::registerCondition	(	TargetClass *	condition,
		StatusCode(CallerClass::*)()	mf = `NULL`
	)			`[inline, inherited]`

Parameters:

	condition	the path inside the Transient Detector Store to the condition object.
	mf	optional pointer to the member function to call when the condition object is updated. If the pointer is omitted the user must explicitely provide the class name to the method. StatusCode MyAlg::initialize(){ // ... registerCondition("/dd/Conditions/Readout/MyDet/MyCond",&MyAlg::i_CallBack); registerCondition<MyAlg>("/dd/Conditions/Readout/MyDet/MyOtherCond"); // ... return StatusCode.SUCCESS; }

Definition at line 619 of file GaudiCommon.h.

00619                                                                                               {
00620     updMgrSvc()->registerCondition(dynamic_cast<CallerClass*>(this),condition,mf);
00621   }

StatusCode GaudiCommon< Algorithm >::runUpdate ( ) [inline, inherited]

asks the UpdateManagerSvc to perform an update of the instance (if needed) without waiting the next BeginEvent incident.

It is useful if the instance can be instantiated after a BeginEvent incident, and used before the next one (for example with tools).

  StatusCode MyTool::initialize(){
    // ...
    return runUpdate();
  }

Definition at line 633 of file GaudiCommon.h.

00633 { return updMgrSvc()->update(this); }

TransientFastContainer<T>* GaudiCommon< Algorithm >::getFastContainer	(	const std::string &	location,
		typename TransientFastContainer< T >::size_type	initial = `0`
	)			`[inherited]`

Return a new TransientFastContainer for objects of type T.

The container is created if it is not in the transient store. If a container with the same name but a different type

StatusCode GaudiCommon< Algorithm >::releaseTool ( const IAlgTool * tool ) const [protected, inherited]

manual forced (and 'safe') release of the tool

StatusCode GaudiCommon< Algorithm >::releaseSvc ( const IInterface * svc ) const [protected, inherited]

manual forced (and 'safe') release of the service

StatusCode GaudiCommon< Algorithm >::release ( const IInterface * interface ) const [inherited]

Manual forced (and 'safe') release of the active tool or service.

  IMyTool* mytool = tool<IMyTool>( .... ) ;
  mytool->spendCPUtime() ;
  release ( mytool ) ;

  IMySvc* msvc = svc<IMySvc>( .... ) ;
  msvc->spendCPUtime() ;
  release ( msvc ) ;

Parameters:

interface

Interface pointer to the interface to be released

Returns:: StatusCode

Return values:

	StatusCode::SUCCESS	Tool or service was successfully released
	StatusCode::FAILURE	Error releasing too or service

const std::string& GaudiCommon< Algorithm >::context ( ) const [inline, inherited]

Returns the "context" string. Used to indentify different processing states.

Definition at line 696 of file GaudiCommon.h.

00696 { return m_context; }

const std::string& GaudiCommon< Algorithm >::rootInTES ( ) const [inline, inherited]

Returns the "rootInTES" string.

Used as the directory root in the TES for which all data access refers to (both saving and retrieving).

Definition at line 700 of file GaudiCommon.h.

00700 { return m_rootInTES; }

double GaudiCommon< Algorithm >::globalTimeOffset ( ) const [inline, inherited]

Returns the "globalTimeOffset" double.

Definition at line 702 of file GaudiCommon.h.

00702 { return m_globalTimeOffset; }

Member Data Documentation

DoubleProperty Prescaler::m_percentPass [private]

Percentage of events that should be passed.

Definition at line 37 of file Prescaler.h.

int Prescaler::m_pass [private]

Number of events passed.

Definition at line 42 of file Prescaler.h.

int Prescaler::m_seen [private]

Number of events seen.

Definition at line 47 of file Prescaler.h.

const bool GaudiCommon< Algorithm >::IgnoreRootInTES [static, protected, inherited]

Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods.

If used with cause the RootInTES option to be IGNORED.

Useful to aid with code readablity. e.g.

  // Get data, ignoring the setting of rootInTES()
  MyData * data = get<MyData>( "/Event/MyData", IgnoreRootInTES );

Definition at line 68 of file GaudiCommon.h.

const bool GaudiCommon< Algorithm >::UseRootInTES [static, protected, inherited]

Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods.

If used with cause the RootInTES option to be USED

Useful to aid with code readablity. e.g.

  // Get data, using the setting of rootInTES()
  MyData * data = get<MyData>( "/Event/MyData", UseRootInTES );
  // note the default setting is true, so this is equivalent to
  MyData * data = get<MyData>( "/Event/MyData" );

Definition at line 80 of file GaudiCommon.h.

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

/home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiAlg/GaudiAlg/Prescaler.h
/home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiAlg/src/lib/Prescaler.cpp

Generated on Mon Apr 11 19:58:21 2011 for GaudiAlg by 1.4.7

In This Package:

Prescaler Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation