YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
ReturnValue.h File Reference
#include <yarp/dev/api.h>
#include <yarp/os/Log.h>
#include <yarp/os/LogComponent.h>
#include <yarp/os/Portable.h>
#include <yarp/os/Vocab.h>
#include <string>
+ Include dependency graph for ReturnValue.h:

Go to the source code of this file.

Classes

class  yarp::dev::ReturnValue
 

Namespaces

namespace  yarp
 The main, catch-all namespace for YARP.
 
namespace  yarp::dev
 For streams capable of holding different kinds of content, check what they actually have.
 

Macros

#define YARP_RETURNVALUE_DISABLE_BOOL_INPUT   1
 
#define YARP_RETURNVALUE_DISABLE_BOOL_OUTPUT   0
 
#define ReturnValue_ok   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_ok)
 
#define ReturnValue_error_generic   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_generic)
 
#define ReturnValue_error_not_implemented_by_device   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_not_implemented_by_device)
 
#define ReturnValue_error_nws_nwc_communication_error   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_nws_nwc_communication_error)
 
#define ReturnValue_error_deprecated   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_deprecated)
 
#define ReturnValue_error_method_failed   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_method_failed)
 
#define ReturnValue_error_not_ready   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_not_ready)
 
#define ReturnValue_error_input_out_of_bounds   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_input_out_of_bounds)
 
#define ReturnValue_uninitialized   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_uninitialized)
 
#define YARP_METHOD_NOT_YET_IMPLEMENTED()   yarp_method_not_implemented(__func__)
 
#define YARP_METHOD_DEPRECATED()   yarp_method_deprecated(__func__)
 

Functions

ReturnValue yarp::dev::yarp_method_not_implemented (std::string location, std::string custom_string="")
 
ReturnValue yarp::dev::yarp_method_deprecated (std::string location, std::string custom_string="")
 

Macro Definition Documentation

◆ ReturnValue_error_deprecated

#define ReturnValue_error_deprecated   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_deprecated)

Definition at line 86 of file ReturnValue.h.

◆ ReturnValue_error_generic

#define ReturnValue_error_generic   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_generic)

Definition at line 83 of file ReturnValue.h.

◆ ReturnValue_error_input_out_of_bounds

#define ReturnValue_error_input_out_of_bounds   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_input_out_of_bounds)

Definition at line 89 of file ReturnValue.h.

◆ ReturnValue_error_method_failed

#define ReturnValue_error_method_failed   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_method_failed)

Definition at line 87 of file ReturnValue.h.

◆ ReturnValue_error_not_implemented_by_device

#define ReturnValue_error_not_implemented_by_device   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_not_implemented_by_device)

Definition at line 84 of file ReturnValue.h.

◆ ReturnValue_error_not_ready

#define ReturnValue_error_not_ready   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_not_ready)

Definition at line 88 of file ReturnValue.h.

◆ ReturnValue_error_nws_nwc_communication_error

#define ReturnValue_error_nws_nwc_communication_error   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_error_nws_nwc_communication_error)

Definition at line 85 of file ReturnValue.h.

◆ ReturnValue_ok

#define ReturnValue_ok   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_ok)

Definition at line 82 of file ReturnValue.h.

◆ ReturnValue_uninitialized

#define ReturnValue_uninitialized   ReturnValue(yarp::dev::ReturnValue::return_code::return_value_uninitialized)

Definition at line 90 of file ReturnValue.h.

◆ YARP_METHOD_DEPRECATED

#define YARP_METHOD_DEPRECATED ( )    yarp_method_deprecated(__func__)

Definition at line 115 of file ReturnValue.h.

◆ YARP_METHOD_NOT_YET_IMPLEMENTED

#define YARP_METHOD_NOT_YET_IMPLEMENTED ( )    yarp_method_not_implemented(__func__)

Definition at line 109 of file ReturnValue.h.

◆ YARP_RETURNVALUE_DISABLE_BOOL_INPUT

#define YARP_RETURNVALUE_DISABLE_BOOL_INPUT   1

Definition at line 24 of file ReturnValue.h.

◆ YARP_RETURNVALUE_DISABLE_BOOL_OUTPUT

#define YARP_RETURNVALUE_DISABLE_BOOL_OUTPUT   0

Definition at line 30 of file ReturnValue.h.