Interface class to get the histogram definition for a named histogram in a given directory. More...

#include <IHistogramDefinitionSvc.h>

Inheritance diagram for IHistogramDefinitionSvc:

Collaboration diagram for IHistogramDefinitionSvc:

Public Types
enum	Formats { UNKNOWN, TEXT_XML, TEXT_PLAIN, NFORMATS }
	Format of the data source holding the histogram definition. More...

typedef std::pair< float, float >	axesLimits_t
	typedef for axes limits, (lower bound, upper bound) More...

Public Member Functions
	DeclareInterfaceID (IHistogramDefinitionSvc, 1, 0)

virtual	~IHistogramDefinitionSvc ()
	Virtual destructor does nothing. More...

virtual SingleHistogramDefinition	definition (const std::string &name, const std::string &dirName="") const =0
	Return a histogram definition, retrieved by histogram identifier (and directory name, if supplied) More...

virtual std::string	histoType (const std::string &name, const std::string &dirName="") const =0
	Return Histogram type (TH1, TH2 etc) by histogram identifier (and directory name, if supplied) More...

virtual std::string	title (const std::string &name, const std::string &dirName="") const =0
	Return Histogram title by histogram identifier (and directory name, if supplied) More...

virtual unsigned int	nBinsX (const std::string &name, const std::string &dirName="") const =0
	Return number of x bins by histogram identifier (and directory name, if supplied) More...

virtual unsigned int	nBinsY (const std::string &, const std::string &="") const
	Return number of y bins by histogram identifier (and directory name, if supplied); default returns 0 for 1-D histos. More...

virtual unsigned int	nBinsZ (const std::string &, const std::string &="") const
	Return number of z bins by histogram identifier (and directory name, if supplied); default returns 0 for 1-D histos. More...

virtual axesLimits_t	xLimits (const std::string &name, const std::string &dirName="") const =0
	Return x axes (lo,hi) by histogram identifier (and directory name, if supplied) More...

virtual axesLimits_t	yLimits (const std::string &, const std::string &="") const
	Return y axes (lo,hi) by histogram identifier (and directory name, if supplied). Default returns (nan,nan). More...

virtual axesLimits_t	zLimits (const std::string &name, const std::string &dirName="") const =0
	Return z axes (lo,hi) by histogram identifier (and directory name, if supplied) More...

virtual std::string	xTitle (const std::string &name, const std::string &dirName="") const =0
	Return x-axis title by histogram identifier (and directory name, if supplied) More...

virtual std::string	yTitle (const std::string &name, const std::string &dirName="") const =0
	Return y-axis title by histogram identifier (and directory name, if supplied) More...

virtual std::string	zTitle (const std::string &name, const std::string &dirName="") const =0
	Return z-axis title by histogram identifier (and directory name, if supplied) More...

Detailed Description

Interface class to get the histogram definition for a named histogram in a given directory.

Definition at line 20 of file IHistogramDefinitionSvc.h.

Member Typedef Documentation

◆ axesLimits_t

typedef std::pair<float, float> IHistogramDefinitionSvc::axesLimits_t

typedef for axes limits, (lower bound, upper bound)

Definition at line 29 of file IHistogramDefinitionSvc.h.

Member Enumeration Documentation

◆ Formats

enum IHistogramDefinitionSvc::Formats

Format of the data source holding the histogram definition.

Enumerator
UNKNOWN
TEXT_XML
TEXT_PLAIN
NFORMATS

Definition at line 25 of file IHistogramDefinitionSvc.h.

25 {UNKNOWN,TEXT_XML,TEXT_PLAIN,NFORMATS};

Constructor & Destructor Documentation

◆ ~IHistogramDefinitionSvc()

virtual IHistogramDefinitionSvc::~IHistogramDefinitionSvc ( )

inlinevirtual

Virtual destructor does nothing.

Definition at line 27 of file IHistogramDefinitionSvc.h.

27 {}

Member Function Documentation

◆ DeclareInterfaceID()

IHistogramDefinitionSvc::DeclareInterfaceID	(	IHistogramDefinitionSvc	,
		1	,
		0
	)

◆ definition()

virtual SingleHistogramDefinition IHistogramDefinitionSvc::definition	(	const std::string &	name,
		const std::string &	dirName = `""`
	)		const

pure virtual

Return a histogram definition, retrieved by histogram identifier (and directory name, if supplied)

◆ histoType()

virtual std::string IHistogramDefinitionSvc::histoType	(	const std::string &	name,
		const std::string &	dirName = `""`
	)		const

pure virtual

Return Histogram type (TH1, TH2 etc) by histogram identifier (and directory name, if supplied)

◆ nBinsX()

virtual unsigned int IHistogramDefinitionSvc::nBinsX	(	const std::string &	name,
		const std::string &	dirName = `""`
	)		const

pure virtual

Return number of x bins by histogram identifier (and directory name, if supplied)

◆ nBinsY()

virtual unsigned int IHistogramDefinitionSvc::nBinsY	(	const std::string &	,
		const std::string &	= `""`
	)		const

inlinevirtual

Return number of y bins by histogram identifier (and directory name, if supplied); default returns 0 for 1-D histos.

Definition at line 39 of file IHistogramDefinitionSvc.h.

39 { return 0; }

◆ nBinsZ()

virtual unsigned int IHistogramDefinitionSvc::nBinsZ	(	const std::string &	,
		const std::string &	= `""`
	)		const

inlinevirtual

Return number of z bins by histogram identifier (and directory name, if supplied); default returns 0 for 1-D histos.

Definition at line 41 of file IHistogramDefinitionSvc.h.

41 { return 0; }

◆ title()

virtual std::string IHistogramDefinitionSvc::title	(	const std::string &	name,
		const std::string &	dirName = `""`
	)		const

pure virtual

Return Histogram title by histogram identifier (and directory name, if supplied)

◆ xLimits()

virtual axesLimits_t IHistogramDefinitionSvc::xLimits	(	const std::string &	name,
		const std::string &	dirName = `""`
	)		const

pure virtual

Return x axes (lo,hi) by histogram identifier (and directory name, if supplied)

◆ xTitle()

virtual std::string IHistogramDefinitionSvc::xTitle	(	const std::string &	name,
		const std::string &	dirName = `""`
	)		const

pure virtual

Return x-axis title by histogram identifier (and directory name, if supplied)

◆ yLimits()

virtual axesLimits_t IHistogramDefinitionSvc::yLimits	(	const std::string &	,
		const std::string &	= `""`
	)		const

inlinevirtual

Return y axes (lo,hi) by histogram identifier (and directory name, if supplied). Default returns (nan,nan).

Definition at line 45 of file IHistogramDefinitionSvc.h.

45 {return std::make_pair(std::numeric_limits<float>::quiet_NaN(),std::numeric_limits<float>::quiet_NaN());}

◆ yTitle()

virtual std::string IHistogramDefinitionSvc::yTitle	(	const std::string &	name,
		const std::string &	dirName = `""`
	)		const

pure virtual

Return y-axis title by histogram identifier (and directory name, if supplied)

◆ zLimits()

virtual axesLimits_t IHistogramDefinitionSvc::zLimits	(	const std::string &	name,
		const std::string &	dirName = `""`
	)		const

pure virtual

Return z axes (lo,hi) by histogram identifier (and directory name, if supplied)

◆ zTitle()

virtual std::string IHistogramDefinitionSvc::zTitle	(	const std::string &	name,
		const std::string &	dirName = `""`
	)		const

pure virtual

Return z-axis title by histogram identifier (and directory name, if supplied)

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

IHistogramDefinitionSvc.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ axesLimits_t

Member Enumeration Documentation

◆ Formats

Constructor & Destructor Documentation

◆ ~IHistogramDefinitionSvc()

Member Function Documentation

◆ DeclareInterfaceID()

◆ definition()

◆ histoType()

◆ nBinsX()

◆ nBinsY()

◆ nBinsZ()

◆ title()

◆ xLimits()

◆ xTitle()

◆ yLimits()

◆ yTitle()

◆ zLimits()

◆ zTitle()