Belle II Software development
Axis Class Reference

This class unites some parameters for Factory which describe one axis of histogram. More...

#include <HistogramFactory.h>

Public Member Functions

 Axis ()
 Constructor.
 
 Axis (int nbins, double low, double up, std::string title)
 Constructor.
 
Axisnbins (int nbins)
 Set value of nbins.
 
Axislow (double low)
 Set value of low.
 
Axisup (double up)
 Set value of up.
 
Axistitle (std::string title)
 Set value of title.
 

Private Attributes

Parameter< int > m_nbins = Parameter(0)
 number of bins in the axis
 
Parameter< double > m_low = Parameter(.0)
 lower boundary of axis range
 
Parameter< double > m_up = Parameter(.0)
 upper boundary of axis range
 
Parameter< std::string > m_title = Parameter(std::string())
 title of axis
 

Friends

class Factory
 

Detailed Description

This class unites some parameters for Factory which describe one axis of histogram.

Those parameters are nbins, low, up and title.

Definition at line 104 of file HistogramFactory.h.

Constructor & Destructor Documentation

◆ Axis() [1/2]

Axis ( )
inline

Constructor.

Definition at line 107 of file HistogramFactory.h.

107{}

◆ Axis() [2/2]

Axis ( int  nbins,
double  low,
double  up,
std::string  title 
)
inline

Constructor.

Parameters
nbins- number of bins along the axis
low- lower boundary of axis range
up- upper boundary of axis range
title- title of the axis

Definition at line 114 of file HistogramFactory.h.

115 {
117 m_low.Set(low);
118 m_up.Set(up);
120 }
Parameter< double > m_low
lower boundary of axis range
Parameter< std::string > m_title
title of axis
Axis & nbins(int nbins)
Set value of nbins.
Axis & up(double up)
Set value of up.
Parameter< double > m_up
upper boundary of axis range
Axis & low(double low)
Set value of low.
Axis & title(std::string title)
Set value of title.
Parameter< int > m_nbins
number of bins in the axis
void Set(const AType &value)
Permanently sets inner quantity to given value.

Member Function Documentation

◆ low()

Axis & low ( double  low)
inline

Set value of low.

Definition at line 125 of file HistogramFactory.h.

125{ m_low.Set(low); return *this; }

◆ nbins()

Axis & nbins ( int  nbins)
inline

Set value of nbins.

Definition at line 123 of file HistogramFactory.h.

123{ m_nbins.Set(nbins); return *this; }

◆ title()

Axis & title ( std::string  title)
inline

Set value of title.

Definition at line 129 of file HistogramFactory.h.

129{ m_title.Set(title); return *this; }

◆ up()

Axis & up ( double  up)
inline

Set value of up.

Definition at line 127 of file HistogramFactory.h.

127{ m_up.Set(up); return *this; }

Friends And Related Function Documentation

◆ Factory

friend class Factory
friend

Definition at line 141 of file HistogramFactory.h.

Member Data Documentation

◆ m_low

Parameter<double> m_low = Parameter(.0)
private

lower boundary of axis range

Definition at line 135 of file HistogramFactory.h.

◆ m_nbins

Parameter<int> m_nbins = Parameter(0)
private

number of bins in the axis

Definition at line 133 of file HistogramFactory.h.

◆ m_title

Parameter<std::string> m_title = Parameter(std::string())
private

title of axis

Definition at line 139 of file HistogramFactory.h.

◆ m_up

Parameter<double> m_up = Parameter(.0)
private

upper boundary of axis range

Definition at line 137 of file HistogramFactory.h.


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