RobWorkProject  24.6.21-
Public Member Functions | Protected Member Functions | List of all members
Scanner Class Referenceabstract

this interface describe a generic range scanning class. More...

#include <Scanner.hpp>

Inherits Sensor.

Inherited by Scanner1D, Scanner25D, and Scanner2D.

Public Member Functions

virtual void open ()=0
 Opens connection to the scanner.
 
virtual bool isOpen ()=0
 Returns whether the scanner has been opened. More...
 
virtual void close ()=0
 Closes the connection to the scanner.
 
virtual void acquire ()=0
 Acquires data.
 
virtual bool isScanReady ()=0
 tests whether an image has been acquired More...
 
virtual std::pair< double, double > getRange ()=0
 Returns the min and max range of this Scanner. More...
 
virtual double getFrameRate ()=0
 returns the framerate that this camera is setup with More...
 
- Public Member Functions inherited from Sensor
virtual ~Sensor ()
 destructor
 
const std::string & getName () const
 returns the name of this sensor More...
 
const std::string & getDescription () const
 returns a description of this sensor More...
 
rw::core::Ptr< rw::sensor::SensorModelgetSensorModel () const
 The frame to which the sensor is attached. More...
 
virtual void setSensorModel (rw::core::Ptr< rw::sensor::SensorModel > smodel)
 Sets the frame to which the sensor should be attached. More...
 
rw::core::PropertyMapgetPropertyMap ()
 gets the propertymap of this sensor
 
const rw::core::PropertyMapgetPropertyMap () const
 gets the propertymap of this sensor
 

Protected Member Functions

 Scanner (const std::string &name, const std::string &desc)
 constructor More...
 
 Scanner (const std::string &name)
 constructor More...
 
- Protected Member Functions inherited from Sensor
 Sensor (const std::string &name)
 constructor More...
 
 Sensor (const std::string &name, const std::string &description)
 constructor More...
 
void setName (const std::string &name)
 sets the name of this sensor More...
 
void setDescription (const std::string &description)
 sets the description of this sensor More...
 

Additional Inherited Members

- Public Types inherited from Sensor
typedef rw::core::Ptr< SensorPtr
 smart pointer type
 

Detailed Description

this interface describe a generic range scanning class.

Constructor & Destructor Documentation

◆ Scanner() [1/2]

Scanner ( const std::string &  name,
const std::string &  desc 
)
inlineprotected

constructor

Parameters
name[in] name of sensor
desc[in] description of sensor

◆ Scanner() [2/2]

Scanner ( const std::string &  name)
inlineprotected

constructor

Parameters
name[in] name of sensor

Member Function Documentation

◆ getFrameRate()

virtual double getFrameRate ( )
pure virtual

returns the framerate that this camera is setup with

Returns
the framerate in frames per second

Implemented in SimulatedScanner1D.

◆ getRange()

virtual std::pair<double, double> getRange ( )
pure virtual

Returns the min and max range of this Scanner.

Returns
min and max range

Implemented in SimulatedScanner1D.

◆ isOpen()

virtual bool isOpen ( )
pure virtual

Returns whether the scanner has been opened.

Returns
true if scanner is opened

Implemented in SimulatedScanner1D.

◆ isScanReady()

virtual bool isScanReady ( )
pure virtual

tests whether an image has been acquired

Returns
true if an image has been acquired, false otherwise.

Implemented in SimulatedScanner1D.


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