Jpp - the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
JTest_t Class Referenceabstract

Interface to read input and write output for TObject tests. More...

#include <JTest_t.hh>

Inheritance diagram for JTest_t:
JTestChi2_1D JTestChi2_2D JTestChi2_Bin JTestChi2R_1D JTestChi2R_2D JTestIdentical_1D JTestIdentical_2D JTestIdentical_3D JTestKolmogorov_1D JTestKolmogorov_2D JTestKolmogorovSlice JTestRuns_1D JTestRuns_2D JTestSignificance_1D JTestSignificance_2D JTestZero

Public Member Functions

virtual std::istream & read (std::istream &in)=0
 Read test parameters from input. More...
 
virtual std::ostream & write (std::ostream &out, std::string delimiter=" ", bool failures=false) const =0
 Write test result to output. More...
 
virtual void test (TObject *o1, TObject *o2)=0
 Tests compatibility between two TObjects. More...
 
virtual void save (TFile *f, std::string path, bool failures=false)=0
 Writes the test result to root file. More...
 
virtual void clear ()=0
 Clear results. More...
 
virtual std::string getName ()=0
 Get test name. More...
 
virtual std::string getParameter ()=0
 Get test parameter. More...
 

Public Attributes

std::vector< JTestResultresults
 

Detailed Description

Interface to read input and write output for TObject tests.


This is an abstract class from which the different tests are derived.
All tests have in common the methods from this interface.
For each test, the parameters are passed through an istream, and parsed by the read() method.
For each test, the different results are stored in the results buffer.
The write() method is used to print a message with the result of the test.
The save() method is used to save a graphical output with the test results into a .root file.
The clear() method clears the results buffer. For a list of available tests see JTestDictionary()

Definition at line 246 of file JTest_t.hh.

Member Function Documentation

virtual std::istream& JTest_t::read ( std::istream &  in)
pure virtual
virtual std::ostream& JTest_t::write ( std::ostream &  out,
std::string  delimiter = " ",
bool  failures = false 
) const
pure virtual

Write test result to output.

Parameters
outoutput stream
delimiterfield delimiter
failuresIf true, write only failures.
Returns
output stream

Implemented in JTestZero, JTestKolmogorov_1D, JTestChi2_2D, JTestKolmogorov_2D, JTestKolmogorovSlice, JTestChi2R_2D, JTestChi2_1D, JTestChi2R_1D, JTestIdentical_1D, JTestIdentical_2D, JTestIdentical_3D, JTestSignificance_1D, JTestRuns_2D, JTestChi2_Bin, JTestSignificance_2D, and JTestRuns_1D.

virtual void JTest_t::test ( TObject o1,
TObject o2 
)
pure virtual
virtual void JTest_t::save ( TFile *  f,
std::string  path,
bool  failures = false 
)
pure virtual

Writes the test result to root file.

Parameters
fA ROOT file
pathPath in root file.
failuresIf true, write only failures.

Implemented in JTestChi2_2D, JTestKolmogorovSlice, JTestChi2R_2D, JTestKolmogorov_1D, JTestRuns_2D, JTestSignificance_1D, JTestChi2_1D, JTestChi2R_1D, JTestZero, JTestIdentical_1D, JTestKolmogorov_2D, JTestSignificance_2D, JTestIdentical_2D, JTestIdentical_3D, JTestRuns_1D, and JTestChi2_Bin.

virtual void JTest_t::clear ( )
pure virtual
virtual std::string JTest_t::getName ( )
pure virtual
virtual std::string JTest_t::getParameter ( )
pure virtual

Member Data Documentation

std::vector<JTestResult> JTest_t::results

Buffer to store results of multiple tests.

Definition at line 251 of file JTest_t.hh.


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