Mantid
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | List of all members
MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType > Class Template Reference

A class which wraps a vector so that you supply not only the value type but also the expected index type. More...

#include <IndexTypes.h>

Public Types

using CollectionImplementationType = std::vector< CollectionValueType >
 

Public Member Functions

CollectionValueType & back ()
 
const CollectionValueType & back () const
 
CollectionImplementationType::iterator begin ()
 
CollectionImplementationType::const_iterator begin () const
 
void clear ()
 
template<class... Args>
void emplace_back (Args &&...args)
 
bool empty () const
 
CollectionImplementationType::iterator end ()
 
CollectionImplementationType::const_iterator end () const
 
CollectionValueType & front ()
 
const CollectionValueType & front () const
 
CollectionIndexType last () const
 
CollectionValueType & operator[] (const CollectionIndexType &dataIndex)
 
const CollectionValueType & operator[] (const CollectionIndexType &dataIndex) const
 
void remove (const CollectionIndexType &dataIndex)
 
CollectionIndexType size () const
 
CollectionIndexType zero () const
 

Private Attributes

CollectionImplementationType m_collection
 

Detailed Description

template<class CollectionIndexType, class CollectionValueType>
class MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >

A class which wraps a vector so that you supply not only the value type but also the expected index type.

Definition at line 68 of file IndexTypes.h.

Member Typedef Documentation

◆ CollectionImplementationType

template<class CollectionIndexType , class CollectionValueType >
using MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::CollectionImplementationType = std::vector<CollectionValueType>

Definition at line 70 of file IndexTypes.h.

Member Function Documentation

◆ back() [1/2]

template<class CollectionIndexType , class CollectionValueType >
CollectionValueType & MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::back ( )
inline

Definition at line 85 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ back() [2/2]

template<class CollectionIndexType , class CollectionValueType >
const CollectionValueType & MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::back ( ) const
inline

Definition at line 87 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ begin() [1/2]

template<class CollectionIndexType , class CollectionValueType >
CollectionImplementationType::iterator MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::begin ( )
inline

Definition at line 90 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ begin() [2/2]

template<class CollectionIndexType , class CollectionValueType >
CollectionImplementationType::const_iterator MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::begin ( ) const
inline

Definition at line 92 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ clear()

template<class CollectionIndexType , class CollectionValueType >
void MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::clear ( )
inline

Definition at line 94 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ emplace_back()

template<class CollectionIndexType , class CollectionValueType >
template<class... Args>
void MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::emplace_back ( Args &&...  args)
inline

Definition at line 88 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ empty()

template<class CollectionIndexType , class CollectionValueType >
bool MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::empty ( ) const
inline

Definition at line 83 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ end() [1/2]

template<class CollectionIndexType , class CollectionValueType >
CollectionImplementationType::iterator MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::end ( )
inline

Definition at line 91 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ end() [2/2]

template<class CollectionIndexType , class CollectionValueType >
CollectionImplementationType::const_iterator MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::end ( ) const
inline

Definition at line 93 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ front() [1/2]

template<class CollectionIndexType , class CollectionValueType >
CollectionValueType & MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::front ( )
inline

Definition at line 84 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ front() [2/2]

template<class CollectionIndexType , class CollectionValueType >
const CollectionValueType & MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::front ( ) const
inline

Definition at line 86 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ last()

template<class CollectionIndexType , class CollectionValueType >
CollectionIndexType MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::last ( ) const
inline

Definition at line 79 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ operator[]() [1/2]

template<class CollectionIndexType , class CollectionValueType >
CollectionValueType & MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::operator[] ( const CollectionIndexType &  dataIndex)
inline

Definition at line 74 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ operator[]() [2/2]

template<class CollectionIndexType , class CollectionValueType >
const CollectionValueType & MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::operator[] ( const CollectionIndexType &  dataIndex) const
inline

Definition at line 71 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ remove()

template<class CollectionIndexType , class CollectionValueType >
void MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::remove ( const CollectionIndexType &  dataIndex)
inline

Definition at line 89 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ size()

template<class CollectionIndexType , class CollectionValueType >
CollectionIndexType MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::size ( ) const
inline

Definition at line 75 of file IndexTypes.h.

References MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection.

◆ zero()

template<class CollectionIndexType , class CollectionValueType >
CollectionIndexType MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::zero ( ) const
inline

Definition at line 78 of file IndexTypes.h.

Member Data Documentation

◆ m_collection

template<class CollectionIndexType , class CollectionValueType >
CollectionImplementationType MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::m_collection
private

Definition at line 97 of file IndexTypes.h.

Referenced by MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::back(), MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::begin(), MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::clear(), MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::emplace_back(), MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::empty(), MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::end(), MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::front(), MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::last(), MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::operator[](), MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::remove(), and MantidQt::MantidWidgets::IndexCollectionType< CollectionIndexType, CollectionValueType >::size().

The documentation for this class was generated from the following file:
Generated on Tue Jan 3 2023 12:00:52 for Mantid by doxygen 1.9.5