Class for exception definitions. More...

Public Member Functions
	ExceptionDefinition (const boost::shared_ptr< ServiceDefinition > &service)
	Construct a new empty ExceptionDefinition object.
std::string	ToString ()
	Convert exception definition to string.
void	FromString (boost::string_ref s, const ServiceDefinitionParseInfo *parse_info=NULL)
	Parse an exception definition from string.
void	Reset ()
	Clear all fields.

Public Attributes
std::string	Name
	The name of the exception.
std::string	DocString
	Documentation string for the exception.
RR_WEAK_PTR< ServiceDefinition >	service
	The parent service definition.
ServiceDefinitionParseInfo	ParseInfo
	Parsing diagnostic information.

Detailed Description

Class for exception definitions.

See service_definitions.md for more information.

Constructor & Destructor Documentation

RobotRaconteur::ExceptionDefinition::ExceptionDefinition ( const boost::shared_ptr< ServiceDefinition > & service )

Construct a new empty ExceptionDefinition object.

Must be constructed with boost::make_shared<ExceptionDefinition>()

Parameters

service The parent service definition

void RobotRaconteur::ExceptionDefinition::FromString	(	boost::string_ref	s,
		const ServiceDefinitionParseInfo *	parse_info = NULL )

Parse an exception definition from string.

Parameters

s	The exception definition string
parse_info	Parsing diagnostic information

std::string RobotRaconteur::ExceptionDefinition::ToString ( )

Convert exception definition to string.

ServiceDefinitionParseInfo RobotRaconteur::ExceptionDefinition::ParseInfo

Parsing diagnostic information.

The ParseInfo field is populated by FromString()

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