SpaIot::LedSettings

SPI 2840X Led settings. More...

#include <ledsettings.h>

Public Member Functions
	LedSettings ()
virtual	~LedSettings ()
	Destructor.
	LedSettings (const uint8_t order)
	LedSettings (const LedSettings &other)
	Copy Constructor.
	LedSettings (LedSettings &&other)
	Move Constructor after the move, other is null, other.clear() must be called if it is to be used again.
LedSettings &	operator= (const LedSettings &other)
	Sets the LedSettings object to be equal to other.
LedSettings &	operator= (LedSettings &&other)
	Move assignment after the move, other is null, other.clear() must be called if it is to be used again.
void	clear ()
	Clears the LedSettings object After the call to this function, the LedSettings object is the same as one that has been default constructed.
bool	isNull () const
	Returns true if the object is null (i.e. it has not been initialized, d_ptr is null)
bool	isEmpty () const
	Checks if all attributes are set to their default values (same as the default constructor)
bool	operator== (const LedSettings &other) const
bool	operator!= (const LedSettings &other) const
uint8_t	order () const
uint16_t	frame () const
void	setOrder (const uint8_t order)

Detailed Description

SPI 2840X Led settings.

This class represents the settings of a SPI 2840X Led. It is a concrete class, and can be instantiated. This class is copyable and movable.

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

order

The 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.

operator!=()

bool SpaIot::LedSettings::operator!=

(

const LedSettings &

other

)

const

The function returns true if the two objects are not equal

Parameters

other

the 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

other

the 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

order

The order of the LED.