YAMI4 - core
yami::core::parameter_iterator Class Reference

Iterator to parameter entries. More...

#include <parameter_iterator.h>

List of all members.

Public Member Functions

bool has_next () const
 Checks if there is a subsequent entry.
void move_next ()
 Moves the iterator to the next entry.
parameter_entry current () const
void remove ()
 Removes the current entry.

Detailed Description

The iterator to all parameter entries.

See also:
parameters

Note: The iterator object can be used only as long as it is valid and every modifying operation on the parameters object should be assumed as invalidating all existing iterators.


Member Function Documentation

bool parameter_iterator::has_next ( ) const

Checks if there is a subsequent entry in the associated parameters object.

Returns:
true if there is some further entry, false otherwise.
void parameter_iterator::move_next ( )

Moves the iterator to the next non-empty entry in the associated parameters.
This function can be called only when some next entry exists.

parameter_entry parameter_iterator::current ( ) const

Gets the current entry.

void parameter_iterator::remove ( )

Removes the current entry.

Note: The iterator is not automatically moved to the next entry after the current one is removed. The only operations that are allowed after that are has_next and move_next.