libgpiod  2.1
Public Member Functions
gpiod::line_settings Class Referencefinal

Stores GPIO line settings. More...

#include <line-settings.hpp>

Public Member Functions

 line_settings ()
 Initializes the line_settings object with default values.
 
 line_settings (const line_settings &other)
 Copy constructor. More...
 
 line_settings (line_settings &&other) noexcept
 Move constructor. More...
 
line_settingsoperator= (const line_settings &other)
 Copy assignment operator. More...
 
line_settingsoperator= (line_settings &&other)
 Move assignment operator. More...
 
line_settingsreset () noexcept
 Reset the line settings to default values. More...
 
line_settingsset_direction (line::direction direction)
 Set direction. More...
 
line::direction direction () const
 Get direction. More...
 
line_settingsset_edge_detection (line::edge edge)
 Set edge detection. More...
 
line::edge edge_detection () const
 Get edge detection. More...
 
line_settingsset_bias (line::bias bias)
 Set bias setting. More...
 
line::bias bias () const
 Get bias setting. More...
 
line_settingsset_drive (line::drive drive)
 Set drive setting. More...
 
line::drive drive () const
 Get drive setting. More...
 
line_settingsset_active_low (bool active_low)
 Set the active-low setting. More...
 
bool active_low () const noexcept
 Get the active-low setting. More...
 
line_settingsset_debounce_period (const ::std::chrono::microseconds &period)
 Set debounce period. More...
 
::std::chrono::microseconds debounce_period () const noexcept
 Get debounce period. More...
 
line_settingsset_event_clock (line::clock event_clock)
 Set the event clock to use for edge event timestamps. More...
 
line::clock event_clock () const
 Get the event clock used for edge event timestamps. More...
 
line_settingsset_output_value (line::value value)
 Set the output value. More...
 
line::value output_value () const
 Get the output value. More...
 

Detailed Description

Stores GPIO line settings.

Definition at line 32 of file line-settings.hpp.

Constructor & Destructor Documentation

gpiod::line_settings::line_settings ( const line_settings other)

Copy constructor.

Parameters
otherObject to copy.
gpiod::line_settings::line_settings ( line_settings &&  other)
noexcept

Move constructor.

Parameters
otherObject to move.

Member Function Documentation

bool gpiod::line_settings::active_low ( ) const
noexcept

Get the active-low setting.

Returns
Current active-low setting.
line::bias gpiod::line_settings::bias ( ) const

Get bias setting.

Returns
Current bias.
::std::chrono::microseconds gpiod::line_settings::debounce_period ( ) const
noexcept

Get debounce period.

Returns
Current debounce period.
line::direction gpiod::line_settings::direction ( ) const

Get direction.

Returns
Current direction setting.
line::drive gpiod::line_settings::drive ( ) const

Get drive setting.

Returns
Current drive.
line::edge gpiod::line_settings::edge_detection ( ) const

Get edge detection.

Returns
Current edge detection setting.
line::clock gpiod::line_settings::event_clock ( ) const

Get the event clock used for edge event timestamps.

Returns
Current event clock type.
line_settings& gpiod::line_settings::operator= ( const line_settings other)

Copy assignment operator.

Parameters
otherObject to copy.
Returns
Reference to self.
line_settings& gpiod::line_settings::operator= ( line_settings &&  other)

Move assignment operator.

Parameters
otherObject to move.
Returns
Reference to self.
line::value gpiod::line_settings::output_value ( ) const

Get the output value.

Returns
Current output value.
line_settings& gpiod::line_settings::reset ( )
noexcept

Reset the line settings to default values.

Returns
Reference to self.
line_settings& gpiod::line_settings::set_active_low ( bool  active_low)

Set the active-low setting.

Parameters
active_lowNew active-low setting.
Returns
Reference to self.
line_settings& gpiod::line_settings::set_bias ( line::bias  bias)

Set bias setting.

Parameters
biasNew bias.
Returns
Reference to self.
line_settings& gpiod::line_settings::set_debounce_period ( const ::std::chrono::microseconds &  period)

Set debounce period.

Parameters
periodNew debounce period in microseconds.
Returns
Reference to self.
line_settings& gpiod::line_settings::set_direction ( line::direction  direction)

Set direction.

Parameters
directionNew direction.
Returns
Reference to self.
line_settings& gpiod::line_settings::set_drive ( line::drive  drive)

Set drive setting.

Parameters
driveNew drive.
Returns
Reference to self.
line_settings& gpiod::line_settings::set_edge_detection ( line::edge  edge)

Set edge detection.

Parameters
edgeNew edge detection setting.
Returns
Reference to self.
line_settings& gpiod::line_settings::set_event_clock ( line::clock  event_clock)

Set the event clock to use for edge event timestamps.

Parameters
event_clockClock to use.
Returns
Reference to self.
line_settings& gpiod::line_settings::set_output_value ( line::value  value)

Set the output value.

Parameters
valueNew output value.
Returns
Reference to self.

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