Public Member Functions | Private Attributes | List of all members
hebi::Feedback::Vector3fField Class Referencefinal

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

#include <feedback.hpp>

Public Member Functions

Vector3f get () const
 If the field has a value, returns that value; otherwise, returns a default. More...
 
bool has () const
 True if (and only if) the field has a value. More...
 
 operator bool () const
 Allows casting to a bool to check if the field has a value without directly calling has(). More...
 
 Vector3fField (const HebiFeedbackRef &internal, HebiFeedbackVector3fField field)
 

Private Attributes

HebiFeedbackVector3fField const field_
 
const HebiFeedbackRefinternal_
 

Detailed Description

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

Definition at line 271 of file feedback.hpp.

Constructor & Destructor Documentation

hebi::Feedback::Vector3fField::Vector3fField ( const HebiFeedbackRef internal,
HebiFeedbackVector3fField  field 
)

Definition at line 79 of file feedback.cpp.

Member Function Documentation

Vector3f hebi::Feedback::Vector3fField::get ( ) const

If the field has a value, returns that value; otherwise, returns a default.

Definition at line 86 of file feedback.cpp.

bool hebi::Feedback::Vector3fField::has ( ) const

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

Definition at line 82 of file feedback.cpp.

hebi::Feedback::Vector3fField::operator bool ( ) const
inlineexplicit

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

Feedback::Vector3fField& f = parent.myField();
if (f)
std::cout << "Field has value!" << std::endl;
else
std::cout << "Field has no value!" << std::endl;

Definition at line 288 of file feedback.hpp.

Member Data Documentation

HebiFeedbackVector3fField const hebi::Feedback::Vector3fField::field_
private

Definition at line 298 of file feedback.hpp.

const HebiFeedbackRef& hebi::Feedback::Vector3fField::internal_
private

Definition at line 297 of file feedback.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