SpaIot Library
SpaIot::LedSettings

SPI 2840X Led settings. More...

#include <bussettings.h>

Public Member Functions

 LedSettings ()
 
 LedSettings (const uint8_t order)
 
uint8_t order () const
 
uint16_t frame () const
 
void setOrder (const uint8_t order)
 
bool isNull () const
 
bool operator== (const LedSettings &other) const
 
bool operator!= (const LedSettings &other) const
 

Detailed Description

SPI 2840X Led settings.

Constructor & Destructor Documentation

◆ LedSettings() [1/2]

SpaIot::LedSettings::LedSettings ( )

The constructor takes a single parameter, which is the initial value of the LedSettings object

◆ LedSettings() [2/2]

SpaIot::LedSettings::LedSettings ( const uint8_t  order)

The constructor takes an optional parameter, which is the order of the LED. If the order is not specified, it is set to UnsetValue8

Parameters
orderThe order of the LED in the LED frame.

Member Function Documentation

◆ frame()

uint16_t SpaIot::LedSettings::frame ( ) const

The function returns the frame mask of the LED settings

Returns
The frame mask of the LED.

◆ isNull()

bool SpaIot::LedSettings::isNull ( ) const

This function returns true if the value of the member variable m_order is equal to the value UnsetValue8

Returns
The value of the member variable m_order.

◆ operator!=()

bool SpaIot::LedSettings::operator!= ( const LedSettings other) const

The function returns true if the two objects are not equal

Parameters
otherthe other LedSettings object to compare to
Returns
The return value is a boolean value. It is true if the two objects are not equal, and false if they are equal.

◆ operator==()

bool SpaIot::LedSettings::operator== ( const LedSettings other) const

The function returns true if the two objects are equal

Parameters
otherthe other LedSettings object to compare to
Returns
The return value is a boolean value. It is true if the two objects are equal, and false if they are not equal.

◆ order()

uint8_t SpaIot::LedSettings::order ( ) const

This function returns the order of the LED in the frame

Returns
The order of the LED.

◆ setOrder()

void SpaIot::LedSettings::setOrder ( const uint8_t  order)

Set the order of the LEDs.

Parameters
orderThe order of the LED.