Class dedicated to standardize the title of the graphical objects produced by the JTest_t() derived classes. More...

#include <JTestSummary.hh>

Inheritance diagram for JCOMPAREHISTOGRAMS::JTestSummary:

Classes
class	JTestSummaryHelper
	Auxiliary class for I/O of test result message. More...

Public Member Functions
	JTestSummary ()
	Default constructor. More...

	JTestSummary (const std::string &testName, const JRootObjectID &hA, const JRootObjectID &hB, const std::string &parameter, const double value, const double threshold, const bool passed)
	Constructor. More...

JProperties	getProperties (const JEquationParameters &equation=JTestSummary::getEquationParameters())
	Get properties of this class. More...

JProperties	getProperties (const JEquationParameters &equation=JTestSummary::getEquationParameters()) const
	Get properties of this class. More...

Static Public Member Functions
static JEquationParameters &	getEquationParameters ()
	Get equation parameters. More...

static void	setEquationParameters (const JEquationParameters &equation)
	Set equation parameters. More...

Public Attributes
std::string	testName

JRootObjectID	histogramA

JRootObjectID	histogramB

std::string	parameterName

double	parameterValue

double	parameterThreshold

bool	passed

std::string	passed_h

Friends
std::istream &	operator>> (std::istream &in, JTestSummary &object)
	Read test summary from input. More...

std::ostream &	operator<< (std::ostream &out, JTestSummary &object)
	Write test summary to output. More...

Detailed Description

Class dedicated to standardize the title of the graphical objects produced by the JTest_t() derived classes.

Definition at line 33 of file JTestSummary.hh.

Constructor & Destructor Documentation

◆ JTestSummary() [1/2]

JCOMPAREHISTOGRAMS::JTestSummary::JTestSummary ( )

inline

Default constructor.

Definition at line 40 of file JTestSummary.hh.

                    :
       testName          (""),
       histogramA        (JRootObjectID()),
       histogramB        (JRootObjectID()),
       parameterName     (""),
       parameterValue    (0.0),
       parameterThreshold(0.0),
       passed            (false),
       passed_h          (FAILED_t)
     {}

◆ JTestSummary() [2/2]

JCOMPAREHISTOGRAMS::JTestSummary::JTestSummary	(	const std::string &	testName,
		const JRootObjectID &	hA,
		const JRootObjectID &	hB,
		const std::string &	parameter,
		const double	value,
		const double	threshold,
		const bool	passed
	)

inline

Constructor.

Parameters

testName	Test name
hA	Name of the first histogram.
hB	Name of the second histogram.
parameter	Name of the parameter used for the test.
threshold	Threshold value for the tested parameter.
value	Value of the tested parameter.
passed	true if the test is passed; else false.

Definition at line 63 of file JTestSummary.hh.

                                              :
       testName          (testName),
       histogramA        (hA),
       histogramB        (hB),
       parameterName     (parameter),
       parameterValue    (value),
       parameterThreshold(threshold),
       passed            (passed),
       passed_h          (passed ? PASSED_t : FAILED_t)
     {}

Member Function Documentation

◆ getEquationParameters()

static JEquationParameters& JCOMPAREHISTOGRAMS::JTestSummary::getEquationParameters ( )

inlinestatic

Get equation parameters.

Returns: equation parameters

Definition at line 86 of file JTestSummary.hh.

     {
       static JEquationParameters equation("=", "; ", "", "#");
  
       return equation;
     }

◆ setEquationParameters()

static void JCOMPAREHISTOGRAMS::JTestSummary::setEquationParameters ( const JEquationParameters & equation )

inlinestatic

Set equation parameters.

Parameters

equation equation parameters

Definition at line 99 of file JTestSummary.hh.

     {
       getEquationParameters() = equation;
     }

◆ getProperties() [1/2]

JProperties JCOMPAREHISTOGRAMS::JTestSummary::getProperties ( const JEquationParameters & equation = JTestSummary::getEquationParameters() )

inline

Get properties of this class.

Parameters

equation equation parameters

Definition at line 110 of file JTestSummary.hh.

     {
       return JTestSummaryHelper(*this, equation);
     }

◆ getProperties() [2/2]

JProperties JCOMPAREHISTOGRAMS::JTestSummary::getProperties ( const JEquationParameters & equation = JTestSummary::getEquationParameters() ) const

inline

Get properties of this class.

Parameters

equation equation parameters

Definition at line 121 of file JTestSummary.hh.

     {
       return JTestSummaryHelper(*this, equation);
     }

Friends And Related Function Documentation

◆ operator>>

std::istream& operator>>	(	std::istream &	in,
		JTestSummary &	object
	)

friend

Read test summary from input.

Parameters

in	input stream
object	test summary

Returns: input stream

Definition at line 134 of file JTestSummary.hh.

     {
       using namespace std;
  
       in >> object.testName
          >> object.histogramA
          >> object.histogramB
          >> object.parameterName
          >> object.parameterThreshold
          >> object.passed_h;
       
       object.passed = (object.passed_h == PASSED_t) ? 1 : 0;
  
       return in;
     }

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		JTestSummary &	object
	)

friend

Write test summary to output.

Parameters

out	output stream
object	test summary

Returns: output stream

Definition at line 159 of file JTestSummary.hh.

     {
       const JFormat format(out);
  
       out << object.testName           << ' '
           << object.histogramA         << ' '
           << object.histogramB         << ' '
           << object.parameterName      << ' '
           << object.parameterValue     << ' '
           << object.parameterThreshold << ' '
           << object.passed_h;
       
       return out;
     }

Member Data Documentation

◆ testName

std::string JCOMPAREHISTOGRAMS::JTestSummary::testName

Test name.

Definition at line 175 of file JTestSummary.hh.

◆ histogramA

JRootObjectID JCOMPAREHISTOGRAMS::JTestSummary::histogramA

First histogram.

Definition at line 176 of file JTestSummary.hh.

◆ histogramB

JRootObjectID JCOMPAREHISTOGRAMS::JTestSummary::histogramB

Second histogram.

Definition at line 177 of file JTestSummary.hh.

◆ parameterName

std::string JCOMPAREHISTOGRAMS::JTestSummary::parameterName

Parameter evaluated by the test.

Definition at line 178 of file JTestSummary.hh.

◆ parameterValue

double JCOMPAREHISTOGRAMS::JTestSummary::parameterValue

Value of the parameter evaluated by the test.

Definition at line 179 of file JTestSummary.hh.

◆ parameterThreshold

double JCOMPAREHISTOGRAMS::JTestSummary::parameterThreshold

Threshold to evaluate the parameter.

Definition at line 180 of file JTestSummary.hh.

◆ passed

bool JCOMPAREHISTOGRAMS::JTestSummary::passed

True if the test passed.

Definition at line 181 of file JTestSummary.hh.

◆ passed_h

std::string JCOMPAREHISTOGRAMS::JTestSummary::passed_h

Human readable version of passed.

Definition at line 182 of file JTestSummary.hh.

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

JTestSummary.hh

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JTestSummary() [1/2]

◆ JTestSummary() [2/2]

Member Function Documentation

◆ getEquationParameters()

◆ setEquationParameters()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

Friends And Related Function Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ testName

◆ histogramA

◆ histogramB

◆ parameterName

◆ parameterValue

◆ parameterThreshold

◆ passed

◆ passed_h