Class Command::NumberedFloatField

• Defined in File command.hpp

Nested Relationships

This class is a nested type of Class Command.

Class Documentation

class NumberedFloatField

A message field containing a numbered set of single-precision floating point values.

Public Functions

NumberedFloatField(HebiCommandRef &internal, HebiCommandNumberedFloatField field)

bool has(size_t fieldNumber) const

True if (and only if) the particular numbered subvalue of this field has a value.

Parameters:

fieldNumber – Which subvalue to check; valid values for fieldNumber depend on the field type.

float get(size_t fieldNumber) const

If the particular numbered subvalue of this field has a value, returns that value; otherwise returns a default.

Parameters:

fieldNumber – Which subvalue to get; valid values for fieldNumber depend on the field type.

void set(size_t fieldNumber, float value)

Sets the particular numbered subvalue of this field to a given value.

Parameters:

fieldNumber – Which subvalue to set; valid values for fieldNumber depend on the field type.

void clear(size_t fieldNumber)

Removes any currently set value for the numbered subvalue of this field.

Parameters:

fieldNumber – Which subvalue to clear; valid values for fieldNumber depend on the field type.