SPH
Public Member Functions | List of all members
ConstStorageSequence Class Reference

Helper class, provides functions begin and end, returning const iterators to the first and last quantity in Storage, respectively. More...

#include <Storage.h>

Public Member Functions

 ConstStorageSequence (const FlatMap< QuantityId, Quantity > &quantities, Badge< Storage >)
 
ConstStorageIterator begin ()
 Returns iterator pointing to the beginning of the quantity storage. More...
 
ConstStorageIterator end ()
 Returns iterator pointing to the one-past-the-end element of the quantity storage. More...
 
Size size () const
 Returns the number of quantities. More...
 

Detailed Description

Helper class, provides functions begin and end, returning const iterators to the first and last quantity in Storage, respectively.

Definition at line 101 of file Storage.h.

Constructor & Destructor Documentation

◆ ConstStorageSequence()

ConstStorageSequence::ConstStorageSequence ( const FlatMap< QuantityId, Quantity > &  quantities,
Badge< Storage  
)

Definition at line 66 of file Storage.cpp.

Member Function Documentation

◆ begin()

ConstStorageIterator ConstStorageSequence::begin ( )

Returns iterator pointing to the beginning of the quantity storage.

Dereferencing the iterator yields ConstStorageElement, holding the QuantityId and the reference to the Quantity.

Definition at line 69 of file Storage.cpp.

◆ end()

ConstStorageIterator ConstStorageSequence::end ( )

Returns iterator pointing to the one-past-the-end element of the quantity storage.

Definition at line 73 of file Storage.cpp.

◆ size()

Size ConstStorageSequence::size ( ) const

Returns the number of quantities.

Definition at line 77 of file Storage.cpp.


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