Singleton class responsible for loading detector parameters from an XML file. More...

#include <Gearbox.h>

Inheritance diagram for Gearbox:

Collaboration diagram for Gearbox:

[legend]

Classes
struct	PathOverride
	Struct to override a path in the XML file with a custom value. More...

struct	PathValue
	Struct for caching results from the xml file. More...

Public Types
enum	{ c_DefaultCacheSize = 200 }
	Default cache size (in entries) for the Gearbox. More...

Public Member Functions
	~Gearbox ()
	Free structures on destruction.

void	setBackends (const std::vector< std::string > &backends)
	Select the backends to use to find resources.

void	clearBackends ()
	Clear list of backends.

void	addOverride (const PathOverride &poverride)
	Add an override for a given XPath expression.

void	clearOverrides ()
	Clear all existing overrides.

void	open (const std::string &name="Belle2.xml", size_t cacheSize=c_DefaultCacheSize)
	Open connection to backend and parse tree.

void	close ()
	Free internal structures of previously parsed tree and clear cache.

bool	isOpen () const
	Return the state of the Gearbox.

virtual int	getNumberNodes (const std::string &path="") const override
	Return the number of nodes a given path will expand to.

virtual std::string	getString (const std::string &path="") const noexcept(false) override
	Get the parameter path as a string.

std::string	getString (const std::string &path, const std::string &defaultValue) const
	Get the parameter path as a string.

virtual std::pair< std::string, std::string >	getStringWithUnit (const std::string &path="") const noexcept(false) override
	Get the parameter path as string and also return the unit it was defined with.

virtual const TObject *	getTObject (const std::string &path) const noexcept(false) override
	Get the parameter path as a TObject.

GearDir	getDetectorComponent (const std::string &component)
	Return GearDir representing a given DetectorComponent.

bool	exists (const std::string &path="") const
	Check if a given parameter path exists.

	operator bool () const
	Convert to bool to simplify checking of existence.

std::vector< GearDir >	getNodes (const std::string &path="") const
	Get vector of GearDirs which point to all the nodes the given path evaluates to.

std::string	getPath () const
	Return path of the current interface.

double	getDouble (const std::string &path="") const noexcept(false)
	Get the parameter path as a double.

double	getDouble (const std::string &path, double defaultValue) const noexcept(false)
	Get the parameter path as a double.

int	getInt (const std::string &path="") const noexcept(false)
	Get the parameter path as a int.

int	getInt (const std::string &path, int defaultValue) const noexcept(false)
	Get the parameter path as a int.

bool	getBool (const std::string &path="") const noexcept(false)
	Get the parameter path as a bool.

bool	getBool (const std::string &path, bool defaultValue) const
	Get the parameter path as a bool.

double	getWithUnit (const std::string &path) const noexcept(false)
	Get the parameter path as a double converted to the standard unit.

double	getWithUnit (const std::string &path, double defaultValue) const noexcept(false)
	Get the parameter path as a double converted to the standard unit.

std::vector< double >	getArray (const std::string &path) const noexcept(false)
	Get the parameter path as a list of double values converted to the standard unit.

std::vector< double >	getArray (const std::string &path, const std::vector< double > &defaultValue) const noexcept(false)
	Get the parameter path as a list of double values converted to the standard unit.

double	getLength (const std::string &path="") const noexcept(false)
	Get the parameter path as a double converted to the standard length unit.

double	getLength (const std::string &path, double defaultValue) const noexcept(false)
	Get the parameter path as a double converted to the standard length unit.

double	getAngle (const std::string &path="") const noexcept(false)
	Get the parameter path as a double converted to the standard angle unit.

double	getAngle (const std::string &path, double defaultValue) const noexcept(false)
	Get the parameter path as a double converted to the standard angle unit.

double	getEnergy (const std::string &path="") const noexcept(false)
	Get the parameter path as a double converted to the standard energy unit.

double	getEnergy (const std::string &path, double defaultValue) const noexcept(false)
	Get the parameter path as a double converted to the standard energy unit.

double	getDensity (const std::string &path="") const noexcept(false)
	Get the parameter path as a double converted to the standard density unit.

double	getDensity (const std::string &path, double defaultValue) const noexcept(false)
	Get the parameter path as a double converted to the standard density unit.

double	getTime (const std::string &path="") const noexcept(false)
	Get the parameter path as a double converted to the standard time unit.

double	getTime (const std::string &path, double defaultValue) const noexcept(false)
	Get the parameter path as a double converted to the standard time unit.

double	getFrequency (const std::string &path="") const noexcept(false)
	Get the parameter path as a double converted to the standard frequency unit.

double	getFrequency (const std::string &path, double defaultValue) const noexcept(false)
	Get the parameter path as a double converted to the standard frequency unit.

Static Public Member Functions
static Gearbox &	getInstance ()
	Return reference to the Gearbox instance.

static void	registerInputHandler (const std::string &prefix, gearbox::InputHandler::Factory *factory)
	Register a new input handler.

Protected Member Functions
std::string	ensureNode (const std::string &path) const
	make sure the path really corresponds to an XPath node expression by removing trailing slashes

std::string	ensurePath (const std::string &path) const
	make sure the path really corresponds to a path by appending a trailing slash if neccessary

std::string	addIndex (const std::string &path, int index) const
	add [index] to the path (after stripping trailing slashes)

std::string	joinPath (const std::string &path, const std::string &subpath) const
	joind to paths, inserting a slash if neccessary

Protected Attributes
std::string	m_path
	path of the current interface

Private Member Functions
	Gearbox ()
	Singleton: private constructor.

	Gearbox (const Gearbox &)=delete
	Singleton: private copy constructor.

Gearbox &	operator= (const Gearbox &)=delete
	Also no assignment operator.

gearbox::InputContext *	openXmlUri (const std::string &uri) const
	Function to be called when libxml requests a new input uri to be opened.

void	overridePathValue (const PathOverride &poverride)
	Change the value of a given path expression.

PathValue	getPathValue (const std::string &path) const
	Return the (cached) value of a given path.

Private Attributes
xmlDocPtr	m_xmlDocument
	Pointer to the libxml Document structure.

xmlXPathContextPtr	m_xpathContext
	Pointer to the libxml XPath context.

MRUCache< std::string, PathValue > *	m_parameterCache
	Cache for already queried paths.

std::map< std::string, TObject * >	m_ownedObjects
	Map of queried objects (path -> TObject*).

std::vector< gearbox::InputHandler * >	m_handlers
	List of input handlers which will be used to find resources.

std::map< std::string, gearbox::InputHandler::Factory * >	m_registeredHandlers
	Map of registered InputHandlers.

std::vector< PathOverride >	m_overrides
	the existing overrides

Friends
void *	gearbox::openXmlUri (const char *)
	friend to internal c-like function to interface libxml2 callback

Detailed Description

Singleton class responsible for loading detector parameters from an XML file.

See also: GearboxModule

Definition at line 34 of file Gearbox.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Default cache size (in entries) for the Gearbox.

Definition at line 37 of file Gearbox.h.

37{ c_DefaultCacheSize = 200 };

Member Function Documentation

◆ addIndex()

std::string addIndex	(	const std::string &	path,
		int	index
	)		const

protectedinherited

add [index] to the path (after stripping trailing slashes)

Definition at line 166 of file Interface.cc.

  {
    static boost::format index_fmt("%1%[%2%]");
    return (index_fmt % ensureNode(path) % index).str();
  }

◆ addOverride()

void addOverride ( const PathOverride & poverride )

inline

Add an override for a given XPath expression.

Definition at line 81 of file Gearbox.h.

    {
      m_overrides.push_back(poverride);
    }

◆ clearOverrides()

void clearOverrides ( )

inline

Clear all existing overrides.

Definition at line 87 of file Gearbox.h.

    {
      m_overrides.clear();
    }

◆ ensureNode()

std::string ensureNode ( const std::string & path ) const

protectedinherited

make sure the path really corresponds to an XPath node expression by removing trailing slashes

Definition at line 156 of file Interface.cc.

  {
    return boost::trim_right_copy_if(path, boost::is_any_of("/"));
  }

◆ ensurePath()

std::string ensurePath ( const std::string & path ) const

protectedinherited

make sure the path really corresponds to a path by appending a trailing slash if neccessary

Definition at line 161 of file Interface.cc.

  {
    return ensureNode(path) + '/';
  }

◆ exists()

bool exists ( const std::string & path = "" ) const

inlineinherited

Check if a given parameter path exists.

Returns: true if path exists, false otherwise

Definition at line 54 of file Interface.h.

54{ return getNumberNodes(path) > 0; }

Belle2::gearbox::Interface::getNumberNodes

virtual int getNumberNodes(const std::string &path="") const =0

Return the number of nodes a given path will expand to.

◆ getAngle() [1/2]

double getAngle	(	const std::string &	path,
		double	defaultValue
	)		const

inlineinherited

Get the parameter path as a double converted to the standard angle unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

If the parameter is empty or does not exist, the defaultValue will be returned.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 321 of file Interface.h.

      {
        return getWithUnit(path, defaultValue);
      }

◆ getAngle() [2/2]

double getAngle ( const std::string & path = "" ) const

inlineinherited

Get the parameter path as a double converted to the standard angle unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 299 of file Interface.h.

      {
        return getWithUnit(path);
      }

◆ getArray() [1/2]

std::vector< double > getArray ( const std::string & path ) const

inherited

Get the parameter path as a list of double values converted to the standard unit.

The content of the parameter will be split at whitespace, comma and semi-colon and returned as a vector of numbers

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 123 of file Interface.cc.

  {
    using tokenizer = boost::tokenizer<boost::char_separator<char> >;
    boost::char_separator<char> sep(",; \t\n\r");
 
    std::pair<std::string, std::string> value = getStringWithUnit(path);
    tokenizer tokens(value.first, sep);
    std::vector<double> result;
    double numValue(0);
    for (const std::string& tok : tokens) {
      try {
        numValue = boost::lexical_cast<double>(tok);
      } catch (boost::bad_lexical_cast&) {
        throw (ConversionError() << path << value.first);
      }
      if (!value.second.empty()) {
        numValue = Unit::convertValue(numValue, value.second);
      }
      result.push_back(numValue);
    }
    return result;
  }

◆ getArray() [2/2]

std::vector< double > getArray	(	const std::string &	path,
		const std::vector< double > &	defaultValue
	)		const

inherited

Get the parameter path as a list of double values converted to the standard unit.

The content of the parameter will be split at whitespace, comma and semi-colon and returned as a vector of numbers

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

If the parameter is empty or does not exist, the defaultValue will be returned.

Exceptions

gearbox::ConversionError if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 146 of file Interface.cc.

  {
    try {
      return getArray(path);
    } catch (PathEmptyError&) {
      return defaultValue;
    }
  }

◆ getBool() [1/2]

bool getBool	(	const std::string &	path,
		bool	defaultValue
	)		const

inherited

Get the parameter path as a bool.

If the parameter is empty or does not exist, the defaultValue will be returned.

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 88 of file Interface.cc.

  {
    try {
      return getBool(path);
    } catch (PathEmptyError&) {
      return defaultValue;
    }
  }

◆ getBool() [2/2]

bool getBool ( const std::string & path = "" ) const

inherited

Get the parameter path as a bool.

Exceptions

gearbox::PathEmptyError if path is empty or does not exist

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 80 of file Interface.cc.

  {
    std::string value = getString(path);
    boost::to_lower(value);
    if (value.empty() || value == "false" || value == "off" || value == "0") return false;
    return true;
  }

◆ getDensity() [1/2]

double getDensity	(	const std::string &	path,
		double	defaultValue
	)		const

inlineinherited

Get the parameter path as a double converted to the standard density unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

If the parameter is empty or does not exist, the defaultValue will be returned.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 401 of file Interface.h.

      {
        return getWithUnit(path, defaultValue);
      }

◆ getDensity() [2/2]

double getDensity ( const std::string & path = "" ) const

inlineinherited

Get the parameter path as a double converted to the standard density unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 379 of file Interface.h.

      {
        return getWithUnit(path);
      }

◆ getDouble() [1/2]

double getDouble	(	const std::string &	path,
		double	defaultValue
	)		const

inherited

Get the parameter path as a double.

If the parameter is empty or does not exist, the defaultValue will be returned.

Exceptions

gearbox::ConversionError if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 51 of file Interface.cc.

  {
    try {
      return getDouble(path);
    } catch (PathEmptyError&) {
      return defaultValue;
    }
  }

◆ getDouble() [2/2]

double getDouble ( const std::string & path = "" ) const

inherited

Get the parameter path as a double.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 41 of file Interface.cc.

  {
    std::string value = getString(path);
    try {
      return boost::lexical_cast<double>(value);
    } catch (boost::bad_lexical_cast&) {
      throw ConversionError() << path << value;
    }
  }

◆ getEnergy() [1/2]

double getEnergy	(	const std::string &	path,
		double	defaultValue
	)		const

inlineinherited

Get the parameter path as a double converted to the standard energy unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

If the parameter is empty or does not exist, the defaultValue will be returned.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 361 of file Interface.h.

      {
        return getWithUnit(path, defaultValue);
      }

◆ getEnergy() [2/2]

double getEnergy ( const std::string & path = "" ) const

inlineinherited

Get the parameter path as a double converted to the standard energy unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 339 of file Interface.h.

      {
        return getWithUnit(path);
      }

◆ getFrequency() [1/2]

double getFrequency	(	const std::string &	path,
		double	defaultValue
	)		const

inlineinherited

Get the parameter path as a double converted to the standard frequency unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

If the parameter is empty or does not exist, the defaultValue will be returned.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 481 of file Interface.h.

      {
        return getWithUnit(path, defaultValue);
      }

◆ getFrequency() [2/2]

double getFrequency ( const std::string & path = "" ) const

inlineinherited

Get the parameter path as a double converted to the standard frequency unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 459 of file Interface.h.

      {
        return getWithUnit(path);
      }

◆ getInt() [1/2]

int getInt	(	const std::string &	path,
		int	defaultValue
	)		const

inherited

Get the parameter path as a int.

If the parameter is empty or does not exist, the defaultValue will be returned.

Exceptions

gearbox::ConversionError if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 71 of file Interface.cc.

  {
    try {
      return getInt(path);
    } catch (PathEmptyError&) {
      return defaultValue;
    }
  }

◆ getInt() [2/2]

int getInt ( const std::string & path = "" ) const

inherited

Get the parameter path as a int.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 60 of file Interface.cc.

  {
    std::string value = getString(path);
    try {
      //hide spurious warning in boost
      return boost::lexical_cast<int>(value);
    } catch (boost::bad_lexical_cast&) {
      throw ConversionError() << path << value;
    }
  }

◆ getLength() [1/2]

double getLength	(	const std::string &	path,
		double	defaultValue
	)		const

inlineinherited

Get the parameter path as a double converted to the standard length unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

If the parameter is empty or does not exist, the defaultValue will be returned.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 281 of file Interface.h.

      {
        return getWithUnit(path, defaultValue);
      }

◆ getLength() [2/2]

double getLength ( const std::string & path = "" ) const

inlineinherited

Get the parameter path as a double converted to the standard length unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 259 of file Interface.h.

      {
        return getWithUnit(path);
      }

◆ getNodes()

std::vector< GearDir > getNodes ( const std::string & path = "" ) const

inherited

Get vector of GearDirs which point to all the nodes the given path evaluates to.

Parameters

path	Path of the parameters to get

Definition at line 21 of file Interface.cc.

  {
    int size = getNumberNodes(path);
    std::vector<GearDir> result;
    result.reserve(size);
    for (int i = 1; i <= size; ++i) {
      result.emplace_back(*this, path, i);
    }
    return result;
  }

◆ getNumberNodes()

virtual int getNumberNodes ( const std::string & path = "" ) const

inlineoverridevirtual

Return the number of nodes a given path will expand to.

Returns: number of nodes, 0 if path does not exist

Implements Interface.

Definition at line 112 of file Gearbox.h.

    {
      return getPathValue(path).numNodes;
    }

◆ getPath()

std::string getPath ( ) const

inlineinherited

Return path of the current interface.

Definition at line 70 of file Interface.h.

70{ return m_path; }

Belle2::gearbox::Interface::m_path

std::string m_path

path of the current interface

Definition: Interface.h:498

◆ getString() [1/2]

std::string getString	(	const std::string &	path,
		const std::string &	defaultValue
	)		const

inline

Get the parameter path as a string.

if the parameter is empty or does not exist, defaultValue will be returned.

Parameters

path	path of the parameter to get
defaultValue	value to return if the path es empty or does not exist

Returns: value of the parameter

Definition at line 138 of file Gearbox.h.

    {
      return gearbox::Interface::getString(path, defaultValue);
    }

◆ getString() [2/2]

virtual std::string getString ( const std::string & path = "" ) const

inlineoverridevirtual

Get the parameter path as a string.

Exceptions

gearbox::PathEmptyError if path is empty or does not exist

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Implements Interface.

Definition at line 123 of file Gearbox.h.

    {
      PathValue p = getPathValue(path);
      if (p.numNodes == 0) throw gearbox::PathEmptyError() << path;
      return p.value;
    }

◆ getStringWithUnit()

virtual std::pair< std::string, std::string > getStringWithUnit ( const std::string & path = "" ) const

inlineoverridevirtual

Get the parameter path as string and also return the unit it was defined with.

If no unit was defined, an empty string will be returned for the unit. No parsing of the unit is performed, this funtion is primarily used by getWithUnit.

Exceptions

gearbox::PathEmptyError if path is empty or does not exist

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Implements Interface.

Definition at line 154 of file Gearbox.h.

    {
      PathValue p = getPathValue(path);
      if (!p.numNodes) throw gearbox::PathEmptyError() << path;
      return make_pair(p.value, p.unit);
    }

◆ getTime() [1/2]

double getTime	(	const std::string &	path,
		double	defaultValue
	)		const

inlineinherited

Get the parameter path as a double converted to the standard time unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

If the parameter is empty or does not exist, the defaultValue will be returned.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 441 of file Interface.h.

      {
        return getWithUnit(path, defaultValue);
      }

◆ getTime() [2/2]

double getTime ( const std::string & path = "" ) const

inlineinherited

Get the parameter path as a double converted to the standard time unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 419 of file Interface.h.

      {
        return getWithUnit(path);
      }

◆ getWithUnit() [1/2]

double getWithUnit ( const std::string & path ) const

inherited

Get the parameter path as a double converted to the standard unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted

Exceptions

gearbox::PathEmptyError	if path is empty or does not exist
gearbox::ConversionError	if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get

Returns: value of the parameter

Definition at line 97 of file Interface.cc.

  {
    std::pair<std::string, std::string> value = getStringWithUnit(path);
    double numValue(0);
    try {
      numValue = boost::lexical_cast<double>(value.first);
    } catch (boost::bad_lexical_cast&) {
      throw ConversionError() << path << value.first;
    }
    if (value.second.empty()) {
      B2WARNING("Requested unit conversion for parameter '" << path << "' but no unit found");
    } else {
      numValue = Unit::convertValue(numValue, value.second);
    }
    return numValue;
  }

◆ getWithUnit() [2/2]

double getWithUnit	(	const std::string &	path,
		double	defaultValue
	)		const

inherited

Get the parameter path as a double converted to the standard unit.

Gearbox will try to determine the unit with which the parameter was saved and convert it to the default system. If no unit can be determinded, it will be assumed that the parameter does not need to be converted.

If the parameter is empty or does not exist, the defaultValue will be returned.

Exceptions

gearbox::ConversionError if the value could not converted to a numerical type

Parameters

path	Path of the parameter to get
defaultValue	Value to return if the Path es empty or does not exist

Returns: value of the parameter

Definition at line 114 of file Interface.cc.

  {
    try {
      return getWithUnit(path);
    } catch (PathEmptyError&) {
      return defaultValue;
    }
  }

◆ isOpen()

bool isOpen ( ) const

inline

Return the state of the Gearbox.

Returns: True if the Gearbox has an initialized backend and opened a document for reading.

Definition at line 106 of file Gearbox.h.

106{ return m_xmlDocument != 0; }

Belle2::Gearbox::m_xmlDocument

xmlDocPtr m_xmlDocument

Pointer to the libxml Document structure.

Definition: Gearbox.h:209

◆ joinPath()

std::string joinPath	(	const std::string &	path,
		const std::string &	subpath
	)		const

protectedinherited

joind to paths, inserting a slash if neccessary

Definition at line 172 of file Interface.cc.

  {
    return ensurePath(path) + boost::trim_left_copy_if(subpath, boost::is_any_of("/"));
  }

◆ operator bool()

operator bool ( ) const

inlineinherited

Convert to bool to simplify checking of existence.

Returns: true if path exists, false otherwise

Definition at line 60 of file Interface.h.

60{ return exists(); }

Belle2::gearbox::Interface::exists

bool exists(const std::string &path="") const

Check if a given parameter path exists.

Definition: Interface.h:54

◆ registerInputHandler()

static void registerInputHandler	(	const std::string &	prefix,
		gearbox::InputHandler::Factory *	factory
	)

inlinestatic

Register a new input handler.

Parameters

prefix	prefix signaling which handler to use for a given backend uri. The prefix is everything up to the first colon in the backend uri
factory	Pointer to the factory function which will return an instance of the handler

Definition at line 187 of file Gearbox.h.

    {
      getInstance().m_registeredHandlers[prefix] = factory;
    }

Friends And Related Function Documentation

◆ gearbox::openXmlUri

void * gearbox::openXmlUri ( const char * )

friend

friend to internal c-like function to interface libxml2 callback

This function is declared as friend since it needs access to Gearbox::openXmlUri, a function which should only be called by libxml2 and thus is declared private.

Member Data Documentation

◆ m_handlers

std::vector<gearbox::InputHandler*> m_handlers

private

List of input handlers which will be used to find resources.

Definition at line 218 of file Gearbox.h.

◆ m_overrides

std::vector<PathOverride> m_overrides

private

the existing overrides

Definition at line 223 of file Gearbox.h.

◆ m_ownedObjects

std::map<std::string, TObject*> m_ownedObjects

mutableprivate

Map of queried objects (path -> TObject*).

Objects will be removed once they are no longer valid.

Definition at line 215 of file Gearbox.h.

◆ m_parameterCache

MRUCache<std::string, PathValue>* m_parameterCache

mutableprivate

Cache for already queried paths.

Definition at line 213 of file Gearbox.h.

◆ m_path

std::string m_path

protectedinherited

path of the current interface

Definition at line 498 of file Interface.h.

◆ m_registeredHandlers

std::map<std::string, gearbox::InputHandler::Factory*> m_registeredHandlers

private

Map of registered InputHandlers.

Definition at line 220 of file Gearbox.h.

◆ m_xmlDocument

xmlDocPtr m_xmlDocument

private

Pointer to the libxml Document structure.

Definition at line 209 of file Gearbox.h.

◆ m_xpathContext

xmlXPathContextPtr m_xpathContext

private

Pointer to the libxml XPath context.

Definition at line 211 of file Gearbox.h.

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

framework/gearbox/include/Gearbox.h
framework/gearbox/src/Gearbox.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ addIndex()

◆ addOverride()

◆ clearOverrides()

◆ ensureNode()

◆ ensurePath()

◆ exists()

◆ getAngle() [1/2]

◆ getAngle() [2/2]

◆ getArray() [1/2]

◆ getArray() [2/2]

◆ getBool() [1/2]

◆ getBool() [2/2]

◆ getDensity() [1/2]

◆ getDensity() [2/2]

◆ getDouble() [1/2]

◆ getDouble() [2/2]

◆ getEnergy() [1/2]

◆ getEnergy() [2/2]

◆ getFrequency() [1/2]

◆ getFrequency() [2/2]

◆ getInt() [1/2]

◆ getInt() [2/2]

◆ getLength() [1/2]

◆ getLength() [2/2]

◆ getNodes()

◆ getNumberNodes()

◆ getPath()

◆ getString() [1/2]

◆ getString() [2/2]

◆ getStringWithUnit()

◆ getTime() [1/2]

◆ getTime() [2/2]

◆ getWithUnit() [1/2]

◆ getWithUnit() [2/2]

◆ isOpen()

◆ joinPath()

◆ operator bool()

◆ registerInputHandler()

Friends And Related Function Documentation

◆ gearbox::openXmlUri

Member Data Documentation

◆ m_handlers

◆ m_overrides

◆ m_ownedObjects

◆ m_parameterCache

◆ m_path

◆ m_registeredHandlers

◆ m_xmlDocument

◆ m_xpathContext