#include <OrbitCollection.h>

Public Types
typedef std::vector< T >::const_iterator	const_iterator

typedef std::vector< T >::iterator	iterator

typedef std::vector< T >::size_type	size_type

typedef T	value_type

Public Member Functions
const_iterator	begin () const

edm::Span< const_iterator >	bxIterator (unsigned bx) const

const_iterator	end () const

void	fillAndClear (std::vector< std::vector< T >> &orbitBuffer, unsigned nObjects=0)

const T &	getBxObject (unsigned bx, unsigned i) const

unsigned	getBxSize (unsigned bx) const

std::vector< unsigned >	getFilledBxs () const

OrbitCollection &	operator= (const OrbitCollection &other)=default

OrbitCollection &	operator= (OrbitCollection &&other)=default

T &	operator[] (std::size_t i)

const T &	operator[] (std::size_t i) const

	OrbitCollection ()

	OrbitCollection (std::vector< std::vector< T >> &orbitBuffer, unsigned nObjects=0)

	OrbitCollection (const OrbitCollection &other)=default

	OrbitCollection (OrbitCollection &&other)=default

int	size () const

Static Public Member Functions
static short	Class_Version ()

Private Attributes
std::vector< unsigned >	bxOffsets_

std::vector< T >	data_

Static Private Attributes
static constexpr int	orbitBufferSize_ = 3565

Detailed Description

template<class T>
class OrbitCollection< T >

Definition at line 12 of file OrbitCollection.h.

Member Typedef Documentation

◆ const_iterator

template<class T >

typedef std::vector<T>::const_iterator OrbitCollection< T >::const_iterator

Definition at line 15 of file OrbitCollection.h.

◆ iterator

template<class T >

typedef std::vector<T>::iterator OrbitCollection< T >::iterator

Definition at line 14 of file OrbitCollection.h.

◆ size_type

template<class T >

typedef std::vector<T>::size_type OrbitCollection< T >::size_type

Definition at line 17 of file OrbitCollection.h.

◆ value_type

template<class T >

typedef T OrbitCollection< T >::value_type

Definition at line 16 of file OrbitCollection.h.

Constructor & Destructor Documentation

◆ OrbitCollection() [1/4]

template<class T >

OrbitCollection< T >::OrbitCollection ( )

inline

Definition at line 21 of file OrbitCollection.h.

21 : bxOffsets_(orbitBufferSize_ + 1, 0), data_(0) {}

OrbitCollection::bxOffsets_

std::vector< unsigned > bxOffsets_

Definition: OrbitCollection.h:127

OrbitCollection::data_

std::vector< T > data_

Definition: OrbitCollection.h:128

OrbitCollection::orbitBufferSize_

static constexpr int orbitBufferSize_

Definition: OrbitCollection.h:132

◆ OrbitCollection() [2/4]

template<class T >

OrbitCollection< T >::OrbitCollection	(	std::vector< std::vector< T >> &	orbitBuffer,
		unsigned	nObjects = `0`
	)

inline

Definition at line 25 of file OrbitCollection.h.

References OrbitCollection< T >::fillAndClear().

       : bxOffsets_(orbitBufferSize_ + 1, 0), data_(nObjects) {
     fillAndClear(orbitBuffer, nObjects);
   }

◆ OrbitCollection() [3/4]

template<class T >

OrbitCollection< T >::OrbitCollection ( const OrbitCollection< T > & other )

default

◆ OrbitCollection() [4/4]

template<class T >

OrbitCollection< T >::OrbitCollection ( OrbitCollection< T > && other )

default

Member Function Documentation

◆ begin()

template<class T >

const_iterator OrbitCollection< T >::begin ( void ) const

inline

Definition at line 65 of file OrbitCollection.h.

References OrbitCollection< T >::data_.

65 { return data_.begin(); }

OrbitCollection::data_

std::vector< T > data_

Definition: OrbitCollection.h:128

◆ bxIterator()

template<class T >

edm::Span<const_iterator> OrbitCollection< T >::bxIterator ( unsigned bx ) const

inline

Definition at line 69 of file OrbitCollection.h.

References nano_mu_digi_cff::bx, OrbitCollection< T >::bxOffsets_, OrbitCollection< T >::data_, OrbitCollection< T >::end(), Exception, OrbitCollection< T >::getBxSize(), and OrbitCollection< T >::orbitBufferSize_.

Referenced by DumpScObjects::printBx().

                                                         {
     if (bx >= orbitBufferSize_)
       throw cms::Exception("OrbitCollection::bxIterator") << "Trying to access and object outside the orbit range. "
                                                           << " BX = " << bx;
     if (getBxSize(bx) > 0) {
       return edm::Span(data_.begin() + bxOffsets_[bx], data_.begin() + bxOffsets_[bx + 1]);
     } else {
       return edm::Span(end(), end());
     }
   }

◆ Class_Version()

template<class T >

static short OrbitCollection< T >::Class_Version ( )

inlinestatic

Definition at line 121 of file OrbitCollection.h.

123 :

124 // store data vector and BX offsets as flat vectors.

◆ end()

template<class T >

const_iterator OrbitCollection< T >::end ( void ) const

inline

Definition at line 66 of file OrbitCollection.h.

References OrbitCollection< T >::data_.

Referenced by OrbitCollection< T >::bxIterator(), Types.LuminosityBlockRange::cppID(), and Types.EventRange::cppID().

66 { return data_.end(); }

OrbitCollection::data_

std::vector< T > data_

Definition: OrbitCollection.h:128

◆ fillAndClear()

template<class T >

void OrbitCollection< T >::fillAndClear	(	std::vector< std::vector< T >> &	orbitBuffer,
		unsigned	nObjects = `0`
	)

inline

Definition at line 40 of file OrbitCollection.h.

References OrbitCollection< T >::bxOffsets_, OrbitCollection< T >::data_, and OrbitCollection< T >::orbitBufferSize_.

Referenced by OrbitCollection< T >::OrbitCollection().

                                                                                  {
     if (orbitBuffer.size() != orbitBufferSize_)
       throw cms::Exception("OrbitCollection::fillAndClear")
           << "Trying to fill the collection by passing an orbit buffer with incorrect size. "
           << "Passed " << orbitBuffer.size() << ", expected 3565";
     data_.reserve(nObjects);
     bxOffsets_[0] = 0;
     unsigned bxIdx = 1;
     for (auto& bxVec : orbitBuffer) {
       // increase offset by the currect vec size
       bxOffsets_[bxIdx] = bxOffsets_[bxIdx - 1] + bxVec.size();
 
       // if bxVec contains something, copy it into the data_ vector
       // and clear original bxVec objects
       if (bxVec.size() > 0) {
         data_.insert(data_.end(), bxVec.begin(), bxVec.end());
         bxVec.clear();
       }
 
       // increment bx index
       bxIdx++;
     }
   }

◆ getBxObject()

template<class T >

const T& OrbitCollection< T >::getBxObject	(	unsigned	bx,
		unsigned	i
	)		const

inline

Definition at line 91 of file OrbitCollection.h.

References nano_mu_digi_cff::bx, OrbitCollection< T >::bxOffsets_, OrbitCollection< T >::data_, Exception, OrbitCollection< T >::getBxSize(), mps_fire::i, and OrbitCollection< T >::orbitBufferSize_.

                                                       {
     if (bx >= orbitBufferSize_)
       throw cms::Exception("OrbitCollection::getBxObject") << "Trying to access and object outside the orbit range. "
                                                            << " BX = " << bx;
     if (i >= getBxSize(bx))
       throw cms::Exception("OrbitCollection::getBxObject")
           << "Trying to get element " << i << " but for"
           << " BX = " << bx << " there are " << getBxSize(bx) << " elements.";
 
     return data_[bxOffsets_[bx] + i];
   }

◆ getBxSize()

template<class T >

unsigned OrbitCollection< T >::getBxSize ( unsigned bx ) const

inline

Definition at line 81 of file OrbitCollection.h.

References nano_mu_digi_cff::bx, OrbitCollection< T >::bxOffsets_, Exception, and OrbitCollection< T >::orbitBufferSize_.

Referenced by OrbitCollection< T >::bxIterator(), and OrbitCollection< T >::getBxObject().

                                         {
     if (bx >= orbitBufferSize_) {
       cms::Exception("OrbitCollection") << "Called getBxSize() of a bx out of the orbit range."
                                         << " BX = " << bx;
       return 0;
     }
     return bxOffsets_[bx + 1] - bxOffsets_[bx];
   }

◆ getFilledBxs()

template<class T >

std::vector<unsigned> OrbitCollection< T >::getFilledBxs ( ) const

inline

Definition at line 104 of file OrbitCollection.h.

References nano_mu_digi_cff::bx, OrbitCollection< T >::bxOffsets_, OrbitCollection< T >::data_, and OrbitCollection< T >::orbitBufferSize_.

Referenced by DumpScObjects::analyze().

                                            {
     std::vector<unsigned> filledBxVec;
     if (!data_.empty()) {
       for (unsigned bx = 0; bx < orbitBufferSize_; bx++) {
         if ((bxOffsets_[bx + 1] - bxOffsets_[bx]) > 0)
           filledBxVec.push_back(bx);
       }
     }
     return filledBxVec;
   }