duds::hardware::interface::DigitalPort::PinEntry Struct Reference

Data stored for each pin controlled by the port. More...

#include <DigitalPort.hpp>

Collaboration diagram for duds::hardware::interface::DigitalPort::PinEntry:

Public Member Functions
	PinEntry ()
	Initializes access to nullptr; other fields are left uninitialized. More...
	PinEntry (const DigitalPinCap::Flags capf, std::uint16_t cur)
	Initializes access to nullptr and cap using the values specified. More...
void	markNonexistent ()
	Modify the pin to be non-existent. More...
	operator bool () const
	The object evaluates to false if the pin does not exist for use by this process. More...

Public Attributes
DigitalPinAccessBase *	access
	A pointer to an access object, or nullptr if no access object for the pin exists. More...
DigitalPinCap	cap
	The capabilities of the pin. More...
DigitalPinConfig	conf
	The configuration for the pin. More...

Detailed Description

Data stored for each pin controlled by the port.

Definition at line 66 of file DigitalPort.hpp.

Constructor & Destructor Documentation

PinEntry() [1/2]

duds::hardware::interface::DigitalPort::PinEntry::PinEntry ( )

inline

Initializes access to nullptr; other fields are left uninitialized.

Definition at line 87 of file DigitalPort.hpp.

PinEntry() [2/2]

duds::hardware::interface::DigitalPort::PinEntry::PinEntry ( const DigitalPinCap::Flags  capf, std::uint16_t  cur  )

inline

Initializes access to nullptr and cap using the values specified.

conf is left uninitialized.

Definition at line 92 of file DigitalPort.hpp.

Member Function Documentation

markNonexistent()

void duds::hardware::interface::DigitalPort::PinEntry::markNonexistent ( )

inline

Modify the pin to be non-existent.

Definition at line 104 of file DigitalPort.hpp.

operator bool()

duds::hardware::interface::DigitalPort::PinEntry::operator bool ( ) const

inline

The object evaluates to false if the pin does not exist for use by this process.

Definition at line 98 of file DigitalPort.hpp.

Member Data Documentation

access

DigitalPinAccessBase* duds::hardware::interface::DigitalPort::PinEntry::access

A pointer to an access object, or nullptr if no access object for the pin exists.

The object may be either a DigitalPinAccess or a DigitalPinSetAccess object.

Definition at line 73 of file DigitalPort.hpp.

Referenced by duds::hardware::interface::DigitalPort::access(), and duds::hardware::interface::DigitalPort::size().

cap

DigitalPinCap duds::hardware::interface::DigitalPort::PinEntry::cap

The capabilities of the pin.

Derived classes are responsible for initializing this value.

Definition at line 83 of file DigitalPort.hpp.

Referenced by duds::hardware::interface::DigitalPortDependentPins::proposeConfigImpl().

conf

DigitalPinConfig duds::hardware::interface::DigitalPort::PinEntry::conf

The configuration for the pin.

Derived classes are responsible for initializing this value.

Definition at line 78 of file DigitalPort.hpp.

Referenced by duds::hardware::interface::linux::GpioDevPort::madeAccess().

---

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

• DigitalPort.hpp