HEBI C++ API
3.10.0
|
A message field representable by a std::string. More...
#include <command.hpp>
Public Member Functions | |
operator bool () const | |
Allows casting to a bool to check if the field has a value without directly calling has() . More... | |
bool | has () const |
True if (and only if) the field has a value. More... | |
std::string | get () const |
If the field has a value, returns a copy of that value; otherwise, returns a default. More... | |
void | set (const std::string &value) |
Sets the field to a given value. More... | |
void | clear () |
Removes any currently set value for this field. More... | |
A message field representable by a std::string.
|
inlineexplicit |
Allows casting to a bool to check if the field has a value without directly calling has()
.
This can be used as in the following (assuming 'parent' is a parent message, and this field is called 'myField')
bool hebi::Command::StringField::has | ( | ) | const |
True if (and only if) the field has a value.
std::string hebi::Command::StringField::get | ( | ) | const |
If the field has a value, returns a copy of that value; otherwise, returns a default.
void hebi::Command::StringField::set | ( | const std::string & | value | ) |
Sets the field to a given value.
void hebi::Command::StringField::clear | ( | ) |
Removes any currently set value for this field.