CaloRec::ToolConstants Class Reference

Container for the tool constants managed by ToolWithConstants. More...

#include <ToolConstants.h>

Collaboration diagram for CaloRec::ToolConstants:

Public Types
typedef std::map< std::string, CxxUtils::Arrayrep >	Maptype
	Type of the map from keys to values.

Public Member Functions
	ToolConstants ()
	Default constructor.
const CxxUtils::Arrayrep &	newrep (const std::string &context, const std::string &key, const std::string &val)
	Make a new entry.
const CxxUtils::Arrayrep &	getrep (const std::string &context, const std::string &key) const
	Look up an entry.
void	setrep (const std::string &key, const CxxUtils::Arrayrep &rep)
	Set an entry.
void	setrep (const std::string &key, CxxUtils::Arrayrep &&rep)
	Set an entry.
bool	hasrep (const std::string &key) const
	Test to see if a given key is present.
void	writeConstants (std::ostream &stream, const std::string &name) const
	Writes out constants in a python-like format.
std::string	toString (const std::string &name) const
	Return the data as a formatted string.
const std::string &	clsname () const
	Return the name of the C++ class that operates on these constants.
void	clsname (const std::string &name)
	Set the name of the C++ class that operates on these constants.
int	version () const
	Return the version of the C++ class that operates on these constants.
void	version (int version)
	Set the version of the C++ class that operates on these constants.
const Maptype &	map () const
	Return the key -> value map.

Static Private Member Functions
static void	error (const std::string &context, const std::string &key, const std::string &msg)
	Report an error.

Private Attributes
Maptype	m_map
	The map of keys to values.
std::string	m_clsname
	Name of the C++ class that operates on these constants.
int	m_version
	Version number of the C++ class that operates on these constants.

Detailed Description

Container for the tool constants managed by ToolWithConstants.

This is just a simple map from constant name to Arrayrep.

Definition at line 31 of file ToolConstants.h.

Member Typedef Documentation

Maptype

typedef std::map<std::string, CxxUtils::Arrayrep> CaloRec::ToolConstants::Maptype

Type of the map from keys to values.

Definition at line 35 of file ToolConstants.h.

Constructor & Destructor Documentation

ToolConstants()

CaloRec::ToolConstants::ToolConstants

(

)

Default constructor.

Definition at line 23 of file ToolConstants.cxx.

  : m_version (0)
{
}

Member Function Documentation

clsname() [1/2]

const std::string & CaloRec::ToolConstants::clsname

(

)

const

Return the name of the C++ class that operates on these constants.

Definition at line 152 of file ToolConstants.cxx.

{
  return m_clsname;
}

clsname() [2/2]

void CaloRec::ToolConstants::clsname

(

const std::string &

name

)

Set the name of the C++ class that operates on these constants.

Definition at line 161 of file ToolConstants.cxx.

{
  m_clsname = name;
}

error()

void CaloRec::ToolConstants::error ( const std::string & context, const std::string & key, const std::string & msg )

staticprivate

Report an error.

Parameters

context	Context string for the error.
key	Key involved in the error.
msg	Error message.

Definition at line 114 of file ToolConstants.cxx.

{
  throw GaudiException (msg, context+":"+key, StatusCode::FAILURE);
}

getrep()

const CxxUtils::Arrayrep & CaloRec::ToolConstants::getrep	(	const std::string &	context,
		const std::string &	key ) const

Look up an entry.

Parameters

context	The context name, for error reporting.
key	The key of the new entry.

Looks up key and returns its Arrayrep. Raises an exception if key isn't found.

Definition at line 59 of file ToolConstants.cxx.

{
  Maptype::const_iterator i = m_map.find (key);
  if (i == m_map.end()) {
    std::ostringstream ss;
    for (const auto& p : m_map) {
      ss << " " << p.first;
    }
    error (context, key, "Can't find key in" + ss.str());
  }
  return i->second;
}

hasrep()

bool CaloRec::ToolConstants::hasrep

(

const std::string &

key

)

const

Test to see if a given key is present.

Definition at line 101 of file ToolConstants.cxx.

{
  return m_map.contains(key);
}

map()

const ToolConstants::Maptype & CaloRec::ToolConstants::map

(

)

const

Return the key -> value map.

Definition at line 188 of file ToolConstants.cxx.

{
  return m_map;
}

newrep()

const CxxUtils::Arrayrep & CaloRec::ToolConstants::newrep	(	const std::string &	context,
		const std::string &	key,
		const std::string &	val )

Make a new entry.

Parameters

context	The context name, for error reporting.
key	The key of the new entry.
val	The value of the new entry, as a string.

Converts val to an Arrayrep and stores it. Raises an exception if the key already exists or if there's a conversion error.

Definition at line 40 of file ToolConstants.cxx.

{
  if (m_map.contains(key)) {
    error (context, key, "Duplicate key");
  }
  return m_map[key] = CxxUtils::Arrayrep (val, context+":"+key);
}

setrep() [1/2]

void CaloRec::ToolConstants::setrep	(	const std::string &	key,
		const CxxUtils::Arrayrep &	rep )

Set an entry.

Parameters

key	The key of the entry to set.
rep	The value of the new entry.

Definition at line 79 of file ToolConstants.cxx.

{
  m_map[key] = rep;
}

setrep() [2/2]

void CaloRec::ToolConstants::setrep	(	const std::string &	key,
		CxxUtils::Arrayrep &&	rep )

Set an entry.

Parameters

key	The key of the entry to set.
rep	The value of the new entry.

Definition at line 91 of file ToolConstants.cxx.

{
  m_map[key] = std::move (rep);
}

toString()

std::string CaloRec::ToolConstants::toString

(

const std::string &

name

)

const

Return the data as a formatted string.

Parameters

name	Name of the Maker-Algorithm.

Definition at line 141 of file ToolConstants.cxx.

{
  std::ostringstream ss;
  writeConstants (ss, name);
  return ss.str();
}

version() [1/2]

int CaloRec::ToolConstants::version

(

)

const

Return the version of the C++ class that operates on these constants.

Definition at line 170 of file ToolConstants.cxx.

{
  return m_version;
}

version() [2/2]

void CaloRec::ToolConstants::version

(

int

version

)

Set the version of the C++ class that operates on these constants.

Definition at line 179 of file ToolConstants.cxx.

{
  m_version = version;
}

writeConstants()

void CaloRec::ToolConstants::writeConstants	(	std::ostream &	stream,
		const std::string &	name ) const

Writes out constants in a python-like format.

Parameters

stream	Stream to which to write (file or cout)
name	Name of the Maker-Algorithm (used only for output)
stream	Stream to wirte to (file or cout)
name	Name of the Maker-Algorithm (used only for output)

Definition at line 126 of file ToolConstants.cxx.

{
  for (const std::pair<const std::string, CxxUtils::Arrayrep>& p : m_map) {
    stream << name << "." << p.first << " = ";
    p.second.write_array(stream);
  }
  stream << std::endl;
}

Member Data Documentation

m_clsname

std::string CaloRec::ToolConstants::m_clsname

private

Name of the C++ class that operates on these constants.

Definition at line 151 of file ToolConstants.h.

m_map

Maptype CaloRec::ToolConstants::m_map

private

The map of keys to values.

Definition at line 148 of file ToolConstants.h.

m_version

int CaloRec::ToolConstants::m_version

private

Version number of the C++ class that operates on these constants.

Definition at line 154 of file ToolConstants.h.

---

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

• ToolConstants.h
• ToolConstants.cxx