Public Member Functions | Private Attributes | List of all members
hebi::Info::FloatField Class Referencefinal

A message field representable by a single-precision floating point value. More...

#include <info.hpp>

Public Member Functions

 FloatField (HebiInfoPtr internal, HebiInfoFloatField field)
 
float 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...
 

Private Attributes

HebiInfoFloatField const field_
 
HebiInfoPtr const internal_
 

Detailed Description

A message field representable by a single-precision floating point value.

Definition at line 60 of file info.hpp.

Constructor & Destructor Documentation

hebi::Info::FloatField::FloatField ( HebiInfoPtr  internal,
HebiInfoFloatField  field 
)

Definition at line 6 of file info.cpp.

Member Function Documentation

float hebi::Info::FloatField::get ( ) const

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

Definition at line 21 of file info.cpp.

bool hebi::Info::FloatField::has ( ) const

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

Definition at line 16 of file info.cpp.

hebi::Info::FloatField::operator bool ( ) const
explicit

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

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

Definition at line 11 of file info.cpp.

Member Data Documentation

HebiInfoFloatField const hebi::Info::FloatField::field_
private

Definition at line 87 of file info.hpp.

HebiInfoPtr const hebi::Info::FloatField::internal_
private

Definition at line 86 of file info.hpp.


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


hebiros
Author(s): Xavier Artache , Matthew Tesch
autogenerated on Thu Sep 3 2020 04:11:00