Class Command::Vector3fField

Defined in File command.hpp

Nested Relationships

This class is a nested type of Class Command.

Class Documentation

class Vector3fField

A message field representable by a 3-D vector of single-precision floating point values.

Public Functions

Vector3fField(HebiCommandRef &internal, HebiCommandVector3fField 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::Vector3fField& f = parent.myField();
if (f)
  std::cout << "Field has value!" << std::endl;
else
  std::cout << "Field has no value!" << std::endl;

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

Vector3f get() const: If the field has a value, returns that value; otherwise, returns a default.

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

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