BlackLib::errorI2C Struct Reference

Holds BlackI2C errors. More...

#include <BlackErr.h>

Public Member Functions

 errorI2C ()
 BlackI2C struct's constructor. More...
 
 errorI2C (errorCore *base)
 BlackI2C struct's constructor with errorCore pointer parameter. More...
 

Public Attributes

errorCorecoreErrors
 Pointer of errorCore struct, which stores errors of BlackCore class. More...
 
bool openError
 TTY file opening error. More...
 
bool closeError
 TTY file closing error. More...
 
bool setSlaveError
 Slave setting error. More...
 
bool readError
 I2C reading error. More...
 
bool writeError
 I2C writing error. More...
 

Detailed Description

Holds BlackI2C errors.

This struct holds I2C errors and includes pointer of errorCore struct.

Constructor & Destructor Documentation

BlackLib::errorI2C::errorI2C ( )
inline

BlackI2C struct's constructor.

This function clears all flags and initializes errorCore struct.

BlackLib::errorI2C::errorI2C ( errorCore base)
inline

BlackI2C struct's constructor with errorCore pointer parameter.

Parameters
[in]*basepointer of errorCore struct.

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

Member Data Documentation

bool BlackLib::errorI2C::closeError

TTY file closing error.

Its value can change, when closing i2c's tty file, at

  • close()

function in BlackI2C class.

See also
BlackI2C::close()
errorCore* BlackLib::errorI2C::coreErrors

Pointer of errorCore struct, which stores errors of BlackCore class.

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

  • getErrorsFromCore()

function in BlackI2C class.

See also
BlackI2C::BlackI2C()
BlackCore::getErrorsFromCore()
bool BlackLib::errorI2C::openError

TTY file opening error.

Its value can change, when opening i2c's tty file, at

  • open()

function in BlackI2C class.

See also
BlackI2C::open()
bool BlackLib::errorI2C::readError

I2C reading error.

Its value can change, when reading i2c data, at

  • readByte()
  • readWord()
  • readBlock()
  • readLine()

functions in BlackI2C class.

See also
BlackI2C::readByte()
BlackI2C::readWord()
BlackI2C::readBlock()
BlackI2C::readLine()
bool BlackLib::errorI2C::setSlaveError

Slave setting error.

Its value can change, when opening TTY file, doing i2c write/read operations and assigning new device address value at

  • open()
  • writeByte()
  • writeWord()
  • writeBlock()
  • writeLine()
  • readByte()
  • readWord()
  • readBlock()
  • readLine()
  • setDeviceAddress()

functions in BlackI2C class.

See also
BlackI2C::open()
BlackI2C::writeByte()
BlackI2C::writeWord()
BlackI2C::writeBlock()
BlackI2C::writeLine()
BlackI2C::readByte()
BlackI2C::readWord()
BlackI2C::readBlock()
BlackI2C::readLine()
BlackI2C::setDeviceAddress()
bool BlackLib::errorI2C::writeError

I2C writing error.

Its value can change, when writing i2c data, at

  • writeByte()
  • writeWord()
  • writeBlock()
  • writeLine()

functions in BlackI2C class.

See also
BlackI2C::writeByte()
BlackI2C::writeWord()
BlackI2C::writeBlock()
BlackI2C::writeLine()

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