HistogramDefinitionSvc Class Reference

#include <HistogramDefinitionSvc.h>

Inheritance diagram for HistogramDefinitionSvc:

Collaboration diagram for HistogramDefinitionSvc:

Public Member Functions
	HistogramDefinitionSvc (const std::string &name, ISvcLocator *svc)
virtual	~HistogramDefinitionSvc ()
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
SingleHistogramDefinition	definition (std::string_view name, std::string_view dirName="") const final
std::string	histoType (std::string_view name, std::string_view dirName="") const final
std::string	title (std::string_view name, std::string_view dirName="") const final
unsigned int	nBinsX (std::string_view name, std::string_view dirName="") const final
unsigned int	nBinsY (std::string_view name, std::string_view dirName="") const final
unsigned int	nBinsZ (std::string_view name, std::string_view dirName="") const final
IHistogramDefinitionSvc::axesLimits_t	xLimits (std::string_view name, std::string_view dirName="") const final
IHistogramDefinitionSvc::axesLimits_t	yLimits (std::string_view name, std::string_view dirName="") const final
IHistogramDefinitionSvc::axesLimits_t	zLimits (std::string_view name, std::string_view dirName="") const final
std::string	xTitle (std::string_view name, std::string_view dirName="") const final
std::string	yTitle (std::string_view name, std::string_view dirName="") const final
std::string	zTitle (std::string_view name, std::string_view dirName="") const final

Private Member Functions
bool	sourceExists ()
bool	formatOk ()

Private Attributes
StringProperty	m_source {this, "DefinitionSource"}
StringProperty	m_formatString {this, "DefinitionFormat", "text/plain"}
IHistogramDefinitionSvc::Formats	m_format
std::map< std::string, SingleHistogramDefinition >	m_histoDefMap
std::unique_ptr< IReadHistoDef >	m_reader

Detailed Description

Definition at line 26 of file HistogramDefinitionSvc.h.

Constructor & Destructor Documentation

HistogramDefinitionSvc()

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

Definition at line 25 of file HistogramDefinitionSvc.cxx.

                                                                                              :
  base_class(name, pSvcLocator), m_format{UNKNOWN}, m_reader{} {}

~HistogramDefinitionSvc()

HistogramDefinitionSvc::~HistogramDefinitionSvc ( )

virtualdefault

Member Function Documentation

definition()

SingleHistogramDefinition HistogramDefinitionSvc::definition ( std::string_view name, std::string_view dirName = "" ) const

final

Definition at line 83 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 77 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 218 of file HistogramDefinitionSvc.cxx.

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

histoType()

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

final

Definition at line 94 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 31 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;
}

nBinsX()

unsigned int HistogramDefinitionSvc::nBinsX ( std::string_view name, std::string_view dirName = "" ) const

final

Definition at line 116 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 ( std::string_view name, std::string_view dirName = "" ) const

final

Definition at line 127 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 ( std::string_view name, std::string_view dirName = "" ) const

final

Definition at line 138 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;
}

sourceExists()

bool HistogramDefinitionSvc::sourceExists ( )

private

Definition at line 213 of file HistogramDefinitionSvc.cxx.

                                     {
  return m_reader->sourceExists();
}

title()

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

final

Definition at line 105 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 ( std::string_view name, std::string_view dirName = "" ) const

final

Definition at line 149 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 ( std::string_view name, std::string_view dirName = "" ) const

final

Definition at line 182 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 ( std::string_view name, std::string_view dirName = "" ) const

final

Definition at line 160 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 ( std::string_view name, std::string_view dirName = "" ) const

final

Definition at line 193 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 ( std::string_view name, std::string_view dirName = "" ) const

final

Definition at line 171 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 ( std::string_view name, std::string_view dirName = "" ) const

final

Definition at line 203 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;
}

Member Data Documentation

m_format

IHistogramDefinitionSvc::Formats HistogramDefinitionSvc::m_format

private

Definition at line 51 of file HistogramDefinitionSvc.h.

m_formatString

StringProperty HistogramDefinitionSvc::m_formatString {this, "DefinitionFormat", "text/plain"}

private

Definition at line 50 of file HistogramDefinitionSvc.h.

{this, "DefinitionFormat", "text/plain"};

m_histoDefMap

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

private

Definition at line 52 of file HistogramDefinitionSvc.h.

m_reader

std::unique_ptr<IReadHistoDef> HistogramDefinitionSvc::m_reader

private

Definition at line 53 of file HistogramDefinitionSvc.h.

m_source

StringProperty HistogramDefinitionSvc::m_source {this, "DefinitionSource"}

private

Definition at line 49 of file HistogramDefinitionSvc.h.

{this, "DefinitionSource"};

---

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

• HistogramDefinitionSvc.h
• HistogramDefinitionSvc.cxx