YAMI4 Core Library 2.0.0
Messaging Solution for Distributed Systems
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
yami::core::parameter_iterator Class Reference

Iterator to parameter entries. More...

#include <parameter_iterator.h>

Public Member Functions

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

Friends

class parameters
 

Detailed Description

Iterator to parameter entries.

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

◆ current()

parameter_entry yami::core::parameter_iterator::current ( ) const

Gets the current entry.

Gets the current entry.

◆ has_next()

bool yami::core::parameter_iterator::has_next ( ) const

Checks if there is a subsequent entry.

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

Returns
true if there is some further entry, false otherwise.

◆ move_next()

void yami::core::parameter_iterator::move_next ( )

Moves the iterator to the next entry.

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

◆ remove()

void yami::core::parameter_iterator::remove ( )

Removes the current entry.

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.


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