dnp3 (C++ API) 1.1.0
dnp3::FrozenCounterIterator Class Referencefinal

Iterator over FrozenCounter instances. More...

#include <dnp3.hpp>

Public Member Functions

 FrozenCounterIterator (FrozenCounterIterator &&)=default
 move constructor for the iterator More...
 
bool next ()
 move the iterator to the next value More...
 
FrozenCounter get ()
 retrieve the current value More...
 

Friends

class CppFrozenCounterIteratorFriend
 

Detailed Description

Iterator over FrozenCounter instances.

Warning

Always use this pattern to extract values from the iterator:

while(iter.next()) { FrozenCounter value = iter.get(); }

Calling get() when no value is available will throw std::logic_error

Constructor & Destructor Documentation

◆ FrozenCounterIterator()

dnp3::FrozenCounterIterator::FrozenCounterIterator ( FrozenCounterIterator &&  )
default

move constructor for the iterator

Member Function Documentation

◆ get()

FrozenCounter dnp3::FrozenCounterIterator::get ( )

retrieve the current value

Returns
current value of the iterator
Exceptions
std::logic_errorif the last call to next() returns false or next() has never been called

◆ next()

bool dnp3::FrozenCounterIterator::next ( )

move the iterator to the next value

Returns
true if another value is available

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