libgpiod  1.6.2
Public Member Functions
gpiod::line_bulk::iterator Class Reference

Iterator for iterating over lines held by line_bulk. More...

#include <gpiod.hpp>

Public Member Functions

GPIOD_API iterator (void)=default
 Default constructor. More...
 
GPIOD_API iterator (const iterator &other)=default
 Copy constructor. More...
 
GPIOD_API iterator (iterator &&other)=default
 Move constructor. More...
 
GPIOD_API iteratoroperator= (const iterator &other)=default
 Assignment operator. More...
 
GPIOD_API iteratoroperator= (iterator &&other)=default
 Move assignment operator. More...
 
GPIOD_API ~iterator (void)=default
 Destructor.
 
GPIOD_API iteratoroperator++ (void)
 Advance the iterator by one element. More...
 
GPIOD_API const lineoperator* (void) const
 Dereference current element. More...
 
GPIOD_API const lineoperator-> (void) const
 Member access operator. More...
 
GPIOD_API bool operator== (const iterator &rhs) const noexcept
 Check if this operator points to the same element. More...
 
GPIOD_API bool operator!= (const iterator &rhs) const noexcept
 Check if this operator doesn't point to the same element. More...
 

Detailed Description

Iterator for iterating over lines held by line_bulk.

Definition at line 745 of file gpiod.hpp.

Constructor & Destructor Documentation

◆ iterator() [1/3]

GPIOD_API gpiod::line_bulk::iterator::iterator ( void  )
default

Default constructor.

Builds an empty iterator object.

◆ iterator() [2/3]

GPIOD_API gpiod::line_bulk::iterator::iterator ( const iterator other)
default

Copy constructor.

Parameters
otherOther line_bulk iterator.

◆ iterator() [3/3]

GPIOD_API gpiod::line_bulk::iterator::iterator ( iterator &&  other)
default

Move constructor.

Parameters
otherOther line_bulk iterator.

Member Function Documentation

◆ operator!=()

GPIOD_API bool gpiod::line_bulk::iterator::operator!= ( const iterator rhs) const
noexcept

Check if this operator doesn't point to the same element.

Parameters
rhsRight-hand side of the equation.
Returns
True if this iterator doesn't point to the same GPIO line, false otherwise.

◆ operator*()

GPIOD_API const line& gpiod::line_bulk::iterator::operator* ( void  ) const

Dereference current element.

Returns
Current GPIO line by reference.

◆ operator++()

GPIOD_API iterator& gpiod::line_bulk::iterator::operator++ ( void  )

Advance the iterator by one element.

Returns
Reference to this iterator.

◆ operator->()

GPIOD_API const line* gpiod::line_bulk::iterator::operator-> ( void  ) const

Member access operator.

Returns
Current GPIO line by pointer.

◆ operator=() [1/2]

GPIOD_API iterator& gpiod::line_bulk::iterator::operator= ( const iterator other)
default

Assignment operator.

Parameters
otherOther line_bulk iterator.
Returns
Reference to this iterator.

◆ operator=() [2/2]

GPIOD_API iterator& gpiod::line_bulk::iterator::operator= ( iterator &&  other)
default

Move assignment operator.

Parameters
otherOther line_bulk iterator.
Returns
Reference to this iterator.

◆ operator==()

GPIOD_API bool gpiod::line_bulk::iterator::operator== ( const iterator rhs) const
noexcept

Check if this operator points to the same element.

Parameters
rhsRight-hand side of the equation.
Returns
True if this iterator points to the same GPIO line, false otherwise.

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