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

Iterator over uint8_t instances. More...

#include <dnp3.hpp>

Public Member Functions

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

Friends

class CppByteIteratorFriend
 

Detailed Description

Iterator over uint8_t instances.

Warning

Always use this pattern to extract values from the iterator:

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

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

Constructor & Destructor Documentation

◆ ByteIterator()

dnp3::ByteIterator::ByteIterator ( ByteIterator &&  )
default

move constructor for the iterator

Member Function Documentation

◆ get()

uint8_t dnp3::ByteIterator::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::ByteIterator::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: