BlackLib::BlackSpiProperties Struct Reference

Holds properties of SPI. More...

#include <BlackSPI.h>

Public Member Functions

 BlackSpiProperties ()
 Default constructor of BlackSpiProperties struct. More...
 
 BlackSpiProperties (uint8_t bits, uint8_t mode, uint32_t speed)
 Overloaded constructor of BlackSpiProperties struct. More...
 
 BlackSpiProperties (BlackSpiProperties *self)
 Overloaded constructor of BlackSpiProperties struct. More...
 
BlackSpiPropertiesoperator= (BlackSpiProperties equal)
 Overloaded assign operator of BlackSpiProperties struct. More...
 

Public Attributes

uint8_t spiBitsPerWord
 is used to hold the bits per word size of SPI More...
 
uint8_t spiMode
 is used to hold the mode of SPI More...
 
uint32_t spiSpeed
 is used to hold the speed of SPI More...
 

Detailed Description

Holds properties of SPI.

This struct holds bits per word, mode and speed properties of SPI. Also it has overloaded constructors and overloaded assign operator.

Constructor & Destructor Documentation

BlackLib::BlackSpiProperties::BlackSpiProperties ( )
inline

Default constructor of BlackSpiProperties struct.

This function sets default value to variables.

BlackLib::BlackSpiProperties::BlackSpiProperties ( uint8_t  bits,
uint8_t  mode,
uint32_t  speed 
)
inline

Overloaded constructor of BlackSpiProperties struct.

This function sets entered parameters to variables.

BlackLib::BlackSpiProperties::BlackSpiProperties ( BlackSpiProperties self)
inline

Overloaded constructor of BlackSpiProperties struct.

This function gets pointer of BlackSpiProperties struct and sets this pointed struct's variables to own variables.

Member Function Documentation

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

Overloaded assign operator of BlackSpiProperties struct.

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

Member Data Documentation

uint8_t BlackLib::BlackSpiProperties::spiBitsPerWord

is used to hold the bits per word size of SPI

uint8_t BlackLib::BlackSpiProperties::spiMode

is used to hold the mode of SPI

uint32_t BlackLib::BlackSpiProperties::spiSpeed

is used to hold the speed of SPI


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