HEBI C++ API  3.4.0
hebi::Command::BoolField Class Referencefinal

A message field representable by a bool value. More...

#include <command.hpp>

Public Member Functions

bool has () const
 True if (and only if) the field has a value. More...
 
bool get () const
 If the field has a value, returns that value; otherwise, returns false. More...
 
void set (bool value)
 Sets the field to a given value. More...
 
void clear ()
 Removes any currently set value for this field. More...
 

Detailed Description

A message field representable by a bool value.

Member Function Documentation

◆ has()

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

True if (and only if) the field has a value.

◆ get()

bool hebi::Command::BoolField::get ( ) const

If the field has a value, returns that value; otherwise, returns false.

◆ set()

void hebi::Command::BoolField::set ( bool  value)

Sets the field to a given value.

◆ clear()

void hebi::Command::BoolField::clear ( )

Removes any currently set value for this field.


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