BlackLib::BlackUartProperties Struct Reference

Holds properties of UART. More...

#include <BlackUART.h>

Public Member Functions

 BlackUartProperties ()
 Default constructor of BlackUartProperties struct. More...
 
 BlackUartProperties (baudRate S_baudIn, baudRate S_baudOut, parity S_parity, stopBits S_stopBits, characterSize S_charSize)
 Overloaded constructor of BlackUartProperties struct. More...
 
 BlackUartProperties (BlackUartProperties *S_properties)
 Overloaded constructor of BlackUartProperties struct. More...
 
BlackUartPropertiesoperator= (BlackUartProperties equal)
 Overloaded assign operator of BlackUartProperties struct. More...
 

Public Attributes

baudRate uartBaudIn
 is used to hold the baud rate of UART RX More...
 
baudRate uartBaudOut
 is used to hold the baud rate of UART TX More...
 
parity uartParity
 is used to hold the parity type of UART More...
 
stopBits uartStopBits
 is used to hold the stop bits size of UART More...
 
characterSize uartCharSize
 is used to hold the character size of UART More...
 

Detailed Description

Holds properties of UART.

This struct holds input and output baud rate, parity, stop bits size and character size properties of UART. Also it has overloaded constructors and overloaded assign operator.

See also
BlackLib::baudRate
BlackLib::parity
BlackLib::stopBits
BlackLib::characterSize

Constructor & Destructor Documentation

BlackLib::BlackUartProperties::BlackUartProperties ( )
inline

Default constructor of BlackUartProperties struct.

This function sets default value to variables.

BlackLib::BlackUartProperties::BlackUartProperties ( baudRate  S_baudIn,
baudRate  S_baudOut,
parity  S_parity,
stopBits  S_stopBits,
characterSize  S_charSize 
)
inline

Overloaded constructor of BlackUartProperties struct.

This function sets input arguments to variables.

See also
BlackLib::baudRate
BlackLib::parity
BlackLib::stopBits
BlackLib::characterSize
BlackLib::BlackUartProperties::BlackUartProperties ( BlackUartProperties S_properties)
inline

Overloaded constructor of BlackUartProperties struct.

This function gets pointer of BlackUartProperties struct and sets input struct's variables to own variables.

Member Function Documentation

BlackUartProperties& BlackLib::BlackUartProperties::operator= ( BlackUartProperties  equal)
inline

Overloaded assign operator of BlackUartProperties struct.

This function assigns input struct's variables to own variables.

Member Data Documentation

baudRate BlackLib::BlackUartProperties::uartBaudIn

is used to hold the baud rate of UART RX

baudRate BlackLib::BlackUartProperties::uartBaudOut

is used to hold the baud rate of UART TX

characterSize BlackLib::BlackUartProperties::uartCharSize

is used to hold the character size of UART

parity BlackLib::BlackUartProperties::uartParity

is used to hold the parity type of UART

stopBits BlackLib::BlackUartProperties::uartStopBits

is used to hold the stop bits size of UART


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