#include <GenericParameters.h>

Public Types
template<typename T >
using	MapType = std::map< std::string, std::vector< T > >

Public Member Functions
	GenericParameters ()

	GenericParameters (const GenericParameters &)

GenericParameters &	operator= (const GenericParameters &)=delete

	GenericParameters (GenericParameters &&)=default
	GenericParameters are default moveable.

GenericParameters &	operator= (GenericParameters &&)=default

	~GenericParameters ()=default

template<typename T , typename = EnableIfValidGenericDataType<T>>
GenericDataReturnType< T >	getValue (const std::string &) const

template<typename T , typename = EnableIfValidGenericDataType<T>>
void	setValue (const std::string &key, T value)
	Store (a copy of) the passed value under the given key.

void	setValue (const std::string &key, std::string value)
	Overload for catching const char* setting for string values.

void	setValue (const std::string &key, std::vector< std::string > values)
	Overlaod for catching initializer list setting of string vector values.

template<typename T , typename = std::enable_if_t<detail::isInTuple<T, SupportedGenericDataTypes>>>
void	setValue (const std::string &key, std::initializer_list< T > &&values)
	Overload for catching initializer list setting for vector values.

template<typename T , typename = EnableIfValidGenericDataType<T>>
size_t	getN (const std::string &key) const
	Get the number of elements stored under the given key for a type.

template<typename T , typename = EnableIfValidGenericDataType<T>>
std::vector< std::string >	getKeys () const
	Get all available keys for a given type.

DEPRECATED_ACCESS int	getIntVal (const std::string &key) const

DEPRECATED_ACCESS float	getFloatVal (const std::string &key) const

DEPRECATED_ACCESS const std::string &	getStringVal (const std::string &key) const

DEPRECATED_ACCESS IntVec &	getIntVals (const std::string &key, IntVec &values) const

DEPRECATED_ACCESS FloatVec &	getFloatVals (const std::string &key, FloatVec &values) const

DEPRECATED_ACCESS StringVec &	getStringVals (const std::string &key, StringVec &values) const

DEPRECATED_ACCESS const StringVec &	getIntKeys (StringVec &keys) const

DEPRECATED_ACCESS const StringVec &	getFloatKeys (StringVec &keys) const

DEPRECATED_ACCESS const StringVec &	getStringKeys (StringVec &keys) const

DEPRECATED_ACCESS int	getNInt (const std::string &key) const

DEPRECATED_ACCESS int	getNFloat (const std::string &key) const

DEPRECATED_ACCESS int	getNString (const std::string &key) const

DEPRECATED_ACCESS void	setValues (const std::string &key, const IntVec &values)

DEPRECATED_ACCESS void	setValues (const std::string &key, const FloatVec &values)

DEPRECATED_ACCESS void	setValues (const std::string &key, const StringVec &values)

void	clear ()
	erase all elements

void	print (std::ostream &os=std::cout, bool flush=true)

bool	empty () const
	Check if no parameter is stored (i.e. if all internal maps are empty)

const IntMap &	getIntMap () const

IntMap &	getIntMap ()

const FloatMap &	getFloatMap () const

FloatMap &	getFloatMap ()

const DoubleMap &	getDoubleMap () const

DoubleMap &	getDoubleMap ()

const StringMap &	getStringMap () const

StringMap &	getStringMap ()

Detailed Description

GenericParameters objects allow to store generic named parameters of type int, float and string or vectors of these types. They can be used to store (user) meta data that is run, event or collection dependent. (based on lcio::LCParameters)

Author: F. Gaede, DESY

Date: Apr 2020

Definition at line 74 of file GenericParameters.h.

Member Typedef Documentation

◆ MapType

template<typename T >

using podio::GenericParameters::MapType = std::map<std::string, std::vector<T> >

Definition at line 77 of file GenericParameters.h.

Constructor & Destructor Documentation

◆ GenericParameters() [1/3]

podio::GenericParameters::GenericParameters ( )

Definition at line 8 of file GenericParameters.cc.

                                     :
    m_intMtx(std::make_unique<std::mutex>()),
    m_floatMtx(std::make_unique<std::mutex>()),
    m_stringMtx(std::make_unique<std::mutex>()),
    m_doubleMtx(std::make_unique<std::mutex>()) {
}

◆ GenericParameters() [2/3]

podio::GenericParameters::GenericParameters ( const GenericParameters & other )

GenericParameters are copyable NOTE: This is currently mainly done to keep the ROOT I/O happy, because that needs a copy constructor

Definition at line 15 of file GenericParameters.cc.

                                                                   :
    m_intMtx(std::make_unique<std::mutex>()),
    m_floatMtx(std::make_unique<std::mutex>()),
    m_stringMtx(std::make_unique<std::mutex>()),
    m_doubleMtx(std::make_unique<std::mutex>()) {
  {
    // acquire all three locks at once to make sure all three internal maps are
    // copied at the same "state" of the GenericParameters
    auto& intMtx = other.getMutex<int>();
    auto& floatMtx = other.getMutex<float>();
    auto& stringMtx = other.getMutex<std::string>();
    auto& doubleMtx = other.getMutex<double>();
    std::scoped_lock lock(intMtx, floatMtx, stringMtx, doubleMtx);
    _intMap = other._intMap;
    _floatMap = other._floatMap;
    _stringMap = other._stringMap;
    _doubleMap = other._doubleMap;
  }
}

◆ GenericParameters() [3/3]

podio::GenericParameters::GenericParameters ( GenericParameters && )

default

GenericParameters are default moveable.

◆ ~GenericParameters()

podio::GenericParameters::~GenericParameters ( )

default

Member Function Documentation

◆ clear()

void podio::GenericParameters::clear ( )

inline

erase all elements

Definition at line 199 of file GenericParameters.h.

               {
    _intMap.clear();
    _floatMap.clear();
    _stringMap.clear();
  }

Referenced by podio::EventStore::clear(), and podio::EventStore::clearCollections().

◆ empty()

bool podio::GenericParameters::empty ( ) const

inline

Check if no parameter is stored (i.e. if all internal maps are empty)

Definition at line 208 of file GenericParameters.h.

                     {
    return _intMap.empty() && _floatMap.empty() && _stringMap.empty();
  }

Referenced by podio::EventStore::getEventMetaData(), and getValue().

◆ getDoubleMap() [1/2]

DoubleMap & podio::GenericParameters::getDoubleMap ( )

inline

Definition at line 238 of file GenericParameters.h.

                            {
    return getMap<double>();
  }

◆ getDoubleMap() [2/2]

const DoubleMap & podio::GenericParameters::getDoubleMap ( ) const

inline

Get the internal double map (necessary for serialization with SIO)

Definition at line 235 of file GenericParameters.h.

                                        {
    return getMap<double>();
  }

Referenced by podio::readGenericParameters(), and podio::writeGenericParameters().

◆ getFloatKeys()

const StringVec & podio::GenericParameters::getFloatKeys ( StringVec & keys ) const

Returns a list of all keys of float parameters.

Definition at line 75 of file GenericParameters.cc.

                                                                      {
  for (const auto& k : getKeys<float>()) {
    keys.push_back(k);
  }
  return keys;
}

◆ getFloatMap() [1/2]

FloatMap & podio::GenericParameters::getFloatMap ( )

inline

Definition at line 228 of file GenericParameters.h.

                          {
    return getMap<float>();
  }

◆ getFloatMap() [2/2]

const FloatMap & podio::GenericParameters::getFloatMap ( ) const

inline

Get the internal float map (necessary for serialization with SIO)

Definition at line 225 of file GenericParameters.h.

                                      {
    return getMap<float>();
  }

Referenced by podio::readGenericParameters(), and podio::writeGenericParameters().

◆ getFloatVal()

float podio::GenericParameters::getFloatVal ( const std::string & key ) const

Returns the first float value for the given key.

Definition at line 39 of file GenericParameters.cc.

                                                               {
  return getValue<float>(key);
}

◆ getFloatVals()

FloatVec & podio::GenericParameters::getFloatVals	(	const std::string &	key,
		FloatVec &	values
	)		const

Adds all float values for the given key to values. Returns a reference to values for convenience.

Definition at line 54 of file GenericParameters.cc.

                                                                                      {
  for (const auto v : getValue<std::vector<float>>(key)) {
    values.push_back(v);
  }
  return values;
}

◆ getIntKeys()

const StringVec & podio::GenericParameters::getIntKeys ( StringVec & keys ) const

Returns a list of all keys of integer parameters.

Definition at line 68 of file GenericParameters.cc.

                                                                    {
  for (const auto& k : getKeys<int>()) {
    keys.push_back(k);
  }
  return keys;
}

◆ getIntMap() [1/2]

IntMap & podio::GenericParameters::getIntMap ( )

inline

Definition at line 218 of file GenericParameters.h.

                      {
    return getMap<int>();
  }

◆ getIntMap() [2/2]

const IntMap & podio::GenericParameters::getIntMap ( ) const

inline

Get the internal int map (necessary for serialization with SIO)

Definition at line 215 of file GenericParameters.h.

                                  {
    return getMap<int>();
  }

Referenced by podio::readGenericParameters(), and podio::writeGenericParameters().

◆ getIntVal()

int podio::GenericParameters::getIntVal ( const std::string & key ) const

Returns the first integer value for the given key.

Definition at line 35 of file GenericParameters.cc.

                                                           {
  return getValue<int>(key);
}

◆ getIntVals()

IntVec & podio::GenericParameters::getIntVals	(	const std::string &	key,
		IntVec &	values
	)		const

Adds all integer values for the given key to values. Returns a reference to values for convenience.

Definition at line 47 of file GenericParameters.cc.

                                                                                {
  for (const auto v : getValue<std::vector<int>>(key)) {
    values.push_back(v);
  }
  return values;
}

◆ getKeys()

template<typename T , typename >

std::vector< std::string > podio::GenericParameters::getKeys

Get all available keys for a given type.

Definition at line 356 of file GenericParameters.h.

                                                      {
  std::vector<std::string> keys;
  const auto& map = getMap<T>();
  keys.reserve(map.size());
  {
    auto& mtx = getMutex<T>();
    std::lock_guard lock{mtx};
    std::transform(map.begin(), map.end(), std::back_inserter(keys), [](const auto& pair) { return pair.first; });
  }
 
  return keys;
}

◆ getN()

template<typename T , typename >

size_t podio::GenericParameters::getN ( const std::string & key ) const

Get the number of elements stored under the given key for a type.

Definition at line 345 of file GenericParameters.h.

                                                         {
  const auto& map = getMap<T>();
  auto& mtx = getMutex<T>();
  std::lock_guard lock{mtx};
  if (const auto it = map.find(key); it != map.end()) {
    return it->second.size();
  }
  return 0;
}

◆ getNFloat()

int podio::GenericParameters::getNFloat ( const std::string & key ) const

The number of float values stored for this key.

Definition at line 93 of file GenericParameters.cc.

                                                           {
  return getN<float>(key);
}

◆ getNInt()

int podio::GenericParameters::getNInt ( const std::string & key ) const

The number of integer values stored for this key.

Definition at line 89 of file GenericParameters.cc.

                                                         {
  return getN<int>(key);
}

◆ getNString()

int podio::GenericParameters::getNString ( const std::string & key ) const

The number of string values stored for this key.

Definition at line 97 of file GenericParameters.cc.

                                                            {
  return getN<std::string>(key);
}

◆ getStringKeys()

const StringVec & podio::GenericParameters::getStringKeys ( StringVec & keys ) const

Returns a list of all keys of string parameters.

Definition at line 82 of file GenericParameters.cc.

                                                                       {
  for (const auto& k : getKeys<std::string>()) {
    keys.push_back(k);
  }
  return keys;
}

◆ getStringMap() [1/2]

StringMap & podio::GenericParameters::getStringMap ( )

inline

Definition at line 248 of file GenericParameters.h.

                            {
    return getMap<std::string>();
  }

◆ getStringMap() [2/2]

const StringMap & podio::GenericParameters::getStringMap ( ) const

inline

Get the internal string map (necessary for serialization with SIO)

Definition at line 245 of file GenericParameters.h.

                                        {
    return getMap<std::string>();
  }

Referenced by podio::readGenericParameters(), and podio::writeGenericParameters().

◆ getStringVal()

const std::string & podio::GenericParameters::getStringVal ( const std::string & key ) const

Returns the first string value for the given key.

Definition at line 43 of file GenericParameters.cc.

                                                                           {
  return getValue<std::string>(key);
}

◆ getStringVals()

StringVec & podio::GenericParameters::getStringVals	(	const std::string &	key,
		StringVec &	values
	)		const

Adds all float values for the given key to values. Returns a reference to values for convenience.

Definition at line 61 of file GenericParameters.cc.

                                                                                         {
  for (const auto& v : getValue<std::vector<std::string>>(key)) {
    values.push_back(v);
  }
  return values;
}

◆ getValue()

template<typename T , typename >

GenericDataReturnType< T > podio::GenericParameters::getValue ( const std::string & key ) const

Get the value that is stored under the given key, by const reference or by value depending on the desired type

Definition at line 307 of file GenericParameters.h.

                                                                               {
  const auto& map = getMap<T>();
  auto& mtx = getMutex<T>();
  std::lock_guard lock{mtx};
  const auto it = map.find(key);
  // If there is no entry to the key, we just return an empty default
  // TODO: make this case detectable from the outside
  if (it == map.end()) {
    static const auto empty = T{};
    return empty;
  }
 
  // We have to check whether the return type is a vector or a single value
  if constexpr (detail::isVector<T>) {
    return it->second;
  } else {
    const auto& iv = it->second;
    return iv[0];
  }
}

Referenced by getFloatVals(), getIntVals(), and getStringVals().

◆ operator=() [1/2]

GenericParameters & podio::GenericParameters::operator= ( const GenericParameters & )

delete

◆ operator=() [2/2]

GenericParameters & podio::GenericParameters::operator= ( GenericParameters && )

default

◆ print()

void podio::GenericParameters::print	(	std::ostream &	os = `std::cout`,
		bool	flush = `true`
	)

Definition at line 136 of file GenericParameters.cc.

                                                        {
  os << "int parameters\n\n";
  printMap(getMap<int>(), os);
  os << "\nfloat parameters\n";
  printMap(getMap<float>(), os);
  os << "\ndouble parameters\n";
  printMap(getMap<double>(), os);
  os << "\nstd::string parameters\n";
  printMap(getMap<std::string>(), os);
 
  if (flush) {
    os.flush();
  }
}

◆ setValue() [1/4]

template<typename T , typename = std::enable_if_t<detail::isInTuple<T, SupportedGenericDataTypes>>>

void podio::GenericParameters::setValue	(	const std::string &	key,
		std::initializer_list< T > &&	values
	)

inline

Overload for catching initializer list setting for vector values.

Definition at line 123 of file GenericParameters.h.

                                                                       {
    setValue<std::vector<T>>(key, std::move(values));
  }

◆ setValue() [2/4]

void podio::GenericParameters::setValue	(	const std::string &	key,
		std::string	value
	)

inline

Overload for catching const char* setting for string values.

Definition at line 112 of file GenericParameters.h.

                                                       {
    setValue<std::string>(key, std::move(value));
  }

◆ setValue() [3/4]

void podio::GenericParameters::setValue	(	const std::string &	key,
		std::vector< std::string >	values
	)

inline

Overlaod for catching initializer list setting of string vector values.

Definition at line 117 of file GenericParameters.h.

                                                                   {
    setValue<std::vector<std::string>>(key, std::move(values));
  }

◆ setValue() [4/4]

template<typename T , typename >

void podio::GenericParameters::setValue	(	const std::string &	key,
		T	value
	)

Store (a copy of) the passed value under the given key.

Definition at line 329 of file GenericParameters.h.

                                                              {
  auto& map = getMap<T>();
  auto& mtx = getMutex<T>();
 
  if constexpr (detail::isVector<T>) {
    std::lock_guard lock{mtx};
    map.insert_or_assign(key, std::move(value));
  } else {
    // Wrap the value into a vector with exactly one entry and store that
    std::vector<T> v = {value};
    std::lock_guard lock{mtx};
    map.insert_or_assign(key, std::move(v));
  }
}

Referenced by setValues(), TEST_CASE(), and write().

◆ setValues() [1/3]

void podio::GenericParameters::setValues	(	const std::string &	key,
		const FloatVec &	values
	)

Set float values for the given key.

Definition at line 105 of file GenericParameters.cc.

                                                                              {
  setValue(key, values);
}

◆ setValues() [2/3]

void podio::GenericParameters::setValues	(	const std::string &	key,
		const IntVec &	values
	)

Set integer values for the given key.

Definition at line 101 of file GenericParameters.cc.

                                                                            {
  setValue(key, values);
}

◆ setValues() [3/3]

void podio::GenericParameters::setValues	(	const std::string &	key,
		const StringVec &	values
	)

Set string values for the given key.

Definition at line 109 of file GenericParameters.cc.

                                                                               {
  setValue(key, values);
}

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

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ MapType

Constructor & Destructor Documentation

◆ GenericParameters() [1/3]

◆ GenericParameters() [2/3]

◆ GenericParameters() [3/3]

◆ ~GenericParameters()

Member Function Documentation

◆ clear()

◆ empty()

◆ getDoubleMap() [1/2]

◆ getDoubleMap() [2/2]

◆ getFloatKeys()

◆ getFloatMap() [1/2]

◆ getFloatMap() [2/2]

◆ getFloatVal()

◆ getFloatVals()

◆ getIntKeys()

◆ getIntMap() [1/2]

◆ getIntMap() [2/2]

◆ getIntVal()

◆ getIntVals()

◆ getKeys()

◆ getN()

◆ getNFloat()

◆ getNInt()

◆ getNString()

◆ getStringKeys()

◆ getStringMap() [1/2]

◆ getStringMap() [2/2]

◆ getStringVal()

◆ getStringVals()

◆ getValue()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ print()

◆ setValue() [1/4]

◆ setValue() [2/4]

◆ setValue() [3/4]

◆ setValue() [4/4]

◆ setValues() [1/3]

◆ setValues() [2/3]

◆ setValues() [3/3]