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

A message field representable by an unsigned 64 bit integer value. More...

#include <feedback.hpp>

Public Member Functions

uint64_t 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...
 
 UInt64Field (HebiFeedbackPtr internal, HebiFeedbackUInt64Field field)
 

Private Attributes

HebiFeedbackUInt64Field const field_
 
HebiFeedbackPtr const internal_
 

Detailed Description

A message field representable by an unsigned 64 bit integer value.

Definition at line 226 of file feedback.hpp.

Constructor & Destructor Documentation

hebi::Feedback::UInt64Field::UInt64Field ( HebiFeedbackPtr  internal,
HebiFeedbackUInt64Field  field 
)

Definition at line 93 of file feedback.cpp.

Member Function Documentation

uint64_t hebi::Feedback::UInt64Field::get ( ) const

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

Definition at line 108 of file feedback.cpp.

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

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

Definition at line 103 of file feedback.cpp.

hebi::Feedback::UInt64Field::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')

Feedback::UInt64Field& 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 98 of file feedback.cpp.

Member Data Documentation

HebiFeedbackUInt64Field const hebi::Feedback::UInt64Field::field_
private

Definition at line 253 of file feedback.hpp.

HebiFeedbackPtr const hebi::Feedback::UInt64Field::internal_
private

Definition at line 252 of file feedback.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:10:59