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

#include <command.hpp>

Public Member Functions
	operator bool () const
	Allows casting to a bool to check if the flag is set without directly calling `has()`. More...

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

void	set ()
	Sets this flag. More...

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

Detailed Description

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

Member Function Documentation

◆ operator bool()

hebi::Command::FlagField::operator bool ( ) const

inlineexplicit

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;

◆ has()

bool hebi::Command::FlagField::has ( ) const

Returns true if the flag is set, false if it is cleared.

◆ set()

void hebi::Command::FlagField::set ( )

Sets this flag.

◆ clear()

void hebi::Command::FlagField::clear ( )

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