ana::SelectionCut Class Reference

a class for setting a single selection cut More...

#include <SelectionCut.h>

List of all members.

Public Member Functions

void testInvariant () const
 test the invariant of this object
 SelectionCut ()
 standard constructor
SelectionChoice get () const
 get the selection choice for the cut
bool getPass () const
 get whether we passed
bool getFail () const
 get whether we failed
void set (SelectionChoice choice) const
 set the selection choice for the cut
void setPassedIf (bool pass) const
 set whether the cut passed
void setFailedIf (bool fail) const
 set whether the cut failed
void configure (SelectionData *val_data, std::size_t val_index)
 configure this cut to point to the given object

Detailed Description

a class for setting a single selection cut

this class is used inside selection (or correction) tools, to represent the different cuts that the tool performs (with one object per cut). to that end the owning tool should call registerCut() inside initialize and then call setPass/setFail in execute.

to make things less ambigious (i.e. if we a selection cut is true does it mean it passes or it fails?), the method always include pass or fail in the name.


Constructor & Destructor Documentation

ana::SelectionCut::SelectionCut (  ) 

standard constructor

Guarantee
strong
Failures
out of memory I

Member Function Documentation

void ana::SelectionCut::configure ( SelectionData val_data,
std::size_t  val_index 
)

configure this cut to point to the given object

Guarantee
no-fail
SelectionChoice ana::SelectionCut::get (  )  const

get the selection choice for the cut

Guarantee
no-fail
Precondition:
cut has been configured
bool ana::SelectionCut::getFail (  )  const

get whether we failed

Guarantee
no-fail
bool ana::SelectionCut::getPass (  )  const

get whether we passed

Guarantee
no-fail
void ana::SelectionCut::set ( SelectionChoice  choice  )  const

set the selection choice for the cut

Guarantee
no-fail
Precondition:
cut has been configured
void ana::SelectionCut::setFailedIf ( bool  fail  )  const

set whether the cut failed

Guarantee
no-fail
Precondition:
cut has been configured
void ana::SelectionCut::setPassedIf ( bool  pass  )  const

set whether the cut passed

Guarantee
no-fail
Precondition:
cut has been configured
void ana::SelectionCut::testInvariant (  )  const

test the invariant of this object

Guarantee
no-fail

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1