Records kept in the order they were added, unique by the member KeyMember. More...

#include <OpenMS/METADATA/ID/IDDataContainer.h>

Classes
class	ConstOrderedView
	Lookup of records by key. More...

struct	nth_index

class	OrderedView

Public Types
using	value_type = Value

using	key_type = Key

using	size_type = std::size_t

using	iterator = typename std::vector< Value >::const_iterator

using	const_iterator = iterator

using	reverse_iterator = std::reverse_iterator< iterator >

using	const_reverse_iterator = reverse_iterator

Public Member Functions
	IDSequencedContainer ()=default

	IDSequencedContainer (std::initializer_list< Value > values)

iterator	begin () const

iterator	end () const

iterator	cbegin () const

iterator	cend () const

reverse_iterator	rbegin () const

reverse_iterator	rend () const

const Value &	front () const

const Value &	back () const

bool	empty () const

size_type	size () const

void	clear ()

void	swap (IDSequencedContainer &other) noexcept

std::pair< iterator, bool >	push_back (const Value &value)
	Appends `value` unless a record with its key exists; then that record and false.

std::pair< iterator, bool >	insert (const Value &value)

template<typename... Args>
std::pair< iterator, bool >	emplace_back (Args &&... args)

template<typename... Args>
std::pair< iterator, bool >	emplace (Args &&... args)

iterator	erase (iterator position)

iterator	find (const Key &key) const

std::pair< iterator, iterator >	equal_range (const Key &key) const

template<typename Modifier >
bool	modify (iterator &position, Modifier &&modifier)
	As IDDataContainer::modify(): a modification that duplicates another record's key erases the record.

template<int Index>
OrderedView	get ()

template<int Index>
ConstOrderedView	get () const

Private Attributes
std::vector< Value >	records_

Friends
bool	operator== (const IDSequencedContainer &lhs, const IDSequencedContainer &rhs)
	Value equality is available only for equality-comparable record types.

Detailed Description

template<typename Value, typename Key, auto KeyMember>
class OpenMS::IdentificationDataInternal::IDSequencedContainer< Value, Key, KeyMember >

Records kept in the order they were added, unique by the member KeyMember.

Used for the processing steps applied to a record: a handful per record, looked up by step. get<1>() gives the lookup view by key that Boost.MultiIndex's second index used to provide.

Class Documentation

◆ OpenMS::IdentificationDataInternal::IDSequencedContainer::nth_index

struct OpenMS::IdentificationDataInternal::IDSequencedContainer::nth_index

template<typename Value, typename Key, auto KeyMember>
template<int Index>
struct OpenMS::IdentificationDataInternal::IDSequencedContainer< Value, Key, KeyMember >::nth_index< Index >

Class Members
typedef OrderedView	type

Member Typedef Documentation

◆ const_iterator

template<typename Value , typename Key , auto KeyMember>

using const_iterator = iterator

◆ const_reverse_iterator

template<typename Value , typename Key , auto KeyMember>

using const_reverse_iterator = reverse_iterator

◆ iterator

template<typename Value , typename Key , auto KeyMember>

using iterator = typename std::vector<Value>::const_iterator

◆ key_type

template<typename Value , typename Key , auto KeyMember>

using key_type = Key

◆ reverse_iterator

template<typename Value , typename Key , auto KeyMember>

using reverse_iterator = std::reverse_iterator<iterator>

◆ size_type

template<typename Value , typename Key , auto KeyMember>

using size_type = std::size_t

◆ value_type

template<typename Value , typename Key , auto KeyMember>

using value_type = Value

Constructor & Destructor Documentation

◆ IDSequencedContainer() [1/2]

template<typename Value , typename Key , auto KeyMember>

IDSequencedContainer ( )

default

◆ IDSequencedContainer() [2/2]

template<typename Value , typename Key , auto KeyMember>

IDSequencedContainer ( std::initializer_list< Value > values )

inline

References IDSequencedContainer< Value, Key, KeyMember >::push_back().

Member Function Documentation

◆ back()

template<typename Value , typename Key , auto KeyMember>

const Value & back ( ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::records_.

◆ begin()

template<typename Value , typename Key , auto KeyMember>

iterator begin ( ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::records_.

Referenced by IDSequencedContainer< Value, Key, KeyMember >::cbegin(), IDSequencedContainer< Value, Key, KeyMember >::modify(), and IDSequencedContainer< Value, Key, KeyMember >::rend().

◆ cbegin()

template<typename Value , typename Key , auto KeyMember>

iterator cbegin ( ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::begin().

◆ cend()

template<typename Value , typename Key , auto KeyMember>

iterator cend ( ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::end().

◆ clear()

template<typename Value , typename Key , auto KeyMember>

void clear ( )

inline

References IDSequencedContainer< Value, Key, KeyMember >::records_.

◆ emplace()

template<typename Value , typename Key , auto KeyMember>

template<typename... Args>

std::pair< iterator, bool > emplace ( Args &&... args )

inline

References IDSequencedContainer< Value, Key, KeyMember >::emplace_back().

◆ emplace_back()

template<typename Value , typename Key , auto KeyMember>

template<typename... Args>

std::pair< iterator, bool > emplace_back ( Args &&... args )

inline

References IDSequencedContainer< Value, Key, KeyMember >::push_back().

Referenced by IDSequencedContainer< Value, Key, KeyMember >::emplace().

◆ empty()

template<typename Value , typename Key , auto KeyMember>

bool empty ( ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::records_.

Referenced by IDSequencedContainer< Value, Key, KeyMember >::ConstOrderedView::empty().

◆ end()

template<typename Value , typename Key , auto KeyMember>

iterator end ( ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::records_.

Referenced by IDSequencedContainer< Value, Key, KeyMember >::cend(), IDSequencedContainer< Value, Key, KeyMember >::ConstOrderedView::end(), IDSequencedContainer< Value, Key, KeyMember >::equal_range(), IDSequencedContainer< Value, Key, KeyMember >::modify(), IDSequencedContainer< Value, Key, KeyMember >::push_back(), and IDSequencedContainer< Value, Key, KeyMember >::rbegin().

◆ equal_range()

template<typename Value , typename Key , auto KeyMember>

std::pair< iterator, iterator > equal_range ( const Key & key ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::end(), and IDSequencedContainer< Value, Key, KeyMember >::find().

◆ erase()

template<typename Value , typename Key , auto KeyMember>

iterator erase ( iterator position )

inline

References IDSequencedContainer< Value, Key, KeyMember >::records_.

Referenced by IDSequencedContainer< Value, Key, KeyMember >::modify().

◆ find()

template<typename Value , typename Key , auto KeyMember>

iterator find ( const Key & key ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::records_.

Referenced by IDSequencedContainer< Value, Key, KeyMember >::equal_range(), IDSequencedContainer< Value, Key, KeyMember >::ConstOrderedView::find(), and IDSequencedContainer< Value, Key, KeyMember >::push_back().

◆ front()

template<typename Value , typename Key , auto KeyMember>

const Value & front ( ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::records_.

◆ get() [1/2]

template<typename Value , typename Key , auto KeyMember>

template<int Index>

OrderedView get ( )

inline

Referenced by ScoredProcessingResult::getStepsAndScoresByStep(), and ScoredProcessingResult::getStepsAndScoresByStep().

◆ get() [2/2]

template<typename Value , typename Key , auto KeyMember>

template<int Index>

ConstOrderedView get ( ) const

inline

◆ insert()

template<typename Value , typename Key , auto KeyMember>

std::pair< iterator, bool > insert ( const Value & value )

inline

References IDSequencedContainer< Value, Key, KeyMember >::push_back().

◆ modify()

template<typename Value , typename Key , auto KeyMember>

template<typename Modifier >

bool modify	(	iterator &	position,
		Modifier &&	modifier
	)

inline

As IDDataContainer::modify(): a modification that duplicates another record's key erases the record.

References IDSequencedContainer< Value, Key, KeyMember >::begin(), IDSequencedContainer< Value, Key, KeyMember >::end(), IDSequencedContainer< Value, Key, KeyMember >::erase(), and IDSequencedContainer< Value, Key, KeyMember >::records_.

Referenced by IDSequencedContainer< Value, Key, KeyMember >::OrderedView::modify().

◆ push_back()

template<typename Value , typename Key , auto KeyMember>

std::pair< iterator, bool > push_back ( const Value & value )

inline

Appends value unless a record with its key exists; then that record and false.

References IDSequencedContainer< Value, Key, KeyMember >::end(), IDSequencedContainer< Value, Key, KeyMember >::find(), and IDSequencedContainer< Value, Key, KeyMember >::records_.

Referenced by IDSequencedContainer< Value, Key, KeyMember >::emplace_back(), IDSequencedContainer< Value, Key, KeyMember >::IDSequencedContainer(), and IDSequencedContainer< Value, Key, KeyMember >::insert().

◆ rbegin()

template<typename Value , typename Key , auto KeyMember>

reverse_iterator rbegin ( ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::end().

◆ rend()

template<typename Value , typename Key , auto KeyMember>

reverse_iterator rend ( ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::begin().

◆ size()

template<typename Value , typename Key , auto KeyMember>

size_type size ( ) const

inline

References IDSequencedContainer< Value, Key, KeyMember >::records_.

Referenced by IDSequencedContainer< Value, Key, KeyMember >::ConstOrderedView::size().

◆ swap()

template<typename Value , typename Key , auto KeyMember>

void swap ( IDSequencedContainer< Value, Key, KeyMember > & other )

inlinenoexcept

References IDSequencedContainer< Value, Key, KeyMember >::records_.

Friends And Related Symbol Documentation

◆ operator==

template<typename Value , typename Key , auto KeyMember>

bool operator==	(	const IDSequencedContainer< Value, Key, KeyMember > &	lhs,
		const IDSequencedContainer< Value, Key, KeyMember > &	rhs
	)

friend

Value equality is available only for equality-comparable record types.

Member Data Documentation

◆ records_

template<typename Value , typename Key , auto KeyMember>

std::vector<Value> records_

private

Classes

Public Types

Public Member Functions

Private Attributes

Friends

Detailed Description

Class Documentation

◆ OpenMS::IdentificationDataInternal::IDSequencedContainer::nth_index

Member Typedef Documentation

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ key_type

◆ reverse_iterator

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ IDSequencedContainer() [1/2]

◆ IDSequencedContainer() [2/2]

Member Function Documentation

◆ back()

◆ begin()

◆ cbegin()

◆ cend()

◆ clear()

◆ emplace()

◆ emplace_back()

◆ empty()

◆ end()

◆ equal_range()

◆ erase()

◆ find()

◆ front()

◆ get() [1/2]

◆ get() [2/2]

◆ insert()

◆ modify()

◆ push_back()

◆ rbegin()

◆ rend()

◆ size()

◆ swap()

Friends And Related Symbol Documentation

◆ operator==

Member Data Documentation

◆ records_