BlackLib::errorGPIO Struct Reference

Holds BlackGPIO errors. More...

#include <BlackErr.h>

Public Member Functions

 errorGPIO ()
 errorGPIO struct's constructor. More...
 
 errorGPIO (errorCoreGPIO *base)
 errorGPIO struct's constructor with errorCoreGPIO pointer parameter. More...
 

Public Attributes

errorCoreGPIOgpioCoreErrors
 Pointer of errorCoreGPIO struct, which stores errors of BlackCoreGPIO class. More...
 
bool exportError
 Pin couldn't export error. More...
 
bool directionError
 Pin direction couldn't set error. More...
 
bool readError
 Value file reading error. More...
 
bool writeError
 Value file writing error. More...
 
bool forcingError
 Pin write forcing error. More...
 

Detailed Description

Holds BlackGPIO errors.

This struct holds GPIO errors and includes pointer of errorCoreGPIO struct.

Constructor & Destructor Documentation

BlackLib::errorGPIO::errorGPIO ( )
inline

errorGPIO struct's constructor.

This function clears all flags and initializes errorCoreGPIO struct.

BlackLib::errorGPIO::errorGPIO ( errorCoreGPIO base)
inline

errorGPIO struct's constructor with errorCoreGPIO pointer parameter.

Parameters
[in]*basepointer of errorCoreGPIO struct.

This function clears all flags and assigns input parameter to gpioCoreErrors variable.

Member Data Documentation

bool BlackLib::errorGPIO::directionError

Pin direction couldn't set error.

Its value can change, when checking GPIO pin's direction, at

  • isDirectionSet()
  • isReady()
  • getValue()
  • isHigh()
  • toggleValue()
  • setValue()
  • operator>>()
  • operator<<()

functions in BlackGPIO class, if working mode is secureMode.

See also
BlackGPIO::isDirectionSet()
BlackGPIO::isReady()
BlackGPIO::getValue()
BlackGPIO::isHigh()
BlackGPIO::toggleValue()
BlackGPIO::setValue()
BlackGPIO::operator>>(std::string &)
BlackGPIO::operator>>(int &)
BlackGPIO::operator<<(BlackLib::digitalValue)
bool BlackLib::errorGPIO::exportError

Pin couldn't export error.

Its value can change, when checking GPIO pin's export status, at

  • isExported()
  • isReady()
  • getValue()
  • isHigh()
  • toggleValue()
  • setValue()
  • operator>>()
  • operator<<()

functions in BlackGPIO class, if working mode is secureMode.

See also
BlackGPIO::isExported()
BlackGPIO::isReady()
BlackGPIO::getValue()
BlackGPIO::isHigh()
BlackGPIO::toggleValue()
BlackGPIO::setValue()
BlackGPIO::operator>>(std::string &)
BlackGPIO::operator>>(int &)
BlackGPIO::operator<<(BlackLib::digitalValue)
bool BlackLib::errorGPIO::forcingError

Pin write forcing error.

Its value can change, when trying to write something to input type gpio pin, at

  • setValue()

function in BlackGPIO class.

See also
BlackGPIO::setValue()
BlackGPIO::operator<<(BlackLib::digitalValue)
errorCoreGPIO* BlackLib::errorGPIO::gpioCoreErrors

Pointer of errorCoreGPIO struct, which stores errors of BlackCoreGPIO class.

This struct initializes at constructor in BlackGPIO class.
Its value can set with

  • getErrorsFromCoreGPIO()

function in BlackCoreGPIO class.

See also
BlackGPIO::BlackGPIO()
BlackCoreGPIO::getErrorsFromCoreGPIO()
bool BlackLib::errorGPIO::readError

Value file reading error.

Its value can change, when opening gpio pin's value file, at

  • getValue()
  • getNumericValue()
  • isHigh()
  • toggleValue()
  • operator>>()

functions in BlackGPIO class.

See also
BlackGPIO::getValue()
BlackGPIO::getNumericValue()
BlackGPIO::isHigh()
BlackGPIO::toggleValue()
BlackGPIO::operator>>(std::string &)
BlackGPIO::operator>>(int &)
bool BlackLib::errorGPIO::writeError

Value file writing error.

Its value can change, when opening gpio pin's value file, at

  • setValue()
  • operator<<()

function in BlackGPIO class.

See also
BlackGPIO::setValue()
BlackGPIO::operator<<(BlackLib::digitalValue)

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