RobotRaconteur::ServiceDefinitionParseException Class Reference

Exception thrown when a parsing error occurs. More...

#include <ServiceDefinition.h>

Inheritance diagram for RobotRaconteur::ServiceDefinitionParseException:

Public Member Functions
	ServiceDefinitionParseException (const std::string &e)
	Construct a new ServiceDefinitionParseException.
	ServiceDefinitionParseException (const std::string &e, const ServiceDefinitionParseInfo &info)
	Construct a new ServiceDefinitionParseException.
virtual std::string	ToString () const
	Convert exception to string.
virtual std::string	ToString ()
	Returns a string representing the exception.

Public Attributes
ServiceDefinitionParseInfo	ParseInfo
	Parsing diagnostic information.
std::string	ShortMessage
	Short description of the error.
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 a parsing error occurs.

Extends ServiceDefinitionException. When used with messages, has error code MessageErrorType_ServiceDefinitionError (28)

Constructor & Destructor Documentation

ServiceDefinitionParseException() [1/2]

RobotRaconteur::ServiceDefinitionParseException::ServiceDefinitionParseException

(

const std::string &

e

)

Construct a new ServiceDefinitionParseException.

Parameters

e	The short message

ServiceDefinitionParseException() [2/2]

RobotRaconteur::ServiceDefinitionParseException::ServiceDefinitionParseException	(	const std::string &	e,
		const ServiceDefinitionParseInfo &	info )

Construct a new ServiceDefinitionParseException.

Parameters

e	The short message
info	Parsing diagnostic information

Member Function Documentation

ToString() [1/2]

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

virtualinherited

Returns a string representing the exception.

Returns

std::string

ToString() [2/2]

virtual std::string RobotRaconteur::ServiceDefinitionParseException::ToString ( ) const

virtual

Convert exception to string.

Returns a diagnostic message containing the service name, line number, and short message.

Returns

std::string The diagnostic message

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

ShortMessage

std::string RobotRaconteur::ServiceDefinitionParseException::ShortMessage

Short description of the error.

Do not include line number, file name, line number, or line text in ShortMessage. This information is stored in the ParseInfo field.

---

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/ServiceDefinition.h