RobotRaconteur::OperationAbortedException Class Reference

Exception thrown when an operation is aborted. More...

#include <Error.h>

Inheritance diagram for RobotRaconteur::OperationAbortedException:

Public Member Functions
	OperationAbortedException (const std::string &message, std::string sub_name="", const boost::intrusive_ptr< RRValue > &param_=boost::intrusive_ptr< RRValue >())
	Construct a OperationAbortedException.
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 thrown when an operation is aborted.

This is thrown be generator functions when Abort() is called

Generators are destroyed after throwing OperationAbortedException during Next()

This error is passed to generators to trigger an abort

Error code MessageErrorType_OperationAborted (108)

Constructor & Destructor Documentation

OperationAbortedException()

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

Construct a OperationAbortedException.

Parameters

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