Public Member Functions | Private Attributes | List of all members
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

void clear (size_t fieldNumber)
 Removes any currently set value for the numbered subvalue of this field. 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...
 
bool has (size_t fieldNumber) const
 True if (and only if) the particular numbered subvalue of this field has a value. More...
 
 NumberedFloatField (HebiCommandRef &internal, HebiCommandNumberedFloatField field)
 
void set (size_t fieldNumber, float value)
 Sets the particular numbered subvalue of this field to a given value. More...
 

Private Attributes

HebiCommandNumberedFloatField const field_
 
HebiCommandRefinternal_
 

Detailed Description

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

Definition at line 173 of file command.hpp.

Constructor & Destructor Documentation

hebi::Command::NumberedFloatField::NumberedFloatField ( HebiCommandRef internal,
HebiCommandNumberedFloatField  field 
)

Definition at line 69 of file command.cpp.

Member Function Documentation

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.

Definition at line 88 of file command.cpp.

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.

Definition at line 76 of file command.cpp.

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.

Definition at line 72 of file command.cpp.

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.

Definition at line 84 of file command.cpp.

Member Data Documentation

HebiCommandNumberedFloatField const hebi::Command::NumberedFloatField::field_
private

Definition at line 206 of file command.hpp.

HebiCommandRef& hebi::Command::NumberedFloatField::internal_
private

Definition at line 205 of file command.hpp.


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


hebi_cpp_api_ros
Author(s): Chris Bollinger , Matthew Tesch
autogenerated on Thu May 28 2020 03:14:45