PARTONS::ErrorBar< T > Class Template Reference

Class representing single asymmetrical error bar. More...

Inheritance diagram for PARTONS::ErrorBar< T >:

Public Member Functions
	ErrorBar ()
	Default constructor. More...
	ErrorBar (T lowerBound, T upperBound)
	Assignment constructor. More...
	ErrorBar (const ErrorBar &other)
	Copy constructor. More...
virtual	~ErrorBar ()
	Destructor. More...
virtual std::string	toString () const
	Return a pre-formatted characters string for output visualization of class member's values. More...
T	getLowerBound () const
	Get lower bound of the uncertainty. More...
T	getUpperBound () const
	Get upper bound of the uncertainty. More...
void	setBounds (T lowerBound, T upperBound)
	Set lower and upper bounds of the uncertainty. More...
bool	isInitialized () const
	Check if initialized. More...
void	setInitialized (bool initialized)
	Set if initialized. More...
Public Member Functions inherited from PARTONS::BaseObject
	BaseObject (const std::string &className)
	Constructor. More...
virtual	~BaseObject ()
	Default destructor. More...
virtual BaseObject *	clone () const
	Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...
virtual void	resolveObjectDependencies ()
	Because of the initialization step order of the program, objects are registered in a total random order and some objects depend on others. More...
void	serialize (ElemUtils::Packet &packet) const
	Used to split a complex C++ object into a concatenation of simple types. More...
void	unserialize (ElemUtils::Packet &packet)
	Used to rebuild a complex C++ object from a concatenation of simple type. More...
bool	operator< (const BaseObject &other) const
	Overload of < operator to sort BaseObject object by its indexId value. More...
const std::string &	getClassName () const
unsigned int	getObjectId () const
int	getIndexId () const
void	setIndexId (int indexId)

Private Attributes
bool	m_initialized
	True if value initialized. More...
T	m_lowerBound
	Lower bound of the uncertainty. More...
T	m_upperBound
	Upper bound of the uncertainty. More...

Additional Inherited Members
Protected Member Functions inherited from PARTONS::BaseObject
	BaseObject (const BaseObject &other)
	Copy constructor. More...
void	info (const std::string &functionName, const std::string &message) const
	Print info message into logger. More...
void	debug (const std::string &functionName, const std::string &message) const
	Print debug message into logger. More...
void	warn (const std::string &functionName, const std::string &message) const
	Print warning message into logger. More...
void	errorMissingParameter (const std::string &parameterName) const
	Use in automation process to throw exception when a parameter is missing from the XML scenario file. More...

Detailed Description

template<class T>
class PARTONS::ErrorBar< T >

Class representing single asymmetrical error bar.

This class represents a single asymmetrical error bar. It is used in particular to handle experimental data.

Constructor & Destructor Documentation

ErrorBar() [1/3]

template<class T >

PARTONS::ErrorBar< T >::ErrorBar ( )

inline

Default constructor.

ErrorBar() [2/3]

template<class T >

PARTONS::ErrorBar< T >::ErrorBar ( T  lowerBound, T  upperBound  )

inline

Assignment constructor.

Parameters

lowerBound	Lower bound of the uncertainty.
upperBound	Upper bound of the uncertainty.

ErrorBar() [3/3]

template<class T >

PARTONS::ErrorBar< T >::ErrorBar ( const ErrorBar< T > &  other )

inline

Copy constructor.

~ErrorBar()

template<class T >

virtual PARTONS::ErrorBar< T >::~ErrorBar ( )

inlinevirtual

Destructor.

Member Function Documentation

getLowerBound()

template<class T >

T PARTONS::ErrorBar< T >::getLowerBound ( ) const

inline

Get lower bound of the uncertainty.

getUpperBound()

template<class T >

T PARTONS::ErrorBar< T >::getUpperBound ( ) const

inline

Get upper bound of the uncertainty.

isInitialized()

template<class T >

bool PARTONS::ErrorBar< T >::isInitialized ( ) const

inline

Check if initialized.

setBounds()

template<class T >

void PARTONS::ErrorBar< T >::setBounds ( T  lowerBound, T  upperBound  )

inline

Set lower and upper bounds of the uncertainty.

setInitialized()

template<class T >

void PARTONS::ErrorBar< T >::setInitialized ( bool  initialized )

inline

Set if initialized.

toString()

template<class T >

virtual std::string PARTONS::ErrorBar< T >::toString ( ) const

inlinevirtual

Return a pre-formatted characters string for output visualization of class member's values.

Returns

a pre-formatted characters string.

Reimplemented from PARTONS::BaseObject.

Member Data Documentation

m_initialized

template<class T >

bool PARTONS::ErrorBar< T >::m_initialized

private

True if value initialized.

m_lowerBound

template<class T >

T PARTONS::ErrorBar< T >::m_lowerBound

private

Lower bound of the uncertainty.

m_upperBound

template<class T >

T PARTONS::ErrorBar< T >::m_upperBound

private

Upper bound of the uncertainty.

---

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

• include/partons/utils/math/ErrorBar.h