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

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

#include <Storage.h>

Public Member Functions

 StorageSequence (FlatMap< QuantityId, Quantity > &quantities, Badge< Storage >)
 
StorageIterator begin ()
 Returns iterator pointing to the beginning of the quantity storage. More...
 
StorageIterator 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 iterators to the first and last quantity in Storage, respectively.

Definition at line 79 of file Storage.h.

Constructor & Destructor Documentation

◆ StorageSequence()

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

Definition at line 51 of file Storage.cpp.

Member Function Documentation

◆ begin()

StorageIterator StorageSequence::begin ( )

Returns iterator pointing to the beginning of the quantity storage.

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

Definition at line 54 of file Storage.cpp.

◆ end()

StorageIterator StorageSequence::end ( )

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

Definition at line 58 of file Storage.cpp.

◆ size()

Size StorageSequence::size ( ) const

Returns the number of quantities.

Definition at line 62 of file Storage.cpp.


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