EVENT::LCParameters Class Reference

Simple interface to store generic named parameters of type int, float and string. More...

#include <pre-generated/EVENT/LCParameters.h>

Inheritance diagram for EVENT::LCParameters:

List of all members.

Public Member Functions
virtual	~LCParameters ()
	Destructor.
virtual int	getIntVal (const std::string &key) const =0
	Returns the first integer value for the given key.
virtual float	getFloatVal (const std::string &key) const =0
	Returns the first float value for the given key.
virtual const std::string &	getStringVal (const std::string &key) const =0
	Returns the first string value for the given key.
virtual IntVec &	getIntVals (const std::string &key, IntVec &values) const =0
	Adds all integer values for the given key to values.
virtual FloatVec &	getFloatVals (const std::string &key, FloatVec &values) const =0
	Adds all float values for the given key to values.
virtual StringVec &	getStringVals (const std::string &key, StringVec &values) const =0
	Adds all float values for the given key to values.
virtual const StringVec &	getIntKeys (StringVec &keys) const =0
	Returns a list of all keys of integer parameters.
virtual const StringVec &	getFloatKeys (StringVec &keys) const =0
	Returns a list of all keys of float parameters.
virtual const StringVec &	getStringKeys (StringVec &keys) const =0
	Returns a list of all keys of string parameters.
virtual int	getNInt (const std::string &key) const =0
	The number of integer values stored for this key.
virtual int	getNFloat (const std::string &key) const =0
	The number of float values stored for this key.
virtual int	getNString (const std::string &key) const =0
	The number of string values stored for this key.
virtual void	setValue (const std::string &key, int value)=0
	Set integer value for the given key.
virtual void	setValue (const std::string &key, float value)=0
	Set float value for the given key.
virtual void	setValue (const std::string &key, const std::string &value)=0
	Set string value for the given key.
virtual void	setValues (const std::string &key, const IntVec &values)=0
	Set integer values for the given key.
virtual void	setValues (const std::string &key, const FloatVec &values)=0
	Set float values for the given key.
virtual void	setValues (const std::string &key, const StringVec &values)=0
	Set string values for the given key.

---

Detailed Description

Simple interface to store generic named parameters of type int, float and string.

It can be used to store (user) meta data that is run, event or collection dependent.

Author:

gaede

Version:

Id

LCParameters.aid,v 1.3 2009-11-20 11:20:20 gaede Exp

See also:

LCRunHeader.parameters()

LCEvent.parameters()

LCCollection.parameters()

---

Member Function Documentation

virtual FloatVec& EVENT::LCParameters::getFloatVals	(	const std::string &	key,
		FloatVec &	values
	)			const [pure virtual]

Adds all float values for the given key to values.

Returns a reference to values for convenience.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::LCTOOLS::printParameters().

virtual IntVec& EVENT::LCParameters::getIntVals	(	const std::string &	key,
		IntVec &	values
	)			const [pure virtual]

Adds all integer values for the given key to values.

Returns a reference to values for convenience.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::IndexMap::IndexMap(), and UTIL::LCTOOLS::printParameters().

virtual StringVec& EVENT::LCParameters::getStringVals	(	const std::string &	key,
		StringVec &	values
	)			const [pure virtual]

Adds all float values for the given key to values.

Returns a reference to values for convenience.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::IndexMap::IndexMap(), SIO::SIOVertexHandler::init(), and UTIL::LCTOOLS::printParameters().

---

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

• LCParameters.h