Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Acclaim::ProgressBar Class Reference

Prints a progress bar and timer to stderr. More...

#include <ProgressBar.h>

Public Member Functions

 ProgressBar ()
 Default constructor - don't use this.
 
 ProgressBar (Long64_t maxEntry)
 Useful constructor - do use this one. More...
 
void operator++ (int)
 Increment operator, use when you have completed one iteration of the main loop.
 
void status ()
 For debugging, prints state of internal variables.
 
void inc (Long64_t &entry, Long64_t numEntries=-1)
 New primary function to move through main for loop in analysis program. More...
 
void inc (UInt_t &entry, Long64_t numEntries=-1)
 New primary function to move through main for loop in analysis program. More...
 
void inc (Int_t &entry, Long64_t numEntries=-1)
 New primary function to move through main for loop in analysis program. More...
 

Static Public Member Functions

static void mainLoopSigintHandle (int param)
 Custom handler, sets variable when signal is received. More...
 

Static Public Attributes

static int progState = 0
 

Detailed Description

Prints a progress bar and timer to stderr.

Definition at line 25 of file ProgressBar.h.

Collaboration diagram for Acclaim::ProgressBar:
Collaboration graph
[legend]

Constructor & Destructor Documentation

Acclaim::ProgressBar::ProgressBar ( Long64_t  maxEntryInit)

Useful constructor - do use this one.

Parameters
maxEntryInitis the number of events you want to loop over

Definition at line 40 of file ProgressBar.cxx.

Member Function Documentation

void Acclaim::ProgressBar::inc ( Long64_t &  entry,
Long64_t  numEntries = -1 
)

New primary function to move through main for loop in analysis program.

This now looks for SIGINT signals and alters the main loop variable, entry = numEntries.

Parameters
entryis a reference to the loop varible, assumed to start at 0.
numEntriesis the maximum entry, assumed that the loop condition is entry < numEntries

Definition at line 160 of file ProgressBar.cxx.

void Acclaim::ProgressBar::inc ( UInt_t &  entry,
Long64_t  numEntries = -1 
)

New primary function to move through main for loop in analysis program.

This function wraps the Long64_t implementation of inc

Parameters
entryis a reference to the loop varible, assumed to start at 0.
numEntriesis the maximum entry, assumed that the loop condition is entry < numEntries

Definition at line 127 of file ProgressBar.cxx.

void Acclaim::ProgressBar::inc ( Int_t &  entry,
Long64_t  numEntries = -1 
)

New primary function to move through main for loop in analysis program.

This function wraps the Long64_t implementation of inc

Parameters
entryis a reference to the loop varible, assumed to start at 0.
numEntriesis the maximum entry, assumed that the loop condition is entry < numEntries

Definition at line 143 of file ProgressBar.cxx.

void Acclaim::ProgressBar::mainLoopSigintHandle ( int  param)
static

Custom handler, sets variable when signal is received.

Parameters
paramis the signal, I presume

Definition at line 214 of file ProgressBar.cxx.


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