An abstract tuple of float value where each value has an associated name. More...

#include <NamedFloatTuple.h>

Inheritance diagram for NamedFloatTuple:

Public Member Functions
virtual	~NamedFloatTuple ()
	Marking the destructor virtual since we are using virtual functions.

virtual size_t	size () const =0
	Getter for the number of parts.

virtual int	getNameIndex (const char *name) const =0
	Getter for the index from a name.

virtual std::string	getName (int iValue) const =0
	Getter for the ith name.

virtual void	set (int iValue, Float_t value)=0
	Setter for the value of the ith part.

void	set (const char *const name, Float_t value)
	Setter for the value with the given name.

virtual Float_t	get (int iValue) const =0
	Getter for the value of the ith part.

Float_t	get (const char *const name) const
	Getter for the value with the given name.

virtual MayBePtr< Float_t >	find (std::string name)
	Getter for a pointer to the value with the given name.

virtual Float_t &	operator[] (int iValue)=0
	Reference getter for the value of the ith part.

Float_t &	operator[] (const char *const name)
	Reference getter for the value with the given name.

std::map< std::string, Float_t >	getNamedValues (std::string prefix="") const
	Getter for a map of all name and value pairs in this tuple.

std::vector< Named< Float_t * > >	getNamedVariables (std::string prefix="")
	Getter for named references to the variables in this tuple.

Detailed Description

An abstract tuple of float value where each value has an associated name.

Definition at line 27 of file NamedFloatTuple.h.

Member Function Documentation

◆ find()

virtual MayBePtr< Float_t > find ( std::string name )

inlinevirtual

Getter for a pointer to the value with the given name.

Return nullptr if not found.

Definition at line 71 of file NamedFloatTuple.h.

      {
        size_t nameindex = getNameIndex(name.c_str());
        return (nameindex < size()) ? &(operator[](nameindex)) : nullptr;
      }

◆ get() [1/2]

Float_t get ( const char *const name ) const

inline

Getter for the value with the given name.

Definition at line 62 of file NamedFloatTuple.h.

      {
        return get(getNameIndex(name));
      }

◆ get() [2/2]

virtual Float_t get ( int iValue ) const

pure virtual

Getter for the value of the ith part.

◆ getName()

virtual std::string getName ( int iValue ) const

pure virtual

Getter for the ith name.

◆ getNamedValues()

std::map< std::string, Float_t > getNamedValues ( std::string prefix = "" ) const

Getter for a map of all name and value pairs in this tuple.

Definition at line 15 of file NamedFloatTuple.cc.

{
  std::map<std::string, Float_t> namedValues;
  size_t nVars = size();
 
  for (size_t iVar = 0; iVar < nVars; ++iVar) {
    std::string name = prefix + getName(iVar);
    Float_t value = get(iVar);
    namedValues[name] = value;
  }
 
  return namedValues;
}

◆ getNamedVariables()

std::vector< Named< Float_t * > > getNamedVariables ( std::string prefix = "" )

Getter for named references to the variables in this tuple.

Definition at line 29 of file NamedFloatTuple.cc.

{
  std::vector<Named<Float_t*> > namedVariables;
  int nVars = size();
  namedVariables.reserve(nVars);
 
  for (int iVar = 0; iVar < nVars; ++iVar) {
    std::string name = prefix + getName(iVar);
    Float_t& value = operator[](iVar);
    namedVariables.emplace_back(name, &value);
  }
 
  return namedVariables;
}

◆ getNameIndex()

virtual int getNameIndex ( const char * name ) const

pure virtual

Getter for the index from a name.

Looks through the associated names and returns the right index if found. Returns size() (one after the last element) if not found.

Parameters

name	Name of the sought part

Returns: Index of the name, nParts if not found.

◆ operator[]() [1/2]

Float_t & operator[] ( const char *const name )

inline

Reference getter for the value with the given name.

Definition at line 81 of file NamedFloatTuple.h.

      {
        return operator[](getNameIndex(name));
      }

◆ operator[]() [2/2]

virtual Float_t & operator[] ( int iValue )

pure virtual

Reference getter for the value of the ith part.

◆ set() [1/2]

void set	(	const char *const	name,
		Float_t	value )

inline

Setter for the value with the given name.

Definition at line 53 of file NamedFloatTuple.h.

      {
        set(getNameIndex(name), value);
      }

◆ set() [2/2]

virtual void set	(	int	iValue,
		Float_t	value )

pure virtual

Setter for the value of the ith part.

◆ size()

virtual size_t size ( ) const

pure virtual

Getter for the number of parts.

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

tracking/trackFindingCDC/varsets/include/NamedFloatTuple.h
tracking/trackFindingCDC/varsets/src/NamedFloatTuple.cc

Public Member Functions

Detailed Description

Member Function Documentation

◆ find()

◆ get() [1/2]

◆ get() [2/2]

◆ getName()

◆ getNamedValues()

◆ getNamedVariables()

◆ getNameIndex()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ set() [1/2]

◆ set() [2/2]

◆ size()