hebi::Command::LedField Class Reference

A message field for interfacing with an LED. More...

#include <command.hpp>

Public Member Functions
bool	hasColor () const
	Returns true if the LED color is set, and false otherwise. More...
bool	hasModuleControl () const
	Returns true if the message indicates that the module should resume control of the LED. More...
Color	getColor () const
	Returns the led color. More...
void	setOverrideColor (const Color &new_color)
	Commands a color that overrides the module's control of the LED. More...
void	setModuleControl ()
	Sets the module to regain control of the LED. More...
void	clear ()
	Removes any currently set value for this field, so that the module maintains its previous state of LED control/color (i.e., does not have an override color command or an explicit 'module control' command). More...

Detailed Description

A message field for interfacing with an LED.

Member Function Documentation

bool hebi::Command::LedField::hasColor

(

)

const

Returns true if the LED color is set, and false otherwise.

bool hebi::Command::LedField::hasModuleControl

(

)

const

Returns true if the message indicates that the module should resume control of the LED.

Note: a return value of false can indicate either an override command (if and only if hasColor() returns true), or no information about the LED (i.e., the module should maintain it's current state regarding the LED).

Color hebi::Command::LedField::getColor

(

)

const

Returns the led color.

void hebi::Command::LedField::setOverrideColor

(

const Color &

new_color

)

Commands a color that overrides the module's control of the LED.

void hebi::Command::LedField::setModuleControl

(

)

Sets the module to regain control of the LED.

void hebi::Command::LedField::clear

(

)

Removes any currently set value for this field, so that the module maintains its previous state of LED control/color (i.e., does not have an override color command or an explicit 'module control' command).

---

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

• src/command.hpp
• src/command.cpp