gpiod::line_iter Class Reference

Allows to iterate over all lines owned by a GPIO chip. More...

#include <gpiod.hpp>

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

Detailed Description

Allows to iterate over all lines owned by a GPIO chip.

Definition at line 974 of file gpiod.hpp.

Constructor & Destructor Documentation

line_iter() [1/4]

GPIOD_API gpiod::line_iter::line_iter ( void  )

default

Default constructor.

Creates the end iterator.

line_iter() [2/4]

GPIOD_API gpiod::line_iter::line_iter

(

const chip &

owner

)

Constructor.

Creates the begin iterator.

Parameters

owner

Chip owning the GPIO lines over which we want to iterate.

line_iter() [3/4]

GPIOD_API gpiod::line_iter::line_iter ( const line_iter &  other )

default

Copy constructor.

Parameters

other

Other line iterator.

line_iter() [4/4]

GPIOD_API gpiod::line_iter::line_iter ( line_iter &&  other )

default

Move constructor.

Parameters

other

Other line iterator.

Member Function Documentation

operator!=()

GPIOD_API bool gpiod::line_iter::operator!= ( const line_iter &  rhs ) const

noexcept

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

Parameters

rhs	Right-hand side of the equation.

Returns

True if this iterator doesn't point to the same line_iter, false otherwise.

operator*()

GPIOD_API const line& gpiod::line_iter::operator*

(

void

)

const

Dereference current element.

Returns

Current GPIO line by reference.

operator++()

GPIOD_API line_iter& gpiod::line_iter::operator++

(

void

)

Advance the iterator by one element.

Returns

Reference to this iterator.

operator->()

GPIOD_API const line* gpiod::line_iter::operator->

(

void

)

const

Member access operator.

Returns

Current GPIO line by pointer.

operator=() [1/2]

GPIOD_API line_iter& gpiod::line_iter::operator= ( const line_iter &  other )

default

Assignment operator.

Parameters

other

Other line iterator.

Returns

Reference to this line_iter.

operator=() [2/2]

GPIOD_API line_iter& gpiod::line_iter::operator= ( line_iter &&  other )

default

Move assignment operator.

Parameters

other

Other line iterator.

Returns

Reference to this line_iter.

operator==()

GPIOD_API bool gpiod::line_iter::operator== ( const line_iter &  rhs ) const

noexcept

Check if this operator points to the same element.

Parameters

rhs	Right-hand side of the equation.

Returns

True if this iterator points to the same line_iter, false otherwise.

---

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

• gpiod.hpp