A Source adapter for a container; pulls items from the front. More...
#include "container_front_source.hpp"
Inheritance diagram for Om::Source::ContainerFrontSource< ThisItem, ThisContainer >: Collaboration diagram for Om::Source::ContainerFrontSource< ThisItem, ThisContainer >:Public Member Functions | |
| ContainerFrontSource (ThisContainer &) | |
| ContainerFrontSource & | operator= (ContainerFrontSource) |
| virtual bool | operator! () const |
| virtual ThisItem & | operator* () const |
| bool | Equals (ContainerFrontSource const &) const |
| virtual void | Pop () |
| Pops the current item. More... | |
| void | Swap (ContainerFrontSource &) |
| Public Member Functions inherited from Om::Source::DefaultSource< ThisItem, ContainerFrontSource< ThisItem, ThisContainer > > | |
| virtual | ~DefaultSource ()=0 |
| ContainerFrontSource< ThisItem, ThisContainer > & | operator++ () |
| Pulls the next item from the Source. More... | |
| ContainerFrontSource< ThisItem, ThisContainer > | operator++ (int) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
| virtual bool | Equals (Source< ThisItem > const &) const |
| bool | Equals (ContainerFrontSource< ThisItem, ThisContainer > const &) const |
| Public Member Functions inherited from Om::Source::Source< ThisItem > | |
| virtual | ~Source ()=0 |
| ThisItem * | operator-> () const |
| operator Boolean () const | |
| Implements the Safe Boolean idiom. More... | |
Private Attributes | |
| ThisContainer & | thisContainer |
| The container to pull from. More... | |
Additional Inherited Members | |
| Public Types inherited from Om::Source::Source< ThisItem > | |
| typedef void(Source::* | Boolean) () const |
| The implementation of the Safe Boolean idiom. More... | |
Detailed Description
template<typename ThisItem, typename ThisContainer>
class Om::Source::ContainerFrontSource< ThisItem, ThisContainer >
Definition at line 36 of file container_front_source.hpp.
Constructor & Destructor Documentation
◆ ContainerFrontSource()
template<typename ThisItem , typename ThisContainer >
|
explicit |
Member Function Documentation
◆ operator=()
template<typename ThisItem , typename ThisContainer >
| ContainerFrontSource& Om::Source::ContainerFrontSource< ThisItem, ThisContainer >::operator= | ( | ContainerFrontSource< ThisItem, ThisContainer > | ) |
◆ operator!()
template<typename ThisItem , typename ThisContainer >
|
virtual |
- Returns
- True if empty.
Implements Om::Source::Source< ThisItem >.
◆ operator*()
template<typename ThisItem , typename ThisContainer >
|
virtual |
Implements Om::Source::Source< ThisItem >.
◆ Equals()
template<typename ThisItem , typename ThisContainer >
| bool Om::Source::ContainerFrontSource< ThisItem, ThisContainer >::Equals | ( | ContainerFrontSource< ThisItem, ThisContainer > const & | ) | const |
◆ Pop()
template<typename ThisItem , typename ThisContainer >
|
virtual |
- Precondition
- Not empty.
Implements Om::Source::Source< ThisItem >.
◆ Swap()
template<typename ThisItem , typename ThisContainer >
| void Om::Source::ContainerFrontSource< ThisItem, ThisContainer >::Swap | ( | ContainerFrontSource< ThisItem, ThisContainer > & | ) |
Member Data Documentation
◆ thisContainer
template<typename ThisItem , typename ThisContainer >
|
private |
Definition at line 75 of file container_front_source.hpp.
The documentation for this class was generated from the following file:
- om/source/container_front_source.hpp
