Main Page | Namespace List | Class Hierarchy | Compound List | File List | Compound Members | File Members | Related Pages

IValsTool Class Reference

Abstract interface for the XxxValsTools, including visitor. More...

#include <IValsTool.h>

Inheritance diagram for IValsTool:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual StatusCode getVal (std::string varName, double &value, int check=CALC)=0
 get a particular value, using ntuple name

virtual StatusCode getVal (std::string varName, float &value, int check=CALC)=0
virtual StatusCode getVal (std::string varName, int &value, int check=CALC)=0
virtual StatusCode getVal (std::string varName, unsigned int &value, int check=CALC)=0
virtual StatusCode getVal (std::string varName, unsigned long long &value, int check=CALC)=0
virtual StatusCode getValCheck (std::string varName, double &value)=0
 get a particular value, using ntuple name, with calc checking

virtual StatusCode getValCheck (std::string varName, float &value)=0
virtual StatusCode getValCheck (std::string varName, int &value)=0
virtual StatusCode getValCheck (std::string varName, unsigned int &value)=0
virtual StatusCode getValCheck (std::string varName, unsigned long long &value)=0
virtual StatusCode browse (MsgStream log, const std::string varName="")=0
 output the names and values, either all (default) or just one;

virtual StatusCode doCalcIfNotDone ()=0
 let the user trigger her own calculation

virtual void zeroVals ()=0
 to allow calling from AnalysisNtupleAlg

virtual int getCalcCount ()=0
 number of times a tool did its calculation for this event

virtual StatusCode getVal (std::string varName, std::string &value, int check=CALC)=0
 return a string containing the value, as above

virtual StatusCode getValCheck (std::string varName, std::string &value)=0
virtual void setLoadOrder (int index)=0
virtual int getLoadOrder ()=0
virtual bool isLoaded ()=0
virtual Visitor::eVisitorRet traverse (IValsTool::Visitor *v, const bool checkCalc=true)=0
 sets up callback method for user to access the data


Static Public Member Functions

const InterfaceID & interfaceID ()
 Retrieve interface ID.

Detailed Description

Abstract interface for the XxxValsTools, including visitor.

Author:
Leon Rochester

Definition at line 28 of file IValsTool.h.

Member Function Documentation

virtual StatusCode IValsTool::browse (  MsgStream  log,
const std::string  varName = ""
)  [pure virtual]
 

output the names and values, either all (default) or just one;

Implemented in ValBase.

virtual StatusCode IValsTool::doCalcIfNotDone (   )  [pure virtual]
 

let the user trigger her own calculation

Implemented in ValBase.

virtual int IValsTool::getCalcCount (   )  [pure virtual]
 

number of times a tool did its calculation for this event

Implemented in ValBase.

virtual int IValsTool::getLoadOrder (   )  [pure virtual]
 

Implemented in ValBase.

Referenced by TkrValsTool::calculate().

virtual StatusCode IValsTool::getVal (  std::string  varName,
std::string &  value,
int  check = CALC
)  [pure virtual]
 

return a string containing the value, as above

Implemented in ValBase.

virtual StatusCode IValsTool::getVal (  std::string  varName,
unsigned long long &  value,
int  check = CALC
)  [pure virtual]
 

Implemented in ValBase.

virtual StatusCode IValsTool::getVal (  std::string  varName,
unsigned int &  value,
int  check = CALC
)  [pure virtual]
 

Implemented in ValBase.

virtual StatusCode IValsTool::getVal (  std::string  varName,
int &  value,
int  check = CALC
)  [pure virtual]
 

Implemented in ValBase.

virtual StatusCode IValsTool::getVal (  std::string  varName,
float &  value,
int  check = CALC
)  [pure virtual]
 

Implemented in ValBase.

virtual StatusCode IValsTool::getVal (  std::string  varName,
double &  value,
int  check = CALC
)  [pure virtual]
 

get a particular value, using ntuple name

Implemented in ValBase.

Referenced by TkrValsTool::calculate(), and EvtValsTool::calculate().

virtual StatusCode IValsTool::getValCheck (  std::string  varName,
std::string &  value
)  [pure virtual]
 

Implemented in ValBase.

virtual StatusCode IValsTool::getValCheck (  std::string  varName,
unsigned long long &  value
)  [pure virtual]
 

Implemented in ValBase.

virtual StatusCode IValsTool::getValCheck (  std::string  varName,
unsigned int &  value
)  [pure virtual]
 

Implemented in ValBase.

virtual StatusCode IValsTool::getValCheck (  std::string  varName,
int &  value
)  [pure virtual]
 

Implemented in ValBase.

virtual StatusCode IValsTool::getValCheck (  std::string  varName,
float &  value
)  [pure virtual]
 

Implemented in ValBase.

virtual StatusCode IValsTool::getValCheck (  std::string  varName,
double &  value
)  [pure virtual]
 

get a particular value, using ntuple name, with calc checking

Implemented in ValBase.

const InterfaceID& IValsTool::interfaceID (   )  [inline, static]
 

Retrieve interface ID.

Definition at line 33 of file IValsTool.h. 

00033 { return IID_IValsTool; }

virtual bool IValsTool::isLoaded (   )  [pure virtual]
 

Implemented in ValBase.

Referenced by EvtValsTool::calculate().

virtual void IValsTool::setLoadOrder (  int  index  )  [pure virtual]
 

Implemented in ValBase.

virtual Visitor::eVisitorRet IValsTool::traverse (  IValsTool::Visitor *  v,
const bool  checkCalc = true
)  [pure virtual]
 

sets up callback method for user to access the data

Implemented in ValBase.

virtual void IValsTool::zeroVals (   )  [pure virtual]
 

to allow calling from AnalysisNtupleAlg

Implemented in CalValsTool, EvtValsTool, GltValsTool, and ValBase.

The documentation for this class was generated from the following file:
Generated on Mon Dec 1 20:09:10 2008 by doxygen 1.3.3