Base class for nested containers. More...

#include <NestedContainer.h>

Collaboration diagram for TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >:

Public Types
typedef T	value_type
	Type of atomic element.
typedef const T	const_value_type
	const Type of atomic element.
typedef Trait	trait_type
	Type of trait.
typedef std::vector< std::pair< ExpandedIdentifier, const T * > >	FlatContainer
	fill vector with all entries in the container. needed to dump to Peter's flat file format

Public Member Functions
	NestedContainerBase ()
	constructor
	~NestedContainerBase ()=default
	destructor
void	set (const ExpandedIdentifier &id, const T &t)
	set a value.
const T &	get (const ExpandedIdentifier &id) const
	get a value.
const T &	get (const ExpandedIdentifier &id, size_t &resolvelevel) const
const T &	get () const
	get the default value
void	set (const T &t)
	set the default value
void	clear ()
	clear entire container
void	clear (const ExpandedIdentifier &id)
	clear only entries specified
const DaughterContainer &	daughters () const
	return the vector of daughters
size_t	numObjects () const
	return the total number of valid calibration objects
bool	operator== (const NestedContainerBase &rhs) const
	equality operator, used for compressing
bool	operator== (const T &rhs) const
	another equality operator, used for compressing
size_t	footprint () const
	return the memory allocated by the container and its daughters
void	crunch ()
	reduce the footprint as much as possible by removing the extra space allocated by the vectors
void	printindent () const
	some IO for debugging
void	print () const
void	getall (FlatContainer &entries) const

Private Types
typedef std::vector< Daughter >	DaughterContainer
	typedef of container

Private Attributes
DaughterContainer	m_daughters
	Container of Daughters.
T	m_default
	Type of atomic element.

Detailed Description

template<int NestingLevel, class Daughter, class T, class Trait>
class TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >

Base class for nested containers.

Definition at line 150 of file NestedContainer.h.

Member Typedef Documentation

◆ const_value_type

template<int NestingLevel, class Daughter, class T, class Trait>

typedef const T TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::const_value_type

const Type of atomic element.

Definition at line 161 of file NestedContainer.h.

◆ DaughterContainer

template<int NestingLevel, class Daughter, class T, class Trait>

typedef std::vector<Daughter> TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::DaughterContainer

private

typedef of container

Definition at line 154 of file NestedContainer.h.

◆ FlatContainer

template<int NestingLevel, class Daughter, class T, class Trait>

typedef std::vector< std::pair<ExpandedIdentifier, const T*> > TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::FlatContainer

fill vector with all entries in the container. needed to dump to Peter's flat file format

Definition at line 346 of file NestedContainer.h.

◆ trait_type

template<int NestingLevel, class Daughter, class T, class Trait>

typedef Trait TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::trait_type

Type of trait.

Definition at line 162 of file NestedContainer.h.

◆ value_type

template<int NestingLevel, class Daughter, class T, class Trait>

typedef T TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::value_type

Type of atomic element.

Definition at line 160 of file NestedContainer.h.

Constructor & Destructor Documentation

◆ NestedContainerBase()

template<int NestingLevel, class Daughter, class T, class Trait>

TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::NestedContainerBase ( )

inline

constructor

Definition at line 165 of file NestedContainer.h.

165: m_daughters(0), m_default(Trait::initialvalue()) {}

TRTCond::NestedContainerBase

Base class for nested containers.

Definition NestedContainer.h:151

TRTCond::NestedContainerBase::m_default

T m_default

Type of atomic element.

Definition NestedContainer.h:157

TRTCond::NestedContainerBase::m_daughters

DaughterContainer m_daughters

Container of Daughters.

Definition NestedContainer.h:156

◆ ~NestedContainerBase()

template<int NestingLevel, class Daughter, class T, class Trait>

TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::~NestedContainerBase ( )

default

destructor

Member Function Documentation

◆ clear() [1/2]

template<int NestingLevel, class Daughter, class T, class Trait>

void TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::clear ( )

inline

clear entire container

Definition at line 238 of file NestedContainer.h.

                 {
      for( typename DaughterContainer::iterator it = m_daughters.begin() ; it != m_daughters.end(); ++it ) 
    NestedContainerDaughterAccessor<Daughter,T,Trait>::clear(*it) ;
      m_daughters.clear() ;
      Trait::erase(m_default) ;
    }

◆ clear() [2/2]

template<int NestingLevel, class Daughter, class T, class Trait>

void TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::clear ( const ExpandedIdentifier & id )

inline

clear only entries specified

Definition at line 246 of file NestedContainer.h.

                                                {
      if( NestingLevel == id.level() ) clear() ;
      else {
    unsigned int thisindex = id.index(NestingLevel+1) ;
    if(thisindex<m_daughters.size()) 
      NestedContainerDaughterAccessor<Daughter,T,Trait>::clear(m_daughters[thisindex],id ) ;
      }
    }

◆ crunch()

template<int NestingLevel, class Daughter, class T, class Trait>

void TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::crunch ( )

inline

reduce the footprint as much as possible by removing the extra space allocated by the vectors

Definition at line 292 of file NestedContainer.h.

                  {
      // first the daughters 
      for( typename DaughterContainer::iterator it = m_daughters.begin() ; it != m_daughters.end(); ++it ) 
    NestedContainerDaughterAccessor<Daughter,T,Trait>::crunch(*it) ;
      // now use, if anything is there
      if( m_daughters.size()>0 ) {
    // find the first daughter that is valid
    size_t firstvaliddaughter(0);
    bool allequal(true) ;
    for(size_t idau=0; idau<m_daughters.size() && allequal; ++idau) {
      allequal = NestedContainerDaughterAccessor<Daughter,T,Trait>::empty(m_daughters[idau]) ;
      if( allequal ) {
        bool isvalid = Trait::isvalid( NestedContainerDaughterAccessor<Daughter,T,Trait>::get(m_daughters[idau])) ;
        if( isvalid ) {
          if( firstvaliddaughter==0 ) firstvaliddaughter = idau ;
        } else {
          allequal = NestedContainerDaughterAccessor<Daughter,T,Trait>::isequal(m_daughters[idau],m_daughters[firstvaliddaughter]) ;
        }
      }
    }
    if(allequal) {
      // set the default value to the value form the first daughter
      T defaultvalue(Trait::initialvalue()) ;
      if( firstvaliddaughter < m_daughters.size() ) 
        Trait::copy(defaultvalue,NestedContainerDaughterAccessor<Daughter,T,Trait>::get(m_daughters[firstvaliddaughter])) ;
      clear() ; // this clears pointers in the daughters. would rather replace that with destructors.
      m_daughters = DaughterContainer(0) ;
      m_default = defaultvalue ;
    } else if(m_daughters.size()<m_daughters.capacity())  {
      DaughterContainer newdaughters(0) ;
      newdaughters.reserve( m_daughters.size() ) ;
      newdaughters.insert( newdaughters.end(), m_daughters.begin(), m_daughters.end() ) ;
      newdaughters.swap(m_daughters) ;
    }
      }
    }

◆ daughters()

template<int NestingLevel, class Daughter, class T, class Trait>

const DaughterContainer & TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::daughters ( ) const

inline

return the vector of daughters

Definition at line 256 of file NestedContainer.h.

256{ return m_daughters ; }

◆ footprint()

template<int NestingLevel, class Daughter, class T, class Trait>

size_t TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::footprint ( ) const

inline

return the memory allocated by the container and its daughters

Definition at line 282 of file NestedContainer.h.

                             {
      size_t total = Trait::footprint(m_default) + (m_daughters.capacity()-m_daughters.size())*sizeof(Daughter) ;
      for( typename DaughterContainer::const_iterator it = m_daughters.begin() ; it != m_daughters.end(); ++it ) 
    total += NestedContainerDaughterAccessor<Daughter,T,Trait>::footprint(*it) ;
      return total ;
    }

◆ get() [1/3]

template<int NestingLevel, class Daughter, class T, class Trait>

const T & TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::get ( ) const

inline

get the default value

Definition at line 232 of file NestedContainer.h.

232{ return m_default ; }

◆ get() [2/3]

template<int NestingLevel, class Daughter, class T, class Trait>

const T & TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::get ( const ExpandedIdentifier & id ) const

inline

get a value.

return the default value if no valid entry for id exists.

Definition at line 205 of file NestedContainer.h.

                                                       {
      if( NestingLevel < id.level() ) {
    unsigned int thisindex = id.index(NestingLevel+1) ;
    if(thisindex<m_daughters.size()) {
      const T& rc = NestedContainerDaughterAccessor<Daughter,T,Trait>::get(m_daughters[thisindex],id) ;
      // only return this value if it is valid. otherwise, return the default.
      if( Trait::isvalid(rc) ) return rc ;
    }
      }
      return m_default ;
    }

◆ get() [3/3]

template<int NestingLevel, class Daughter, class T, class Trait>

const T & TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::get	(	const ExpandedIdentifier &	id,
		size_t &	resolvelevel ) const

inline

Definition at line 217 of file NestedContainer.h.

   {
     if( NestingLevel < id.level() ) {
       unsigned int thisindex = id.index(NestingLevel+1) ;
       if(thisindex<m_daughters.size()) {
          const T& rc = NestedContainerDaughterAccessor<Daughter,T,Trait>::get(m_daughters[thisindex],id,resolvelevel) ;
           if( Trait::isvalid(rc) ) return rc ;   
         }
      }
      resolvelevel = NestingLevel ; 
      return m_default ;
    }

◆ getall()

template<int NestingLevel, class Daughter, class T, class Trait>

void TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::getall ( FlatContainer & entries ) const

inline

Definition at line 347 of file NestedContainer.h.

                                                {
      // add the daughters
      for(unsigned int idau = 0; idau<m_daughters.size(); ++idau) {
    FlatContainer dauentries ;
    // first get them
    NestedContainerDaughterAccessor<Daughter,T,Trait>::getall(m_daughters[idau], dauentries) ;
    // now update the identifiers to have the dauhgter index  set correctly
    for(unsigned int j=0; j< dauentries.size(); ++j ) 
      dauentries[j].first.index(NestingLevel+1) = idau ;
    // and append
    entries.insert(entries.end(),dauentries.begin(),dauentries.end()) ;
      }
      // add the default value
      if( Trait::isvalid(m_default) ) {
    ExpandedIdentifier id(0,0,0,0,0,NestingLevel) ;
    entries.push_back( std::pair<ExpandedIdentifier, const T*>(id,&m_default)) ; 
      }
    }

◆ numObjects()

template<int NestingLevel, class Daughter, class T, class Trait>

size_t TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::numObjects ( ) const

inline

return the total number of valid calibration objects

Definition at line 260 of file NestedContainer.h.

                              { 
      size_t rc(0) ;
      assert( std::distance(m_daughters.begin(),m_daughters.end())==(int)m_daughters.size()) ;
      assert( m_daughters.size() < 1000 ) ;
      for( typename DaughterContainer::const_iterator it = m_daughters.begin() ; it != m_daughters.end(); ++it ) 
    rc += NestedContainerDaughterAccessor<Daughter,T,Trait>::numObjects(*it) ;
      if( Trait::isvalid(m_default) ) ++rc ;
      return rc ;
    }

◆ operator==() [1/2]

template<int NestingLevel, class Daughter, class T, class Trait>

bool TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::operator== ( const NestedContainerBase< NestingLevel, Daughter, T, Trait > & rhs ) const

inline

equality operator, used for compressing

Definition at line 272 of file NestedContainer.h.

                                                          {
      return m_daughters.size()==0 && rhs.m_daughters.size()==0 && Trait::isequal(m_default,rhs.m_default) ;
    }

◆ operator==() [2/2]

template<int NestingLevel, class Daughter, class T, class Trait>

bool TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::operator== ( const T & rhs ) const

inline

another equality operator, used for compressing

Definition at line 277 of file NestedContainer.h.

                                        {
      return m_daughters.size()==0 && Trait::isequal(m_default,rhs) ;
    }

◆ print()

template<int NestingLevel, class Daughter, class T, class Trait>

void TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::print ( ) const

inline

Definition at line 334 of file NestedContainer.h.

                       {
      printindent() ;
      ExpandedIdentifier id;
      std::cout << "level = " << id.name(NestingLevel) << " (" << NestingLevel << ")"  << std::endl ;
      for(unsigned int i=0; i< m_daughters.size(); ++i) {
    printindent() ;
    std::cout << "daughter " << i << std::endl ;
    NestedContainerDaughterAccessor<Daughter,T,Trait>::print(m_daughters[i]) ;
      }
    }

◆ printindent()

template<int NestingLevel, class Daughter, class T, class Trait>

void TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::printindent ( ) const

inline

some IO for debugging

Definition at line 330 of file NestedContainer.h.

                             {
      for(int i=0; i<NestingLevel; ++i) 
    std::cout << '\t' ;
    }

◆ set() [1/2]

template<int NestingLevel, class Daughter, class T, class Trait>

void TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::set	(	const ExpandedIdentifier &	id,
		const T &	t )

inline

set a value.

using 'level' in id we can specify if we want to set the default value.

Definition at line 191 of file NestedContainer.h.

                                                        {
      if( NestingLevel == id.level() ) {
    // set the default value
    Trait::copy(m_default,t) ;
      } else {
    unsigned int thisindex = id.index(NestingLevel+1) ;
    // expand daughter array if necessary
    if(thisindex>=m_daughters.size()) 
      m_daughters.resize( thisindex+1, NestedContainerDaughterAccessor<Daughter,T,Trait>::initialvalue() ) ; 
    NestedContainerDaughterAccessor<Daughter,T,Trait>::set(m_daughters[thisindex], id, t ) ;
      }
    }

◆ set() [2/2]

template<int NestingLevel, class Daughter, class T, class Trait>

void TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::set ( const T & t )

inline

set the default value

Definition at line 235 of file NestedContainer.h.

235{ Trait::copy(m_default,t) ; }

Member Data Documentation

◆ m_daughters

template<int NestingLevel, class Daughter, class T, class Trait>

DaughterContainer TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::m_daughters

private

Container of Daughters.

Definition at line 156 of file NestedContainer.h.

◆ m_default

template<int NestingLevel, class Daughter, class T, class Trait>

T TRTCond::NestedContainerBase< NestingLevel, Daughter, T, Trait >::m_default

private

Type of atomic element.

Definition at line 157 of file NestedContainer.h.

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

NestedContainer.h

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_value_type

◆ DaughterContainer

◆ FlatContainer

◆ trait_type

◆ value_type

Constructor & Destructor Documentation

◆ NestedContainerBase()

◆ ~NestedContainerBase()

Member Function Documentation

◆ clear() [1/2]

◆ clear() [2/2]

◆ crunch()

◆ daughters()

◆ footprint()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ getall()

◆ numObjects()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ print()

◆ printindent()

◆ set() [1/2]

◆ set() [2/2]

Member Data Documentation

◆ m_daughters

◆ m_default