Class Command::StringField

Defined in File command.hpp

Nested Relationships

This class is a nested type of Class Command.

Class Documentation

class StringField

A message field representable by a std::string.

Public Functions

StringField(HebiCommandPtr internal, HebiCommandStringField field)

inline explicit operator bool() const

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’)

Command::StringField& 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: True if (and only if) the field has a value.

std::string get() const: If the field has a value, returns a copy of that value; otherwise, returns a default.

void set(const std::string &value): Sets the field to a given value.

void clear(): Removes any currently set value for this field.