Public Member Functions | Private Attributes | List of all members
hebi::FunctionCallResult Class Reference

Used as a return. More...

#include <util.hpp>

Public Member Functions

const std::string & failureMessage () const
 
 FunctionCallResult (bool success)
 
 FunctionCallResult (bool success, const std::string &failure)
 
 FunctionCallResult (FunctionCallResult &&)=default
 
 operator bool () const
 
FunctionCallResultoperator= (FunctionCallResult &&)=default
 
bool success () const
 

Private Attributes

std::string failure_message_
 
bool ok_
 

Detailed Description

Used as a return.

Definition at line 28 of file util.hpp.

Constructor & Destructor Documentation

hebi::FunctionCallResult::FunctionCallResult ( bool  success)
inlineexplicit

Definition at line 30 of file util.hpp.

hebi::FunctionCallResult::FunctionCallResult ( bool  success,
const std::string &  failure 
)
inline

Definition at line 31 of file util.hpp.

hebi::FunctionCallResult::FunctionCallResult ( FunctionCallResult &&  )
default

Member Function Documentation

const std::string& hebi::FunctionCallResult::failureMessage ( ) const
inline

The failure message, if the call this represents failed.

On success, this will always be a valid empty string (i.e., result.failureMessage().empty() is always true).

Definition at line 43 of file util.hpp.

hebi::FunctionCallResult::operator bool ( ) const
inline

Definition at line 35 of file util.hpp.

FunctionCallResult& hebi::FunctionCallResult::operator= ( FunctionCallResult &&  )
default
bool hebi::FunctionCallResult::success ( ) const
inline

Definition at line 36 of file util.hpp.

Member Data Documentation

std::string hebi::FunctionCallResult::failure_message_
private

Definition at line 46 of file util.hpp.

bool hebi::FunctionCallResult::ok_
private

Definition at line 45 of file util.hpp.


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


hebi_cpp_api_ros
Author(s): Chris Bollinger , Matthew Tesch
autogenerated on Thu May 28 2020 03:14:45