YARP
Yet Another Robot Platform
yarp::dev::DriverCreatorOf< T > Class Template Reference

A factory for creating driver objects of a particular type. More...

#include <yarp/dev/Drivers.h>

Public Member Functions

 DriverCreatorOf (const char *name, const char *wrap, const char *code)
 Constructor. More...
 
std::string toString () const override
 
std::string getName () const override
 
std::string getWrapper () const override
 
std::string getCode () const override
 
DeviceDrivercreate () const override
 

Detailed Description

template<class T>
class yarp::dev::DriverCreatorOf< T >

A factory for creating driver objects of a particular type.

Examples
dev/fake_motor/fake_motor.cpp, and dev/file_grabber/file_grabber.cpp.

Definition at line 85 of file Drivers.h.

Constructor & Destructor Documentation

◆ DriverCreatorOf()

template<class T >
yarp::dev::DriverCreatorOf< T >::DriverCreatorOf ( const char *  name,
const char *  wrap,
const char *  code 
)
inline

Constructor.

Sets up the name by which the device will be known.

Parameters
nameThe "common name" of the device. This is the name that will be used when naming the device externally, for example from the command line.
wrapThe "common name" of another device which can wrap this device up for network access. If there is no such device, use an empty name: ""
codeThe name of a class associated with this device. This is to give the user an entry point into the relevant code documentation.

Definition at line 102 of file Drivers.h.

Member Function Documentation

◆ create()

template<class T >
DeviceDriver* yarp::dev::DriverCreatorOf< T >::create ( ) const
inlineoverride

Definition at line 123 of file Drivers.h.

◆ getCode()

template<class T >
std::string yarp::dev::DriverCreatorOf< T >::getCode ( ) const
inlineoverride

Definition at line 119 of file Drivers.h.

◆ getName()

template<class T >
std::string yarp::dev::DriverCreatorOf< T >::getName ( ) const
inlineoverride

Definition at line 111 of file Drivers.h.

◆ getWrapper()

template<class T >
std::string yarp::dev::DriverCreatorOf< T >::getWrapper ( ) const
inlineoverride

Definition at line 115 of file Drivers.h.

◆ toString()

template<class T >
std::string yarp::dev::DriverCreatorOf< T >::toString ( ) const
inlineoverride

Definition at line 107 of file Drivers.h.


The documentation for this class was generated from the following file: