OwningVector< T > Class Template Reference

Description

template<class T>
class OwningVector< T >

A vector of unique pointers to objects that are cloneable.

Equips vector<unique_ptr<T>> with copy constructor. For use with polymorphic objects, or in pimpl idiom. The objects pointed to must posses a clone() function.

Definition at line 35 of file OwningVector.h.

Collaboration diagram for OwningVector< T >:

Public Types
using	ConstIterator = typename std::vector< T * >::const_iterator
using	Iterator = typename std::vector< T * >::iterator

Public Member Functions
	OwningVector ()=default
	OwningVector (const OwningVector &other)
	Constructor that clones elements in given vector. More...
	OwningVector (const std::vector< T * > &v)
	Constructor that takes over ownership of elements in given vector. More...
	~OwningVector ()
T *const &	at (int i) const
const T *	back () const
Iterator	begin ()
ConstIterator	begin () const
void	clear ()
std::vector< T * >	cloned_vector () const
std::vector< const T * >	const_vector () const
void	emplace_back (T *e)
bool	empty () const
Iterator	end ()
ConstIterator	end () const
OwningVector &	operator= (const OwningVector &other)
T *const &	operator[] (int i) const
size_t	size () const

Private Attributes
std::vector< T * >	m_v

Member Typedef Documentation

ConstIterator

template<class T >

using OwningVector< T >::ConstIterator = typename std::vector<T*>::const_iterator

Definition at line 90 of file OwningVector.h.

Iterator

template<class T >

using OwningVector< T >::Iterator = typename std::vector<T*>::iterator

Definition at line 89 of file OwningVector.h.

Constructor & Destructor Documentation

OwningVector() [1/3]

template<class T >

OwningVector< T >::OwningVector ( )

default

OwningVector() [2/3]

template<class T >

OwningVector< T >::OwningVector ( const std::vector< T * > &  v )

inline

Constructor that takes over ownership of elements in given vector.

Definition at line 39 of file OwningVector.h.

    {
        m_v.reserve(v.size());
        for (T* e : v)
            m_v.emplace_back(e);
    }

References OwningVector< T >::m_v.

OwningVector() [3/3]

template<class T >

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

inline

Constructor that clones elements in given vector.

Definition at line 46 of file OwningVector.h.

    {
        m_v.reserve(other.size());
        for (T* e : other)
            m_v.emplace_back(e->clone());
    }

References OwningVector< T >::m_v, and OwningVector< T >::size().

Here is the call graph for this function:

~OwningVector()

template<class T >

OwningVector< T >::~OwningVector ( )

inline

Definition at line 52 of file OwningVector.h.

{ clear(); }

References OwningVector< T >::clear().

Here is the call graph for this function:

Member Function Documentation

at()

template<class T >

T* const& OwningVector< T >::at ( int  i ) const

inline

Definition at line 73 of file OwningVector.h.

{ return m_v.at(i); }

References OwningVector< T >::m_v.

Referenced by Frame::axis(), MultiLayer::layer(), MultiLayer::layerInterface(), DetectorMask::patternAt(), Frame::xAxis(), and Frame::yAxis().

back()

template<class T >

const T* OwningVector< T >::back ( ) const

inline

Definition at line 74 of file OwningVector.h.

{ return m_v.back(); }

References OwningVector< T >::m_v.

Referenced by MultiLayer::addLayerWithTopRoughness().

begin() [1/2]

template<class T >

Iterator OwningVector< T >::begin ( )

inline

Definition at line 94 of file OwningVector.h.

{ return m_v.begin(); }

References OwningVector< T >::m_v.

begin() [2/2]

template<class T >

ConstIterator OwningVector< T >::begin ( ) const

inline

Definition at line 92 of file OwningVector.h.

{ return m_v.begin(); }

References OwningVector< T >::m_v.

clear()

template<class T >

void OwningVector< T >::clear ( )

inline

Definition at line 63 of file OwningVector.h.

    {
        for (T* e : *this)
            delete e;
        m_v.clear();
    }

References OwningVector< T >::m_v.

Referenced by OwningVector< T >::~OwningVector(), and IDetector::clear().

cloned_vector()

template<class T >

std::vector<T*> OwningVector< T >::cloned_vector ( ) const

inline

Definition at line 81 of file OwningVector.h.

    {
        std::vector<T*> ret;
        for (T* e : m_v)
            ret.emplace_back(e->clone());
        return ret;
    }

References OwningVector< T >::m_v.

Referenced by Frame::cloned_axes().

const_vector()

template<class T >

std::vector<const T*> OwningVector< T >::const_vector ( ) const

inline

Definition at line 76 of file OwningVector.h.

    {
        const std::vector<const T*> ret(m_v.begin(), m_v.end());
        return ret;
    }

References OwningVector< T >::m_v.

emplace_back()

template<class T >

void OwningVector< T >::emplace_back ( T *  e )

inline

Definition at line 62 of file OwningVector.h.

{ m_v.emplace_back(e); }

References OwningVector< T >::m_v.

Referenced by ParticleLayout::addAndRegisterAbstractParticle(), CoordSystem2D::addAxisData(), IDetector::addDetAxis(), MultiLayer::addInterface(), MultiLayer::addLayer(), DetectorMask::addMask(), ParticleComposition::addParticle(), and IDetector::axesClippedToRegionOfInterest().

empty()

template<class T >

bool OwningVector< T >::empty ( ) const

inline

Definition at line 71 of file OwningVector.h.

{ return m_v.empty(); }

References OwningVector< T >::m_v.

Referenced by IDetector::hasExplicitRegionOfInterest(), DetectorMask::hasMasks(), and DetectorMask::process_masks().

end() [1/2]

template<class T >

Iterator OwningVector< T >::end ( )

inline

Definition at line 95 of file OwningVector.h.

{ return m_v.end(); }

References OwningVector< T >::m_v.

end() [2/2]

template<class T >

ConstIterator OwningVector< T >::end ( ) const

inline

Definition at line 93 of file OwningVector.h.

{ return m_v.end(); }

References OwningVector< T >::m_v.

operator=()

template<class T >

OwningVector& OwningVector< T >::operator= ( const OwningVector< T > &  other )

inline

Definition at line 53 of file OwningVector.h.

    {
        if (this == &other)
            return *this;
        OwningVector ret(other);
        std::swap(m_v, ret.m_v);
        return *this;
    }

References OwningVector< T >::m_v.

operator[]()

template<class T >

T* const& OwningVector< T >::operator[] ( int  i ) const

inline

Definition at line 72 of file OwningVector.h.

{ return m_v.operator[](i); }

References OwningVector< T >::m_v.

size()

template<class T >

size_t OwningVector< T >::size ( ) const

inline

Definition at line 70 of file OwningVector.h.

{ return m_v.size(); }

References OwningVector< T >::m_v.

Referenced by ImageCoords::ImageCoords(), OwningVector< T >::OwningVector(), SphericalCoords::SphericalCoords(), IDetector::axesClippedToRegionOfInterest(), IDetector::axisBinIndex(), CoordSystem2D::axisSize(), CoordSystem2D::calculateMax(), ParticleComposition::clone(), IDetector::hasExplicitRegionOfInterest(), ParticleComposition::nbrParticles(), MultiLayer::nodeChildren(), MultiLayer::numberOfLayers(), DetectorMask::numberOfMasks(), DetectorMask::process_masks(), Frame::projectedIndex(), Frame::projectedSize(), Frame::rank(), IDetector::rank(), CoordSystem2D::rank(), IDetector::regionOfInterestBounds(), IDetector::sizeOfExplicitRegionOfInterest(), and Frame::toGlobalIndex().

Member Data Documentation

m_v

template<class T >

std::vector<T*> OwningVector< T >::m_v

private

Definition at line 98 of file OwningVector.h.

Referenced by OwningVector< T >::OwningVector(), OwningVector< T >::at(), OwningVector< T >::back(), OwningVector< T >::begin(), OwningVector< T >::clear(), OwningVector< T >::cloned_vector(), OwningVector< T >::const_vector(), OwningVector< T >::emplace_back(), OwningVector< T >::empty(), OwningVector< T >::end(), OwningVector< T >::operator=(), OwningVector< T >::operator[](), and OwningVector< T >::size().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Types/OwningVector.h