hebi::Info::LedField Class Reference

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

#include <info.hpp>

Public Member Functions
	operator bool () const
	Allows casting to a bool to check if the LED color is set without directly calling hasColor(). More...
bool	hasColor () const
	Returns true if the LED color is set, and false otherwise. More...
Color	getColor () const
	Returns the led color. More...

Detailed Description

A message field for interfacing with an LED.

Member Function Documentation

operator bool()

hebi::Info::LedField::operator bool ( ) const

inlineexplicit

Allows casting to a bool to check if the LED color is set without directly calling hasColor().

This can be used as in the following (assuming 'parent' is a parent message, and this field is called 'myField')

Info::LedField& f = parent.myField();
if (f)
  std::cout << "Field has color!" << std::endl;
else
  std::cout << "Field has no value!" << std::endl;

hasColor()

bool hebi::Info::LedField::hasColor

(

)

const

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

getColor()

Color hebi::Info::LedField::getColor

(

)

const

Returns the led color.

---

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

• info.hpp
• info.cpp