FixedSizeNamedFloatTuple< ANames > Class Template Reference

Generic class that contains a fixed number of named float values. More...

#include <FixedSizeNamedFloatTuple.h>

Inheritance diagram for FixedSizeNamedFloatTuple< ANames >:

Public Member Functions
size_t	size () const final
	Getter for number of floating point values represented by this class.
int	getNameIndex (const char *name) const final
	Getter for the index from a name.
std::string	getName (int iValue) const final
	Getter for the ith name.
template<int I>
void	set (Float_t value)
	Setter for the ith values. Static index version.
void	set (int iValue, Float_t value) final
	Setter for the ith value.
void	set (const char *name, Float_t value)
	Setter for the value with the given name.
template<int I>
Float_t	get () const
	Getter for the ith value. Static index version.
Float_t	get (int iValue) const final
	Getter for the ith value.
Float_t	get (const char *name) const
	Getter for the value with the given name.
template<int I>
Float_t &	var ()
	Reference getter for the ith value. Static index version.
Float_t &	operator[] (int iValue) final
	Reference getter for the ith value.
Float_t &	operator[] (const char *name)
	Reference 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.
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.

Public Attributes
Float_t	m_values [nVars] = {}
	Memory for nVars floating point values.

Static Protected Member Functions
static constexpr int	named (const char *name)
	Static getter for the index from the name.

Static Private Attributes
static const size_t	nVars = ANames::nVars
	Number of floating point values represented by this class.

Detailed Description

template<class ANames>
class Belle2::TrackFindingCDC::FixedSizeNamedFloatTuple< ANames >

Generic class that contains a fixed number of named float values.

This object template provides the memory and the names of the float values.

Template Parameters

ANames

Class with two contained parameters: nVars : Number of parts that will be peeled from the complex object. names : Array of names which contain the nVars names of the float values.

Definition at line 98 of file FixedSizeNamedFloatTuple.h.

Member Function Documentation

find()

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

inlinevirtualinherited

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/3]

Float_t get ( ) const

inline

Getter for the ith value. Static index version.

Definition at line 175 of file FixedSizeNamedFloatTuple.h.

      {
        static_assert(nVars != I, "Requested name not found in names.");
        assert(I < (int)nVars);
        assert(I >= 0);
        return m_values[I];
      }

get() [2/3]

Float_t get ( const char *  name ) const

inline

Getter for the value with the given name.

Definition at line 192 of file FixedSizeNamedFloatTuple.h.

      {
        return get(named(name));
      }

get() [3/3]

Float_t get ( int  iValue ) const

inlinefinalvirtual

Getter for the ith value.

Implements NamedFloatTuple.

Definition at line 184 of file FixedSizeNamedFloatTuple.h.

      {
        assert(iValue < (int)nVars);
        assert(iValue >= 0);
        return m_values[iValue];
      }

getName()

std::string getName ( int  iValue ) const

inlinefinalvirtual

Getter for the ith name.

Implements NamedFloatTuple.

Definition at line 141 of file FixedSizeNamedFloatTuple.h.

      {
        assert(iValue < (int)nVars);
        assert(iValue >= 0);
        return ANames::getName(iValue);
      }

getNamedValues()

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

inherited

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 = "" )

inherited

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

int getNameIndex ( const char *  name ) const

inlinefinalvirtual

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.

Implements NamedFloatTuple.

Definition at line 135 of file FixedSizeNamedFloatTuple.h.

      {
        return named(name);
      }

named()

static constexpr int named ( const char *  name )

inlinestaticconstexprprotected

Static getter for the index from the name.

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

Short hand named spells nice in implementation code.

Parameters

name	The sough name.

Returns

Index of the name, nVars if not found.

Definition at line 115 of file FixedSizeNamedFloatTuple.h.

      {
        return index<nVars>(ANames::getName, name);
      }

operator[]() [1/2]

Float_t & operator[] ( const char *  name )

inline

Reference getter for the value with the given name.

Definition at line 216 of file FixedSizeNamedFloatTuple.h.

      {
        return this->var(named(name));
      }

operator[]() [2/2]

Float_t & operator[] ( int  iValue )

inlinefinalvirtual

Reference getter for the ith value.

Implements NamedFloatTuple.

Definition at line 208 of file FixedSizeNamedFloatTuple.h.

      {
        assert(iValue < (int)nVars);
        assert(iValue >= 0);
        return m_values[iValue];
      }

set() [1/3]

void set ( const char *  name, Float_t  value  )

inline

Setter for the value with the given name.

Definition at line 168 of file FixedSizeNamedFloatTuple.h.

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

set() [2/3]

void set ( Float_t  value )

inline

Setter for the ith values. Static index version.

Definition at line 151 of file FixedSizeNamedFloatTuple.h.

      {
        static_assert(nVars != I, "Requested name not found in names.");
        assert(I < (int)nVars);
        assert(I >= 0);
        m_values[I] = value;
      }

set() [3/3]

void set ( int  iValue, Float_t  value  )

inlinefinalvirtual

Setter for the ith value.

Implements NamedFloatTuple.

Definition at line 160 of file FixedSizeNamedFloatTuple.h.

      {
        assert(iValue < (int)nVars);
        assert(iValue >= 0);
        m_values[iValue] = value;
      }

size()

size_t size ( ) const

inlinefinalvirtual

Getter for number of floating point values represented by this class.

Implements NamedFloatTuple.

Definition at line 122 of file FixedSizeNamedFloatTuple.h.

      {
        return ANames::nVars;
      }

var()

Float_t & var ( )

inline

Reference getter for the ith value. Static index version.

Definition at line 199 of file FixedSizeNamedFloatTuple.h.

      {
        static_assert(nVars != I, "Requested name not found in names.");
        assert(I < (int)nVars);
        assert(I >= 0);
        return m_values[I];
      }

Member Data Documentation

m_values

Float_t m_values[nVars] = {}

Memory for nVars floating point values.

Definition at line 223 of file FixedSizeNamedFloatTuple.h.

nVars

const size_t nVars = ANames::nVars

staticprivate

Number of floating point values represented by this class.

Definition at line 102 of file FixedSizeNamedFloatTuple.h.

---

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

• tracking/trackFindingCDC/varsets/include/FixedSizeNamedFloatTuple.h