RestFrames::HistPlotVar Class Reference

Detailed Description

Definition at line 40 of file HistPlotVar.hh.

Inheritance diagram for RestFrames::HistPlotVar:

Public Member Functions
	HistPlotVar (const std::string &name, const std::string &title, double minval, double maxval, const std::string &unit)
	Standard constructor. More...
	HistPlotVar ()
	Empty constructor.
void	operator= (double val) const
	Tests whether val is the same as this object's value. More...
void	operator+= (double val) const
	Operator to add val to this object's value. More...
void	operator-= (double val) const
	Operator to substract val from this object's value. More...
void	operator*= (double val) const
	Operator to multiply val to this object's value. More...
void	operator/= (double val) const
	Operator to divide val from object's value. More...
	operator double () const
	Casts this object to a double.
double	GetVal () const
	Returns this object's value. More...
double	GetMin () const
	Returns minimum value of histogram. More...
double	GetMax () const
	Returns maximum value of histogram. More...
std::string	GetUnit () const
	Returns unit of x-axis. More...
Public Member Functions inherited from RestFrames::RFBase
	RFBase (const std::string &sname, const std::string &stitle, int key)
	Standard constructor. More...
	RFBase ()
	Empty constructor.
virtual void	Clear ()
	Clears RFBase of all connections to other objects.
bool	IsEmpty () const
	Checks whether this is default (empty) instance of class.
bool	operator! () const
	Tests whether key is the same as this.
void	Print (LogType type) const
	Print information associated with object.
virtual std::string	PrintString (LogType type) const
	String of information associated with object.
RFKey	GetKey () const
	gets object identification key
std::string	GetName () const
	Returns object name.
std::string	GetTitle () const
	Returns object title.
bool	IsSame (const RFKey &key) const
	Tests whether key is the same as this.
bool	IsSame (const RFBase &obj) const
	Tests whether obj is the same as this.
bool	operator== (const RFKey &key) const
	Tests whether key is the same as this.
bool	operator== (const RFBase &obj) const
	Tests whether obj is the same as this.
bool	operator!= (const RFKey &key) const
	Tests whether key is the same as this.
bool	operator!= (const RFBase &obj) const
	Tests whether obj is the same as this.

Static Public Member Functions
static HistPlotVar &	Empty ()
	Returns empty HistPlotVar. More...
Static Public Member Functions inherited from RestFrames::RFBase
static RFBase &	Empty ()
	Returns empty RFBase. More...

Additional Inherited Members
Protected Member Functions inherited from RestFrames::RFBase
bool	SetBody (bool body) const
bool	SetMind (bool mind) const
bool	SetSpirit (bool spirit) const
virtual bool	IsSoundBody () const
virtual bool	IsSoundMind () const
virtual bool	IsSoundSpirit () const
void	UnSoundBody (const std::string &function) const
void	UnSoundMind (const std::string &function) const
void	UnSoundSpirit (const std::string &function) const
void	AddDependent (RFBase *dep)
	pointer to RFBase object owned by this one
Protected Attributes inherited from RestFrames::RFBase
RFLog	m_Log
RFBase *	m_This
Static Protected Attributes inherited from RestFrames::RFBase
static const TVector3	m_Empty3Vector
static const TLorentzVector	m_Empty4Vector

Constructor & Destructor Documentation

HistPlotVar()

RestFrames::HistPlotVar::HistPlotVar	(	const std::string &	name,
		const std::string &	title,
		double	minval,
		double	maxval,
		const std::string &	unit = ""
	)

Standard constructor.

Parameters

name	class instance name used for log statements
title	class instance title used in figures
minval	Minimum value of histogram
maxval	Maximum value of histogram
unit	Units of the x-axis, used to print information about the object

Definition at line 41 of file HistPlotVar.cc.

Member Function Documentation

Empty()

HistPlotVar & RestFrames::HistPlotVar::Empty ( )

static

Returns empty HistPlotVar.

Returns

Empty HistPlotVar

Definition at line 53 of file HistPlotVar.cc.

GetMax()

double RestFrames::HistPlotVar::GetMax

(

)

const

Returns maximum value of histogram.

Returns

Maximum value of histogram

Definition at line 93 of file HistPlotVar.cc.

GetMin()

double RestFrames::HistPlotVar::GetMin

(

)

const

Returns minimum value of histogram.

Returns

Minimum value of histogram

Definition at line 89 of file HistPlotVar.cc.

GetUnit()

std::string RestFrames::HistPlotVar::GetUnit

(

)

const

Returns unit of x-axis.

Returns

Unit of x-axis

Definition at line 85 of file HistPlotVar.cc.

GetVal()

double RestFrames::HistPlotVar::GetVal

(

)

const

Returns this object's value.

Returns

Object's value

Definition at line 81 of file HistPlotVar.cc.

operator*=()

void RestFrames::HistPlotVar::operator*=

(

double

val

)

const

Operator to multiply val to this object's value.

Parameters

val	Value to to multiply

Method to set m_Val as the solution of m_Val multiplied by__val__

Definition at line 69 of file HistPlotVar.cc.

operator+=()

void RestFrames::HistPlotVar::operator+=

(

double

val

)

const

Operator to add val to this object's value.

Parameters

val	Value to add

Method to set m_Val as the solution of adding val to m_Val

Definition at line 61 of file HistPlotVar.cc.

operator-=()

void RestFrames::HistPlotVar::operator-=

(

double

val

)

const

Operator to substract val from this object's value.

Parameters

val	Value to substract

Method to set m_Val as the solution of substracting val from m_Val

Definition at line 65 of file HistPlotVar.cc.

operator/=()

void RestFrames::HistPlotVar::operator/=

(

double

val

)

const

Operator to divide val from object's value.

Parameters

val	Value to divide by

Method to set m_Val as the solution of m_Val divided by__val__

Definition at line 73 of file HistPlotVar.cc.

operator=()

void RestFrames::HistPlotVar::operator=

(

double

val

)

const

Tests whether val is the same as this object's value.

Parameters

val	Value to test

Definition at line 57 of file HistPlotVar.cc.

Collaboration diagram for RestFrames::HistPlotVar:

---

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

• inc/RestFrames/HistPlotVar.hh
• src/HistPlotVar.cc