Regilo
A simple C++ library for controlling the Neato XV robot and the Hokuyo scanner.
regilo::IHokuyoController Class Referenceabstract

The IHokuyoController interface is used for the HokuyoController class. More...

#include <hokuyocontroller.hpp>

Inheritance diagram for regilo::IHokuyoController:
regilo::IScanController regilo::IController regilo::HokuyoController< ProtocolController >

Public Member Functions

virtual ~IHokuyoController ()=default
 Default destructor.
 
virtual std::map< std::string, std::string > getVersionInfo ()=0
 Return information about the scanner version. More...
 
- Public Member Functions inherited from regilo::IScanController
virtual ~IScanController ()=default
 Default destructor.
 
virtual ScanData getScan (bool fromDevice=true)=0
 Get a scan from the device. More...
 
- Public Member Functions inherited from regilo::IController
virtual ~IController ()=default
 Default destructor.
 
virtual void connect (const std::string &endpoint)=0
 Connect the controller to a device. More...
 
virtual bool isConnected () const =0
 Test if the controller is connected. More...
 
virtual std::string getEndpoint () const =0
 Get the endpoint of device. More...
 
virtual std::shared_ptr< ILoggetLog ()=0
 Get the current Log. More...
 
virtual std::shared_ptr< const ILoggetLog () const =0
 Get the current Log (a const variant). More...
 
virtual void setLog (std::shared_ptr< ILog > log)=0
 Set a Log (it can be shared between more controllers). More...
 
virtual std::string sendCommand (const std::string &command)=0
 Send a command to the device. More...
 

Detailed Description

The IHokuyoController interface is used for the HokuyoController class.

Member Function Documentation

virtual std::map<std::string, std::string> regilo::IHokuyoController::getVersionInfo ( )
pure virtual

Return information about the scanner version.

Returns
Key-value pairs with the information.

Implemented in regilo::HokuyoController< ProtocolController >.


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