HEBI C++ API  3.7.0
hebi::Command::NumberedFloatField Class Referencefinal

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

#include <command.hpp>

Public Member Functions

bool has (size_t fieldNumber) const
 True if (and only if) the particular numbered subvalue of this field has a value. More...
 
float get (size_t fieldNumber) const
 If the particular numbered subvalue of this field has a value, returns that value; otherwise returns a default. More...
 
void set (size_t fieldNumber, float value)
 Sets the particular numbered subvalue of this field to a given value. More...
 
void clear (size_t fieldNumber)
 Removes any currently set value for the numbered subvalue of this field. More...
 

Detailed Description

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

Member Function Documentation

◆ has()

bool hebi::Command::NumberedFloatField::has ( size_t  fieldNumber) const

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

Parameters
fieldNumberWhich subvalue to check; valid values for fieldNumber depend on the field type.

◆ get()

float hebi::Command::NumberedFloatField::get ( size_t  fieldNumber) const

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

Parameters
fieldNumberWhich subvalue to get; valid values for fieldNumber depend on the field type.

◆ set()

void hebi::Command::NumberedFloatField::set ( size_t  fieldNumber,
float  value 
)

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

Parameters
fieldNumberWhich subvalue to set; valid values for fieldNumber depend on the field type.

◆ clear()

void hebi::Command::NumberedFloatField::clear ( size_t  fieldNumber)

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

Parameters
fieldNumberWhich subvalue to clear; valid values for fieldNumber depend on the field type.

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