#include <HistogramDefinitionSvc.h>

Inheritance diagram for HistogramDefinitionSvc:

Collaboration diagram for HistogramDefinitionSvc:

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
	HistogramDefinitionSvc (const std::string &name, ISvcLocator *svc)

virtual	~HistogramDefinitionSvc ()

virtual StatusCode	initialize ()

virtual StatusCode	finalize ()

virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)

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

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

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

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

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

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

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

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

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

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

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

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

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	reimplemented from IInterface More...

Private Member Functions
bool	sourceExists ()

bool	formatOk ()

Private Attributes
StringProperty	m_source

StringProperty	m_formatString

IHistogramDefinitionSvc::Formats	m_format

std::map< std::string, SingleHistogramDefinition >	m_histoDefMap

std::unique_ptr< IReadHistoDef >	m_reader

Friends
class	SvcFactory< HistogramDefinitionSvc >

Detailed Description

Definition at line 27 of file HistogramDefinitionSvc.h.

Member Typedef Documentation

◆ axesLimits_t

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

inherited

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

Definition at line 29 of file IHistogramDefinitionSvc.h.

Member Enumeration Documentation

◆ Formats

enum IHistogramDefinitionSvc::Formats

inherited

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

◆ HistogramDefinitionSvc()

HistogramDefinitionSvc::HistogramDefinitionSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Definition at line 25 of file HistogramDefinitionSvc.cxx.

                                                                                               :
   AthService(name, pSvcLocator), m_format{UNKNOWN}, m_reader{} {
   declareProperty("DefinitionSource", m_source);
   declareProperty("DefinitionFormat", m_formatString = "text/plain");
 }

◆ ~HistogramDefinitionSvc()

HistogramDefinitionSvc::~HistogramDefinitionSvc ( )

virtualdefault

Member Function Documentation

◆ definition()

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

finalvirtual

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

Implements IHistogramDefinitionSvc.

Definition at line 86 of file HistogramDefinitionSvc.cxx.

                                                                                         {
   SingleHistogramDefinition result;
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
  
   if (pthisHistoPair != m_histoDefMap.end()) {
     result = pthisHistoPair->second;
   }
   return result;
 }

◆ finalize()

StatusCode HistogramDefinitionSvc::finalize ( )

virtual

Definition at line 80 of file HistogramDefinitionSvc.cxx.

                                  {
   ATH_MSG_INFO("Reader initialised from " << m_reader->source() << " in " << m_reader->format() << " format.");
   return StatusCode::SUCCESS;
 }

◆ formatOk()

bool HistogramDefinitionSvc::formatOk ( )

private

Definition at line 221 of file HistogramDefinitionSvc.cxx.

                                  {
   return (m_format < NFORMATS)and(m_format >= 0);
 }

◆ histoType()

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

finalvirtual

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

Implements IHistogramDefinitionSvc.

Definition at line 97 of file HistogramDefinitionSvc.cxx.

                                                                                        {
   std::string result {};
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
  
   if (pthisHistoPair != m_histoDefMap.end()) {
     result = pthisHistoPair->second.histoType;
   }
   return result;
 }

◆ initialize()

StatusCode HistogramDefinitionSvc::initialize ( )

virtual

Definition at line 34 of file HistogramDefinitionSvc.cxx.

                                    {
   if (m_formatString.value() == defaultFormat) {
     m_format = TEXT_PLAIN;
   }
   if (m_formatString.value() == xmlFormat) {
     m_format = TEXT_XML;
   }
   if (m_format == UNKNOWN) {
     ATH_MSG_ERROR("Unknown format for the input to the hdef service");
     return StatusCode::FAILURE;
   }
   ATH_MSG_INFO("hdef source:" << m_source.value());
   ATH_MSG_INFO("Set format:" << m_formatString.value());
   ATH_MSG_INFO("format " << m_format);
   if (m_format == TEXT_PLAIN) {
     ATH_MSG_FATAL("Text format histogram definition files are deprecated.");
     return StatusCode::FAILURE;
   }
   if (m_format == TEXT_XML) {
     m_reader = std::make_unique<ReadFromXmlDom>(m_source.value());
   }
   ATH_MSG_INFO("Reader initialising from " << m_reader->source() << " in " << m_reader->format() << " format.");
   bool ok = m_reader->initialize();
   if (not ok) {
     ATH_MSG_WARNING("Reader did not initialise");
   }
   ok = m_reader->histoDefinitionMap(m_histoDefMap);
   bool allDefsOk(true);
   for (auto& h:m_histoDefMap) {
     if (not h.second.isValid()) {
       ATH_MSG_WARNING("Invalid histogram definition: " << h.second.str());
       allDefsOk = false;
     }
   }
   if (ok and(not allDefsOk)) {
     ATH_MSG_WARNING("Some histogram definitions were bad.");
     return StatusCode::RECOVERABLE;
   }
   if (not ok) {
     ATH_MSG_ERROR("The definition reader failed to read the histogram definitions.");
     return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
 }

◆ interfaceID()

const InterfaceID & IHistogramDefinitionSvc::interfaceID ( )

inlinestaticinherited

reimplemented from IInterface

Definition at line 57 of file IHistogramDefinitionSvc.h.

                                                                {
   static const InterfaceID IID("IHistogramDefinitionSvc",1,0);
   return IID;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< Service >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Service >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Service >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ nBinsX()

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

finalvirtual

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

Implements IHistogramDefinitionSvc.

Definition at line 119 of file HistogramDefinitionSvc.cxx.

                                                                                     {
   unsigned int nbins(0);
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
  
   if (pthisHistoPair != m_histoDefMap.end()) {
     nbins = pthisHistoPair->second.nBinsX;
   }
   return nbins;
 }

◆ nBinsY()

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

finalvirtual

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

Reimplemented from IHistogramDefinitionSvc.

Definition at line 130 of file HistogramDefinitionSvc.cxx.

                                                                                     {
   unsigned int nbins(0);
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
  
   if (pthisHistoPair != m_histoDefMap.end()) {
     nbins = pthisHistoPair->second.nBinsY;
   }
   return nbins;
 }

◆ nBinsZ()

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

finalvirtual

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

Reimplemented from IHistogramDefinitionSvc.

Definition at line 141 of file HistogramDefinitionSvc.cxx.

                                                                                     {
   unsigned int nbins(0);
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
  
   if (pthisHistoPair != m_histoDefMap.end()) {
     nbins = pthisHistoPair->second.nBinsZ;
   }
   return nbins;
 }

◆ queryInterface()

StatusCode HistogramDefinitionSvc::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)

virtual

Definition at line 226 of file HistogramDefinitionSvc.cxx.

                                                                                    {
   if (IIncidentListener::interfaceID().versionMatch(riid)) {
     *ppvInterface = dynamic_cast<IIncidentListener*>(this);
   } else if (IHistogramDefinitionSvc::interfaceID().versionMatch(riid)) {
     *ppvInterface = dynamic_cast<IHistogramDefinitionSvc*>(this);
   } else {
     // Interface is not directly available : try out a base class
     return AthService::queryInterface(riid, ppvInterface);
   }
   addRef();
   return StatusCode::SUCCESS;
 }

◆ sourceExists()

bool HistogramDefinitionSvc::sourceExists ( )

private

Definition at line 216 of file HistogramDefinitionSvc.cxx.

                                      {
   return m_reader->sourceExists();
 }

◆ title()

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

finalvirtual

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

Implements IHistogramDefinitionSvc.

Definition at line 108 of file HistogramDefinitionSvc.cxx.

                                                                                    {
   std::string result {};
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
  
   if (pthisHistoPair != m_histoDefMap.end()) {
     result = pthisHistoPair->second.title;
   }
   return result;
 }

◆ xLimits()

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

finalvirtual

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

Implements IHistogramDefinitionSvc.

Definition at line 152 of file HistogramDefinitionSvc.cxx.

                                                                                      {
   axesLimits_t result(invalidLimits);
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
  
   if (pthisHistoPair != m_histoDefMap.end()) {
     result = pthisHistoPair->second.xAxis;
   }
   return result;
 }

◆ xTitle()

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

finalvirtual

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

Implements IHistogramDefinitionSvc.

Definition at line 185 of file HistogramDefinitionSvc.cxx.

                                                                                     {
   std::string result {};
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
  
   if (pthisHistoPair != m_histoDefMap.end()) {
     result = pthisHistoPair->second.xTitle;
   }
   return result;
 }

◆ yLimits()

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

finalvirtual

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

Reimplemented from IHistogramDefinitionSvc.

Definition at line 163 of file HistogramDefinitionSvc.cxx.

                                                                                      {
   axesLimits_t result(invalidLimits);
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
  
   if (pthisHistoPair != m_histoDefMap.end()) {
     result = pthisHistoPair->second.yAxis;
   }
   return result;
 }

◆ yTitle()

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

finalvirtual

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

Implements IHistogramDefinitionSvc.

Definition at line 196 of file HistogramDefinitionSvc.cxx.

                                                                                     {
   std::string result {};
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
   if (pthisHistoPair != m_histoDefMap.end()) {
     result = pthisHistoPair->second.yTitle;
   }
   return result;
 }

◆ zLimits()

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

finalvirtual

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

Implements IHistogramDefinitionSvc.

Definition at line 174 of file HistogramDefinitionSvc.cxx.

                                                                                      {
   axesLimits_t result(invalidLimits);
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
  
   if (pthisHistoPair != m_histoDefMap.end()) {
     result = pthisHistoPair->second.zAxis;
   }
   return result;
 }

◆ zTitle()

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

finalvirtual

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

Implements IHistogramDefinitionSvc.

Definition at line 206 of file HistogramDefinitionSvc.cxx.

                                                                                     {
   std::string result {};
   const auto pthisHistoPair(m_histoDefMap.find(SingleHistogramDefinition::stringIndex(name, dirName)));
   if (pthisHistoPair != m_histoDefMap.end()) {
     result = pthisHistoPair->second.zTitle;
   }
   return result;
 }

Friends And Related Function Documentation

◆ SvcFactory< HistogramDefinitionSvc >

friend class SvcFactory< HistogramDefinitionSvc >

friend

Definition at line 1 of file HistogramDefinitionSvc.h.

Member Data Documentation

◆ m_format

IHistogramDefinitionSvc::Formats HistogramDefinitionSvc::m_format

private

Definition at line 55 of file HistogramDefinitionSvc.h.

◆ m_formatString

StringProperty HistogramDefinitionSvc::m_formatString

private

Definition at line 54 of file HistogramDefinitionSvc.h.

◆ m_histoDefMap

std::map<std::string, SingleHistogramDefinition> HistogramDefinitionSvc::m_histoDefMap

private

Definition at line 56 of file HistogramDefinitionSvc.h.

◆ m_reader

std::unique_ptr<IReadHistoDef> HistogramDefinitionSvc::m_reader

private

Definition at line 57 of file HistogramDefinitionSvc.h.

◆ m_source

StringProperty HistogramDefinitionSvc::m_source

private

Definition at line 53 of file HistogramDefinitionSvc.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ axesLimits_t

Member Enumeration Documentation

◆ Formats

Constructor & Destructor Documentation

◆ HistogramDefinitionSvc()

◆ ~HistogramDefinitionSvc()

Member Function Documentation

◆ definition()

◆ finalize()

◆ formatOk()

◆ histoType()

◆ initialize()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ nBinsX()

◆ nBinsY()

◆ nBinsZ()

◆ queryInterface()

◆ sourceExists()

◆ title()

◆ xLimits()

◆ xTitle()

◆ yLimits()

◆ yTitle()

◆ zLimits()

◆ zTitle()

Friends And Related Function Documentation

◆ SvcFactory< HistogramDefinitionSvc >

Member Data Documentation

◆ m_format

◆ m_formatString

◆ m_histoDefMap

◆ m_reader

◆ m_source