RobotRaconteur::UnknownException Class Reference

Exception representing an unknown exception type. More...

#include <Error.h>

Inheritance diagram for RobotRaconteur::UnknownException:

Public Member Functions
	UnknownException (const std::string &error, const std::string &message, std::string sub_name="", const boost::intrusive_ptr< RRValue > &param_=boost::intrusive_ptr< RRValue >())
	Construct an UnknownException.
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

Exception representing an unknown exception type.

This exception is used to transmit exceptions that do not have a MessageErrorType code. Check the Error field for the name of the exception.

Error code MessageErrorType_UnknownError (16)

Constructor & Destructor Documentation

UnknownException()

RobotRaconteur::UnknownException::UnknownException	(	const std::string &	error,
		const std::string &	message,
		std::string	sub_name = "",
		const boost::intrusive_ptr< RRValue > &	param_ = boost::intrusive_ptr< RRValue >() )

Construct an UnknownException.

Parameters

error	The name of the exception
message	Message for the user
sub_name	Optional error sub_name
param_	Optional error param

Member Function Documentation

ToString()

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

virtualinherited

Returns a string representing the exception.

Returns

std::string

Member Data Documentation

Error

std::string RobotRaconteur::RobotRaconteurException::Error

inherited

Name of the error.

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

ErrorCode

MessageErrorType RobotRaconteur::RobotRaconteurException::ErrorCode

inherited

Predefined error code.

Error code that specifies the type of error

ErrorParam

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

inherited

An optional parameter.

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

ErrorSubName

std::string RobotRaconteur::RobotRaconteurException::ErrorSubName

inherited

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

inherited

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