LEDController Class Reference

High-level controller interface for controlling LEDs, abstracting real or pseudo backends. More...

#include <LEDController.h>

Public Member Functions
	LEDController ()=default
	Default constructor.
	~LEDController ()=default
	Default destructor.
void	redirectTo (const std::string &ledName)
	Redirects the controller to another LED.
std::string	ledPath () const
	Returns the LED path in use.
void	setMode (const Modes mode)
	Sets the control mode.
Modes	getMode () const
	Gets the current LED control mode.
bool	processByPackage (const LEDParamsPackage *package)
	Processes the LED using a parameter package.

Detailed Description

High-level controller interface for controlling LEDs, abstracting real or pseudo backends.

Member Function Documentation

getMode()

Modes LEDController::getMode ( ) const

inline

Gets the current LED control mode.

Returns

Current mode.

ledPath()

std::string LEDController::ledPath ( ) const

inline

Returns the LED path in use.

Returns

Path as a string.

processByPackage()

bool LEDController::processByPackage ( const LEDParamsPackage *  package )

inline

Processes the LED using a parameter package.

Parameters

package

Parameter package pointer.

Returns

True if operation succeeded.

redirectTo()

void LEDController::redirectTo ( const std::string &  ledName )

inline

Redirects the controller to another LED.

Parameters

ledName

Name of the target LED.

setMode()

void LEDController::setMode ( const Modes  mode )

inline

Sets the control mode.

Parameters

mode	LED control mode.

---

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

• extern_app/professionals/boardlevel_application/LightController/Adapter/LEDController.h