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

The IScanController interface is used for all controller classes that implement scanning functionality. More...

#include <scancontroller.hpp>

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

Public Member Functions

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 IScanController interface is used for all controller classes that implement scanning functionality.

Member Function Documentation

virtual ScanData regilo::IScanController::getScan ( bool  fromDevice = true)
pure virtual

Get a scan from the device.

Parameters
fromDeviceSpecify if you want to get a scan from the device (true) or log (false). Default: true.
Returns
ScanData

Implemented in regilo::ScanController< ProtocolController >.


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