BlackLib::errorUART Struct Reference

Holds BlackUART errors. More...

#include <BlackErr.h>

Public Member Functions

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

Public Attributes

errorCorecoreErrors
 Pointer of errorCore struct, which stores errors of BlackCore class. More...
 
bool dtError
 Device tree loading error. More...
 
bool openError
 TTY file opening error. More...
 
bool closeError
 TTY file closing error. More...
 
bool directionError
 Some uart operation's direction error. More...
 
bool flushError
 UART line flushing error. More...
 
bool readError
 TTY file reading error. More...
 
bool writeError
 TTY file writing error. More...
 
bool baudRateError
 UART's baud property setting error. More...
 
bool parityError
 UART's parity property setting error. More...
 
bool stopBitsError
 UART's stop bits property setting error. More...
 
bool charSizeError
 UART's character size property setting error. More...
 

Detailed Description

Holds BlackUART errors.

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

Constructor & Destructor Documentation

BlackLib::errorUART::errorUART ( )
inline

errorUART struct's constructor.

This function clears all flags and initializes errorCore struct.

BlackLib::errorUART::errorUART ( errorCore base)
inline

errorUART 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::errorUART::baudRateError

UART's baud property setting error.

Its value can change, when setting uart's baud property, at

  • getBaudRate()
  • setBaudRate()
  • getProperties()
  • setProperties()

functions in BlackUART class.

See also
BlackUART::getBaudRate()
BlackUART::setBaudRate()
BlackUART::getProperties()
BlackUART::setProperties()
bool BlackLib::errorUART::charSizeError

UART's character size property setting error.

Its value can change, when setting uart's character size property, at

  • getCharacterSize()
  • setCharacterSize()
  • getProperties()
  • setProperties()

functions in BlackUART class.

See also
BlackUART::getCharacterSize()
BlackUART::setCharacterSize()
BlackUART::getProperties()
BlackUART::setProperties()
bool BlackLib::errorUART::closeError

TTY file closing error.

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

  • close()

function in BlackUART class.

See also
BlackUART::close()
errorCore* BlackLib::errorUART::coreErrors

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

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

  • getErrorsFromCore()

function in BlackUART class.

See also
BlackUART::BlackUART()
BlackCore::getErrorsFromCore()
bool BlackLib::errorUART::directionError

Some uart operation's direction error.

Its value can change, when doing some operations to UART, at

  • setBaudRate()
  • flush()

functions in BlackUART class.

See also
BlackUART::setBaudRate()
BlackUART::flush()
bool BlackLib::errorUART::dtError

Device tree loading error.

Its value can change, when loading uart overlay to device tree, at

  • loadDeviceTree()

function in BlackUART class.

See also
BlackUART::loadDeviceTree()
bool BlackLib::errorUART::flushError

UART line flushing error.

Its value can change, when flushing line, at

  • flush()

function in BlackUART class.

See also
BlackUART::flush()
bool BlackLib::errorUART::openError

TTY file opening error.

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

  • open()

function in BlackUART class.

See also
BlackUART::open()
bool BlackLib::errorUART::parityError

UART's parity property setting error.

Its value can change, when setting uart's parity property, at

  • getParity()
  • setParity()
  • getProperties()
  • setProperties()

functions in BlackUART class.

See also
BlackUART::getParity()
BlackUART::setParity()
BlackUART::getProperties()
BlackUART::setProperties()
bool BlackLib::errorUART::readError

TTY file reading error.

Its value can change, when reading uart's tty file, at

  • read()
  • transfer()
  • operator>>()

functions in BlackUART class.

See also
BlackUART::read(char*, size_t)
BlackUART::read()
BlackUART::transfer(char*, char*, size_t, uint32_t)
BlackUART::transfer(std::string, uint32_t)
BlackUART::operator>>(std::string &)
bool BlackLib::errorUART::stopBitsError

UART's stop bits property setting error.

Its value can change, when setting uart's stop bits property, at

  • getStopBits()
  • setParity()
  • getProperties()
  • setProperties()

functions in BlackUART class.

See also
BlackUART::getStopBits()
BlackUART::setStopBits()
BlackUART::getProperties()
BlackUART::setProperties()
bool BlackLib::errorUART::writeError

TTY file writing error.

Its value can change, when writing uart's tty file, at

  • write()
  • transfer()
  • operator<<()

functions in BlackUART class.

See also
BlackUART::write(char*, size_t)
BlackUART::write(std::string)
BlackUART::transfer(char*, char*, size_t, uint32_t)
BlackUART::transfer(std::string, uint32_t)
BlackUART::operator<<(std::string &)

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