HEBI C++ API  3.9.0
hebi::Info::StringField Class Referencefinal

A message field representable by a std::string. More...

#include <info.hpp>

Public Member Functions

 operator bool () const
 Allows casting to a bool to check if the field has a value without directly calling has(). More...
 
bool has () const
 True if (and only if) the field has a value. More...
 
std::string get () const
 If the field has a value, returns a copy of that value; otherwise, returns a default. More...
 

Detailed Description

A message field representable by a std::string.

Member Function Documentation

◆ operator bool()

hebi::Info::StringField::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')

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

◆ has()

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

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

◆ get()

std::string hebi::Info::StringField::get ( ) const

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


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