Base class for Robot Raconteur exceptions. More...

#include <Error.h>

Inheritance diagram for RobotRaconteur::RobotRaconteurException:

Public Member Functions
	RobotRaconteurException ()
	Construct an empty RobtoRaconteurException().
	RobotRaconteurException (MessageErrorType ErrorCode, const std::string &error, const std::string &message, const std::string &sub_name, const boost::intrusive_ptr< RRValue > &param)
	Construct a RobotRaconteurException.
	RobotRaconteurException (const std::string &message, std::exception &innerexception)
	Construct a RobotRaconteurException based on an existing exception.
virtual std::string	ToString ()
	Returns a string representing the exception.

Public Attributes
MessageErrorType	ErrorCode
	Predefined error code.
std::string	Error
	Name of the error.
std::string	Message
	Message to pass to the user.
std::string	ErrorSubName
	An optional sub_name to further categorize the exception.
boost::intrusive_ptr< RRValue >	ErrorParam
	An optional parameter.

Detailed Description

Base class for Robot Raconteur exceptions.

RobotRaconteurException represents an exception that can be serialized and passed to a remote node. The MessageErrorType contains an enum of predefined error codes that represent different potential errors. Each error code has a corresponding C++ exception that extends RobotRaconteurException.

User defined exception types can be declared in Service Definition files. The C++ exception is generated with the thunk source. These user defined exceptions extend RobotRaconteurRemoteException.

Constructor & Destructor Documentation

◆ RobotRaconteurException() [1/2]

RobotRaconteur::RobotRaconteurException::RobotRaconteurException	(	MessageErrorType	ErrorCode,
		const std::string &	error,
		const std::string &	message,
		const std::string &	sub_name,
		const boost::intrusive_ptr< RRValue > &	param )

Construct a RobotRaconteurException.

Parameters

ErrorCode	The predefined error code for the exception
error	The error type name corresponding to the ErrorCode, or a user defined error type
message	A message to pass to the user
sub_name	An optional sub_name to further categorize the exception
param	An optional exception parameter

◆ RobotRaconteurException() [2/2]

RobotRaconteur::RobotRaconteurException::RobotRaconteurException	(	const std::string &	message,
		std::exception &	innerexception )

Construct a RobotRaconteurException based on an existing exception.

This will result in an exception with error code MessageErrorType_UnknownException

Parameters

message	A message to pass to the user
innerexception	The existing exception

Member Function Documentation

◆ ToString()

virtual std::string RobotRaconteur::RobotRaconteurException::ToString ( )

virtual

Returns a string representing the exception.

Returns: std::string

Member Data Documentation

◆ Error

std::string RobotRaconteur::RobotRaconteurException::Error

Name of the error.

Name corresponding to predefined error code, or a user defined error type

◆ ErrorCode

MessageErrorType RobotRaconteur::RobotRaconteurException::ErrorCode

Predefined error code.

Error code that specifies the type of error

◆ ErrorParam

boost::intrusive_ptr<RRValue> RobotRaconteur::RobotRaconteurException::ErrorParam

An optional parameter.

Use this placeholder if data needs to be passed with the exception

◆ ErrorSubName

std::string RobotRaconteur::RobotRaconteurException::ErrorSubName

An optional sub_name to further categorize the exception.

The sub_name should follow the Robot Raconteur naming rules. It should either be a single name or a fully qualified name using service definition naming rules

◆ Message

std::string RobotRaconteur::RobotRaconteurException::Message

Message to pass to the user.

Human readable message to pass to the user

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

/builddir/build/BUILD/robotraconteur-1.2.8-build/RobotRaconteur-1.2.8-Source/RobotRaconteurCore/include/RobotRaconteur/Error.h

Public Member Functions

Public Attributes