Class Command::FlagField

Defined in File command.hpp

Nested Relationships

This class is a nested type of Class Command.

Class Documentation

class FlagField

A two-state message field (either set/true or cleared/false).

Public Functions

FlagField(HebiCommandRef &internal, HebiCommandFlagField field)

inline explicit operator bool() const

Allows casting to a bool to check if the flag is set without directly calling has().

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

Command::FlagField& f = parent.myField();
if (f)
  std::cout << "Field has value: " << f.get() << std::endl;
else
  std::cout << "Field has no value!" << std::endl;

bool has() const: Returns true if the flag is set, false if it is cleared.

void set(): Sets this flag.

void clear(): Clears this flag (e.g., sets it to false/off).