Skip to content

Class hal::soft::inert_input_pin

ClassList > hal > soft > inert_input_pin

Inert implementation of digital input pin hardware.

  • #include <inert_input_pin.hpp>

Inherits the following classes: hal::input_pin

Public Functions inherited from hal::input_pin

See hal::input_pin

Type Name
status configure (const settings & p_settings)
Configure the input pin to match the settings supplied.
result< level_t > level ()
Read the state of the input pin.
virtual ~input_pin () = default

Public Static Functions

Type Name
result< inert_input_pin > create (level_t p_level)
Factory function to create inert_input_pin object.

Public Static Functions Documentation

function create

Factory function to create inert_input_pin object.

static inline result< inert_input_pin > hal::soft::inert_input_pin::create (
    level_t p_level
) 

Parameters:

  • p_level - level_t object to retrun when level() is called

Returns:

result<inert_input_pin> - Constructed inert_input_pin object


The documentation for this class was generated from the following file libraries/include/libhal-soft/inert_drivers/inert_input_pin.hpp