hebi::Command::StringField Class Reference

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

#include <command.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...
void	set (const std::string &value)
	Sets the field to a given value. More...
void	clear ()
	Removes any currently set value for this field. More...

Detailed Description

A message field representable by a std::string.

Member Function Documentation

operator bool()

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

Command::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::Command::StringField::has

(

)

const

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

get()

std::string hebi::Command::StringField::get

(

)

const

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

set()

void hebi::Command::StringField::set

(

const std::string &

value

)

Sets the field to a given value.

clear()

void hebi::Command::StringField::clear

(

)

Removes any currently set value for this field.

---

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

• command.hpp
• command.cpp