sol3::gpio::GpioInputPin Class Reference

RAII wrapper for GPIO input pins. More...

#include <sol3/gpio/gpio.h>

Inheritance diagram for sol3::gpio::GpioInputPin:

Public Member Functions
	~GpioInputPin ()=default
GpioPinValue	read () const
	Read current pin value. More...
GpioEdgeEventResult	waitForEdgeEvent (std::chrono::milliseconds timeout) const
	Wait for an edge event on the input pin with the specified timeout. More...
GpioInputPinOptions const &	getOptions () const
	Get the configured options for this input pin. More...
	GpioInputPin (GpioInputPin &&other) noexcept=default
GpioInputPin &	operator= (GpioInputPin &&other) noexcept=default
	GpioInputPin (GpioInputPin const &other) noexcept=delete
GpioInputPin &	operator= (GpioInputPin &other) noexcept=delete
Public Member Functions inherited from sol3::gpio::impl::GpioPinBase
	GpioPinBase (GpioPinBase &&other) noexcept
GpioPinBase &	operator= (GpioPinBase &&other) noexcept
	GpioPinBase (GpioPinBase const &)=delete
GpioPinBase &	operator= (GpioPinBase const &)=delete

Friends
class	GpioPinManager

Additional Inherited Members
Protected Member Functions inherited from sol3::gpio::impl::GpioPinBase
	~GpioPinBase ()
	GpioPinBase (GpioPinId pin, GpioPinManager *manager, int value_fd)
	Protected constructor - only derived classes can create. More...
Protected Attributes inherited from sol3::gpio::impl::GpioPinBase
GpioPinId	pin_
GpioPinManager *	manager_
int	value_fd_

Detailed Description

RAII wrapper for GPIO input pins.

Constructor & Destructor Documentation

~GpioInputPin()

sol3::gpio::GpioInputPin::~GpioInputPin ( )

default

GpioInputPin() [1/2]

sol3::gpio::GpioInputPin::GpioInputPin ( GpioInputPin &&  other )

defaultnoexcept

GpioInputPin() [2/2]

sol3::gpio::GpioInputPin::GpioInputPin ( GpioInputPin const &  other )

deletenoexcept

Member Function Documentation

getOptions()

GpioInputPinOptions const& sol3::gpio::GpioInputPin::getOptions ( ) const

inline

Get the configured options for this input pin.

operator=() [1/2]

GpioInputPin& sol3::gpio::GpioInputPin::operator= ( GpioInputPin &&  other )

defaultnoexcept

operator=() [2/2]

GpioInputPin& sol3::gpio::GpioInputPin::operator= ( GpioInputPin &  other )

deletenoexcept

read()

GpioPinValue sol3::gpio::GpioInputPin::read

(

)

const

Read current pin value.

waitForEdgeEvent()

GpioEdgeEventResult sol3::gpio::GpioInputPin::waitForEdgeEvent

(

std::chrono::milliseconds

timeout

)

const

Wait for an edge event on the input pin with the specified timeout.

Friends And Related Function Documentation

GpioPinManager

friend class GpioPinManager

friend

---

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

• /workspaces/astro/sol3-sdk/cpp/sol3/gpio/gpio.h