hebi::Info::StringField Class Reference

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

#include <info.hpp>

Public Member Functions
std::string	get () const
	If the field has a value, returns a copy of 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...
	StringField (HebiInfoPtr internal, HebiInfoStringField field)

Private Attributes
HebiInfoStringField const	field_
HebiInfoPtr const	internal_

Detailed Description

A message field representable by a std::string.

Definition at line 164 of file info.hpp.

Constructor & Destructor Documentation

hebi::Info::StringField::StringField	(	HebiInfoPtr	internal,
		HebiInfoStringField	field
	)

Definition at line 87 of file info.cpp.

Member Function Documentation

std::string hebi::Info::StringField::get

(

)

const

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

Definition at line 102 of file info.cpp.

bool hebi::Info::StringField::has

(

)

const

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

Definition at line 97 of file info.cpp.

hebi::Info::StringField::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::StringField& 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 92 of file info.cpp.

Member Data Documentation

HebiInfoStringField const hebi::Info::StringField::field_

private

Definition at line 191 of file info.hpp.

HebiInfoPtr const hebi::Info::StringField::internal_

private

Definition at line 190 of file info.hpp.

---

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

• info.hpp
• info.cpp