collection_iterator Class Reference

Declared in

flip/iterator.h

using collection_iterator = ...;
using const_collection_iterator = ...;

collection_iterator satisfies the BidirectionalIterator C++ concept. It is a generic iterator that can be used to iterate other any specialization of template class Collection.

All specializations of template class Collection inherit from CollectionBase which has the methods gbegin, gcbegin, gend, gcend which return iterators of type collection_iterator or const_collection_iterator.

Member Types

`value_type`	`Object`
`reference`	`Object &`
`pointer`	`Object *`
`iterator_category`	`std::bidirectional_iterator_tag`

Member Functions Synopsys

Miscellaneous

`key`	Returns the key associated to the iterator.
`added`	Returns `true` iff the iterator was added to the container.
`removed`	Returns `true` iff the iterator was removed to the container.
`resident`	Returns `true` iff the iterator was neither added or removed.

Member Functions

`key`

const KeyRandom & key () const;

Returns the key associated to the iterator.

The key is guaranteed unique in the container.

`added`

bool added () const;

Returns true iff the iterator was added to the container.

Note: When an object is moved in the container, then the destination iterator is considered as added while the object is considered as resident. See Collection::iterator for an example of it.

`removed`

bool removed () const;

Returns true iff the iterator was removed to the container.

Note: When an object is moved in the container, then the source iterator is considered as removed while the object is considered as resident. See Collection::iterator for an example of it.

`resident`

bool resident () const;

Returns true iff the iterator was neither added or removed.

previous next