RobotRaconteur::ServiceFactory Class Reference

Base class for service factories. More...

#include <ServiceFactory.h>

Public Member Functions
virtual std::string	GetServiceName ()=0
	Returns the name of the service.
virtual std::string	DefString ()=0
	Return the service definition string used to generate the service factory.
virtual boost::shared_ptr< ServiceDefinition >	ServiceDef ()
	Return the parsed ServiceDefinition.

Detailed Description

Base class for service factories.

Service factories are generated by RobotRaconteurGen for static such as languages C++, Java, and C#, or dynamically generated by dynamic languages such as Python and MATLAB. Service factories must be registered with the node using RobotRaconteurNodeSetup, ClientNodeSetup, ServerNodeSetup, or RobotRaconteurNode::RegisterServiceType().

Each service definition corresponds to one service factory. Service factories are not typically accessed by the user once registered.

Member Function Documentation

DefString()

virtual std::string RobotRaconteur::ServiceFactory::DefString ( )

pure virtual

Return the service definition string used to generate the service factory.

Returns

std::string The service definition as a string

GetServiceName()

virtual std::string RobotRaconteur::ServiceFactory::GetServiceName ( )

pure virtual

Returns the name of the service.

Returns

std::string The name of the service

ServiceDef()

virtual boost::shared_ptr< ServiceDefinition > RobotRaconteur::ServiceFactory::ServiceDef ( )

virtual

Return the parsed ServiceDefinition.

Returns

RR_SHARED_PTR<ServiceDefinition> The service definition after parsing

---

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