Gaudi Framework, version v20r2
	Generated: 18 Jul 2008

Prescaler Class Reference

#include <Prescaler.h>

Inheritance diagram for Prescaler:

[legend]Collaboration diagram for Prescaler:

[legend]List of all members.

---

Detailed Description

Definition at line 5 of file Prescaler.h.

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
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.

---

Constructor & Destructor Documentation

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

Constructor(s).

Definition at line 6 of file Prescaler.cpp.

References Algorithm::declareProperty(), m_percentPass, and PropertyWithVerifier< TYPE, VERIFIER >::verifier().

                                                                    :
  GaudiAlgorithm(name, pSvcLocator) ,
  m_pass( 0 ),
  m_seen( 0 )
{
  declareProperty( "PercentPass", m_percentPass=100.0 );
  m_percentPass.verifier().setBounds( 0.0, 100.0 );
}

Prescaler::~Prescaler

(

)

Destructor.

Definition at line 15 of file Prescaler.cpp.

{
}

---

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.

References endreq(), GaudiCommon< Algorithm >::info(), GaudiAlgorithm::initialize(), m_percentPass, and Algorithm::name().

{
  const StatusCode sc = GaudiAlgorithm::initialize();
  if ( !sc) return sc;

  info() << name( ) << ":Prescaler::Initialize - pass: " << m_percentPass << endreq;
 
 return sc;
}

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.

References endreq(), GaudiCommon< Algorithm >::info(), m_pass, m_percentPass, m_seen, Algorithm::name(), Algorithm::setFilterPassed(), and StatusCode::SUCCESS.

{
  ++m_seen;
  float fraction = (float(100.0) * (float)(m_pass+1)) / (float)m_seen;
  if ( fraction > m_percentPass ) {
    setFilterPassed( false );
    info() << name() << ":Prescaler::execute - filter failed" << endreq;
  } else {
    info() << name() << ":Prescaler::execute - filter passed" << endreq;
    ++m_pass;
  }
  return StatusCode::SUCCESS;
}

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.

References endreq(), GaudiAlgorithm::finalize(), GaudiCommon< Algorithm >::info(), m_pass, m_seen, and Algorithm::name().

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

---

Member Data Documentation

DoubleProperty Prescaler::m_percentPass [private]

Percentage of events that should be passed.

Definition at line 37 of file Prescaler.h.

Referenced by execute(), initialize(), and Prescaler().

int Prescaler::m_pass [private]

Number of events passed.

Definition at line 42 of file Prescaler.h.

Referenced by execute(), and finalize().

int Prescaler::m_seen [private]

Number of events seen.

Definition at line 47 of file Prescaler.h.

Referenced by execute(), and finalize().

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiAlg/v11r1/GaudiAlg/Prescaler.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiAlg/v11r1/src/lib/Prescaler.cpp

---