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

#include <LCParameters.h>

Inheritance diagram for EVENT::LCParameters:

Public Member Functions
virtual	~LCParameters ()
	Destructor. More...

virtual int	getIntVal (const std::string &key) const =0
	Returns the first integer value for the given key. More...

virtual float	getFloatVal (const std::string &key) const =0
	Returns the first float value for the given key. More...

virtual double	getDoubleVal (const std::string &key) const =0
	Returns the first double value for the given key. More...

virtual const std::string &	getStringVal (const std::string &key) const =0
	Returns the first string value for the given key. More...

virtual IntVec &	getIntVals (const std::string &key, IntVec &values) const =0
	Adds all integer values for the given key to values. More...

virtual FloatVec &	getFloatVals (const std::string &key, FloatVec &values) const =0
	Adds all float values for the given key to values. More...

virtual DoubleVec &	getDoubleVals (const std::string &key, DoubleVec &values) const =0
	Adds all double values for the given key to values. More...

virtual StringVec &	getStringVals (const std::string &key, StringVec &values) const =0
	Adds all string values for the given key to values. More...

virtual const StringVec &	getIntKeys (StringVec &keys) const =0
	Returns a list of all keys of integer parameters. More...

virtual const StringVec &	getFloatKeys (StringVec &keys) const =0
	Returns a list of all keys of float parameters. More...

virtual const StringVec &	getDoubleKeys (StringVec &keys) const =0
	Returns a list of all keys of double parameters. More...

virtual const StringVec &	getStringKeys (StringVec &keys) const =0
	Returns a list of all keys of string parameters. More...

virtual int	getNInt (const std::string &key) const =0
	The number of integer values stored for this key. More...

virtual int	getNFloat (const std::string &key) const =0
	The number of float values stored for this key. More...

virtual int	getNDouble (const std::string &key) const =0
	The number of double values stored for this key. More...

virtual int	getNString (const std::string &key) const =0
	The number of string values stored for this key. More...

virtual void	setValue (const std::string &key, int value)=0
	Set integer value for the given key. More...

virtual void	setValue (const std::string &key, float value)=0
	Set float value for the given key. More...

virtual void	setValue (const std::string &key, double value)=0
	Set double value for the given key. More...

virtual void	setValue (const std::string &key, const std::string &value)=0
	Set string value for the given key. More...

virtual void	setValues (const std::string &key, const IntVec &values)=0
	Set integer values for the given key. More...

virtual void	setValues (const std::string &key, const FloatVec &values)=0
	Set float values for the given key. More...

virtual void	setValues (const std::string &key, const DoubleVec &values)=0
	Set double values for the given key. More...

virtual void	setValues (const std::string &key, const StringVec &values)=0
	Set string values for the given key. More...

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()

Definition at line 28 of file LCParameters.h.

Constructor & Destructor Documentation

virtual EVENT::LCParameters::~LCParameters ( )

inlinevirtual

Destructor.

Definition at line 32 of file LCParameters.h.

Member Function Documentation

virtual const StringVec& EVENT::LCParameters::getDoubleKeys ( StringVec & keys ) const

pure virtual

Returns a list of all keys of double parameters.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::LCTOOLS::printParameters(), and SIO::SIOLCParameters::write().

virtual double EVENT::LCParameters::getDoubleVal ( const std::string & key ) const

pure virtual

Returns the first double value for the given key.

Implemented in IMPL::LCParametersImpl.

virtual DoubleVec& EVENT::LCParameters::getDoubleVals	(	const std::string &	key,
		DoubleVec &	values
	)		const

pure virtual

Adds all double values for the given key to values.

Returns a reference to values for convenience.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::LCTOOLS::printParameters(), and SIO::SIOLCParameters::write().

virtual const StringVec& EVENT::LCParameters::getFloatKeys ( StringVec & keys ) const

pure virtual

Returns a list of all keys of float parameters.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::LCTOOLS::printParameters(), and SIO::SIOLCParameters::write().

virtual float EVENT::LCParameters::getFloatVal ( const std::string & key ) const

pure virtual

Returns the first float value for the given key.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::LCStdHepRdr::updateNextEvent(), and UTIL::LCStdHepRdrNew::updateNextEvent().

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(), and SIO::SIOLCParameters::write().

virtual const StringVec& EVENT::LCParameters::getIntKeys ( StringVec & keys ) const

pure virtual

Returns a list of all keys of integer parameters.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::LCTOOLS::printParameters(), and SIO::SIOLCParameters::write().

virtual int EVENT::LCParameters::getIntVal ( const std::string & key ) const

pure virtual

Returns the first integer value for the given key.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::LCStdHepRdr::updateNextEvent(), and UTIL::LCStdHepRdrNew::updateNextEvent().

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(), UTIL::CollectionParameterMap::init(), UTIL::LCTOOLS::printParameters(), and SIO::SIOLCParameters::write().

virtual int EVENT::LCParameters::getNDouble ( const std::string & key ) const

pure virtual

The number of double values stored for this key.

Implemented in IMPL::LCParametersImpl.

virtual int EVENT::LCParameters::getNFloat ( const std::string & key ) const

pure virtual

The number of float values stored for this key.

Implemented in IMPL::LCParametersImpl.

virtual int EVENT::LCParameters::getNInt ( const std::string & key ) const

pure virtual

The number of integer values stored for this key.

Implemented in IMPL::LCParametersImpl.

virtual int EVENT::LCParameters::getNString ( const std::string & key ) const

pure virtual

The number of string values stored for this key.

Implemented in IMPL::LCParametersImpl.

virtual const StringVec& EVENT::LCParameters::getStringKeys ( StringVec & keys ) const

pure virtual

Returns a list of all keys of string parameters.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::LCTOOLS::printParameters(), and SIO::SIOLCParameters::write().

virtual const std::string& EVENT::LCParameters::getStringVal ( const std::string & key ) const

pure virtual

Returns the first string value for the given key.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::CellIDDecoder< T >::CellIDDecoder(), UTIL::header(), SIO::SIOLCGenericObjectHandler::initWriting(), UTIL::operator<<(), UTIL::LCTOOLS::printLCGenericObjects(), and UTIL::LCTOOLS::printRelation().

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

pure virtual

Adds all string values for the given key to values.

Returns a reference to values for convenience.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::IndexMap::IndexMap(), UTIL::CollectionParameterMap::init(), UTIL::PIDHandler::init(), SIO::SIOVertexHandler::initReading(), UTIL::LCTOOLS::printParameters(), and SIO::SIOLCParameters::write().

virtual void EVENT::LCParameters::setValue	(	const std::string &	key,
		int	value
	)

pure virtual

Set integer value for the given key.

Implemented in IMPL::LCParametersImpl.

Referenced by UTIL::CellIDEncoder< T >::CellIDEncoder(), UTIL::LCRelationNavigator::createLCCollection(), SIO::SIOLCGenericObjectHandler::initWriting(), UTIL::LCStdHepRdr::readEvent(), UTIL::LCStdHepRdrNew::readEvent(), UTIL::LCStdHepRdr::updateNextEvent(), and UTIL::LCStdHepRdrNew::updateNextEvent().

virtual void EVENT::LCParameters::setValue	(	const std::string &	key,
		float	value
	)

pure virtual

Set float value for the given key.

Implemented in IMPL::LCParametersImpl.

virtual void EVENT::LCParameters::setValue	(	const std::string &	key,
		double	value
	)

pure virtual

Set double value for the given key.

Implemented in IMPL::LCParametersImpl.

virtual void EVENT::LCParameters::setValue	(	const std::string &	key,
		const std::string &	value
	)

pure virtual

Set string value for the given key.

Implemented in IMPL::LCParametersImpl.

virtual void EVENT::LCParameters::setValues	(	const std::string &	key,
		const IntVec &	values
	)

pure virtual

Set integer values for the given key.

Implemented in IMPL::LCParametersImpl.

Referenced by SIO::SIOVertexHandler::initWriting(), SIO::SIOLCParameters::read(), UTIL::CollectionParameterMap::~CollectionParameterMap(), and UTIL::PIDHandler::~PIDHandler().

virtual void EVENT::LCParameters::setValues	(	const std::string &	key,
		const FloatVec &	values
	)

pure virtual

Set float values for the given key.

Implemented in IMPL::LCParametersImpl.

virtual void EVENT::LCParameters::setValues	(	const std::string &	key,
		const DoubleVec &	values
	)

pure virtual

Set double values for the given key.

Implemented in IMPL::LCParametersImpl.

virtual void EVENT::LCParameters::setValues	(	const std::string &	key,
		const StringVec &	values
	)

pure virtual

Set string values for the given key.

Implemented in IMPL::LCParametersImpl.

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

/afs/desy.de/user/d/dudarboh/iLCSoft/LCIO/src/cpp/include/pre-generated/EVENT/LCParameters.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation