Detailed Description

This software driver implements the protocol SCIP-2.0 for interfacing HOKUYO URG/UTM/UXM/UST laser scanners (USB or Ethernet).

Refer to the example code HOKUYO_laser_test and to example rawlog-grabber config files

See also the application "rawlog-grabber" for a ready-to-use application to gather data from the scanner.

  PARAMETERS IN THE ".INI"-LIKE CONFIGURATION STRINGS:
 -------------------------------------------------------
   [supplied_section_name]
    HOKUYO_motorSpeed_rpm=600
    #HOKUYO_HS_mode   = false    // Optional (un-comment line if used):
Set/unset the High-sensitivity mode (not on all models/firmwares!)
    # Uncomment serial port or IP address, depending on the Hokuyo model
(serial/USB vs. Ethernet):
    COM_port_WIN = COM3       // Serial port name in Windows
    COM_port_LIN = ttyS0      // Serial port name in GNU/Linux
    #IP_DIR     =       192.168.0.10 // Uncommented this and "PORT_DIR" if the
used HOKUYO is connected by Ethernet instead of USB
    #PORT_DIR = 10940         // Default value: 10940
    pose_x=0.21 // Laser range scaner 3D position in the robot (meters)
    pose_y=0
    pose_z=0.34
    pose_yaw=0  // Angles in degrees
    pose_pitch=0
    pose_roll=0
    #disable_firmware_timestamp = true   // Uncomment to use PC time instead
of laser time
    # Optional: reduced FOV:
    # reduced_fov  = 25 // Deg
    #preview = true // Enable GUI visualization of captured data
    # Optional: Exclusion zones to avoid the robot seeing itself:
    #exclusionZone1_x = 0.20 0.30 0.30 0.20
    #exclusionZone1_y = 0.20 0.30 0.30 0.20
    # Optional: Exclusion zones to avoid the robot seeing itself:
    #exclusionAngles1_ini = 20  // Deg
    #exclusionAngles1_end = 25  // Deg

Definition at line 73 of file CHokuyoURG.h.

#include <mrpt/hwdrivers/CHokuyoURG.h>

Inheritance diagram for mrpt::hwdrivers::CHokuyoURG:

Classes
struct	TSensorInfo
	Used in CHokuyoURG::displayVersionInfo. More...

Public Types
enum	TSensorState { ssInitializing = 0, ssWorking, ssError }
	The current state of the sensor. More...

using	Ptr = std::shared_ptr< CGenericSensor >

typedef std::multimap< mrpt::system::TTimeStamp, mrpt::utils::CSerializable::Ptr >	TListObservations

typedef std::pair< mrpt::system::TTimeStamp, mrpt::utils::CSerializable::Ptr >	TListObsPair

Public Member Functions
	CHokuyoURG ()
	Constructor. More...

virtual	~CHokuyoURG ()
	Destructor: turns the laser off. More...

void	doProcessSimple (bool &outThereIsObservation, mrpt::obs::CObservation2DRangeScan &outObservation, bool &hardwareError)
	Specific laser scanner "software drivers" must process here new data from the I/O stream, and, if a whole scan has arrived, return it. More...

bool	turnOn ()
	Enables the scanning mode (which may depend on the specific laser device); this must be called before asking for observations to assure that the protocol has been initializated. More...

bool	turnOff ()
	Disables the scanning mode (this can be used to turn the device in low energy mode, if available) More...

void	purgeBuffers ()
	Empties the RX buffers of the serial port. More...

void	setSerialPort (const std::string &port_name)
	If set to non-empty, the serial port will be attempted to be opened automatically when this class is first used to request data from the laser. More...

void	setIPandPort (const std::string &ip, const unsigned int &port)
	Set the ip direction and port to connect using Ethernet communication. More...

const std::string	getSerialPort ()
	Returns the currently set serial port. More...

void	setReducedFOV (const double fov)
	If called (before calling "turnOn"), the field of view of the laser is reduced to the given range (in radians), discarding the rest of measures. More...

bool	setHighSensitivityMode (bool enabled)
	Changes the high sensitivity mode (HS) (default: false) More...

bool	setIntensityMode (bool enabled)
	If true scans will capture intensity. More...

void	showPreview (bool enable=true)
	Enables GUI visualization in real-time. More...

void	bindIO (mrpt::utils::CStream *streamIO)
	Binds the object to a given I/O channel. More...

void	getObservation (bool &outThereIsObservation, mrpt::obs::CObservation2DRangeScan &outObservation, bool &hardwareError)
	Get the last observation from the sensor, if available, and unmarks it as being "the last one" (thus a new scan must arrive or subsequent calls will find no new observations). More...

void	doProcess ()
	Main method for a CGenericSensor. More...

virtual const mrpt::hwdrivers::TSensorClassId *	GetRuntimeClass () const =0

TSensorState	getState () const
	The current state of the sensor. More...

double	getProcessRate () const

std::string	getSensorLabel () const

void	setSensorLabel (const std::string &sensorLabel)

void	enableVerbose (bool enabled=true)
	Enable or disable extra debug info dumped to std::cout during sensor operation. More...

bool	isVerboseEnabled () const

void	loadConfig (const mrpt::utils::CConfigFileBase &configSource, const std::string &section)
	Loads the generic settings common to any sensor (See CGenericSensor), then call to "loadConfig_sensorSpecific". More...

void	getObservations (TListObservations &lstObjects)
	Returns a list of enqueued objects, emptying it (thread-safe). More...

virtual void	setPathForExternalImages (const std::string &directory)
	Set the path where to save off-rawlog image files (will be ignored in those sensors where this is not applicable). More...

void	setExternalImageFormat (const std::string &ext)
	Set the extension ("jpg","gif","png",...) that determines the format of images saved externally The default is "jpg". More...

void	setExternalImageJPEGQuality (const unsigned int quality)
	The quality of JPEG compression, when external images is enabled and the format is "jpg". More...

unsigned int	getExternalImageJPEGQuality () const

Static Public Member Functions
static void	registerClass (const TSensorClassId *pNewClass)
	Register a class into the internal list of "CGenericSensor" descendents. More...

static CGenericSensor *	createSensor (const std::string &className)
	Creates a sensor by a name of the class. More...

static CGenericSensor::Ptr	createSensorPtr (const std::string &className)
	Just like createSensor, but returning a smart pointer to the newly created sensor object. More...

Protected Member Functions
bool	checkCOMisOpen ()
	Returns true if there is a valid stream bound to the laser scanner, otherwise it first try to open the serial port "m_com_port". More...

void	loadConfig_sensorSpecific (const mrpt::utils::CConfigFileBase &configSource, const std::string &iniSection)
	See the class documentation at the top for expected parameters. More...

void	loadCommonParams (const mrpt::utils::CConfigFileBase &configSource, const std::string &iniSection)
	Should be call by derived classes at "loadConfig" (loads exclusion areas AND exclusion angles). More...

void	filterByExclusionAreas (mrpt::obs::CObservation2DRangeScan &obs) const
	Mark as invalid those points which (x,y) coordinates fall within the exclusion polygons. More...

void	filterByExclusionAngles (mrpt::obs::CObservation2DRangeScan &obs) const
	Mark as invalid those ranges in a set of forbiden angle ranges. More...

void	processPreview (const mrpt::obs::CObservation2DRangeScan &obs)
	Must be called inside the capture method to allow optional GUI preview of scans. More...

void	appendObservations (const std::vector< mrpt::utils::CSerializable::Ptr > &obj)
	This method must be called by derived classes to enqueue a new observation in the list to be returned by getObservations. More...

void	appendObservation (const mrpt::utils::CSerializable::Ptr &obj)
	Like appendObservations() but for just one observation. More...

Protected Attributes
double	m_reduced_fov
	Used to reduce artificially the interval of scan ranges. More...

std::string	m_com_port
	If set to non-empty, the serial port will be attempted to be opened automatically when this class is first used to request data from the laser. More...

std::string	m_ip_dir
	If set to non-empty and m_port_dir too, the program will try to connect to a Hokuyo using Ethernet communication. More...

unsigned int	m_port_dir
	If set to non-empty and m_ip_dir too, the program will try to connect to a Hokuyo using Ethernet communication. More...

TSensorInfo	m_sensor_info
	The information gathered when the laser is first open. More...

bool	m_I_am_owner_serial_port

uint32_t	m_timeStartUI
	Time of the first data packet, for synchronization purposes. More...

int	m_timeStartSynchDelay
	Counter to discard to first few packets before setting the correspondence between device and computer timestamps. More...

mrpt::system::TTimeStamp	m_timeStartTT

bool	m_disable_firmware_timestamp

bool	m_intensity
	Get intensity from lidar scan (default: false) More...

utils::CStream *	m_stream
	The I/O channel (will be nullptr if not bound). More...

size_t	m_grab_decimation_counter
	Used when "m_grab_decimation" is enabled. More...

TSensorState	m_state

bool	m_verbose

std::string	m_path_for_external_images
	The path where to save off-rawlog images: empty means save images embedded in the rawlog. More...

std::string	m_external_images_format
	The extension ("jpg","gif","png",...) that determines the format of images saved externally. More...

unsigned int	m_external_images_jpeg_quality
	For JPEG images, the quality (default=95%). More...

Common settings to any sensor, loaded in "loadConfig"
double	m_process_rate
	See CGenericSensor. More...

size_t	m_max_queue_len
	See CGenericSensor. More...

size_t	m_grab_decimation
	If set to N>=2, only 1 out of N observations will be saved to m_objList. More...

std::string	m_sensorLabel
	See CGenericSensor. More...

Private Member Functions
bool	enableSCIP20 ()
	Enables the SCIP2.0 protocol (this must be called at the very begining!). More...

bool	setHighBaudrate ()
	Passes to 115200bps bitrate. More...

bool	switchLaserOn ()
	Switchs the laser on. More...

bool	switchLaserOff ()
	Switchs the laser off. More...

bool	setMotorSpeed (int motoSpeed_rpm)
	Changes the motor speed in rpm's (default 600rpm) More...

bool	displayVersionInfo ()
	Ask to the device, and print to the debug stream, details about the firmware version,serial number,... More...

bool	displaySensorInfo (CHokuyoURG::TSensorInfo *out_data=nullptr)
	Ask to the device, and print to the debug stream, details about the sensor model. More...

bool	startScanningMode ()
	Start the scanning mode, using parameters stored in the object (loaded from the .ini file) After this command the device will start to send scans until "switchLaserOff" is called. More...

void	initialize ()
	Turns the laser on. More...

bool	receiveResponse (const char sentCmd_forEchoVerification, char &rcv_status0, char &rcv_status1, char rcv_data, int &rcv_dataLength)
	Waits for a response from the device. More...

bool	assureBufferHasBytes (const size_t nDesiredBytes)
	Assures a minimum number of bytes in the input buffer, reading from the serial port only if required. More...

Private Attributes
int	m_firstRange
	The first and last ranges to consider from the scan. More...

int	m_lastRange

int	m_motorSpeed_rpm
	The motor speed (default=600rpm) More...

poses::CPose3D	m_sensorPose
	The sensor 6D pose: More...

mrpt::utils::circular_buffer< uint8_t >	m_rx_buffer
	Auxiliary buffer for readings. More...

std::string	m_lastSentMeasCmd
	The last sent measurement command (MDXXX), including the last 0x0A. More...

bool	m_highSensMode
	High sensitivity [HS] mode (default: false) More...

mrpt::gui::CDisplayWindow3D::Ptr	m_win

Member Typedef Documentation

◆ Ptr

using mrpt::hwdrivers::CGenericSensor::Ptr = std::shared_ptr<CGenericSensor>

inherited

Definition at line 73 of file CGenericSensor.h.

◆ TListObservations

typedef std::multimap<mrpt::system::TTimeStamp, mrpt::utils::CSerializable::Ptr> mrpt::hwdrivers::CGenericSensor::TListObservations

inherited

Definition at line 78 of file CGenericSensor.h.

◆ TListObsPair

typedef std::pair<mrpt::system::TTimeStamp, mrpt::utils::CSerializable::Ptr> mrpt::hwdrivers::CGenericSensor::TListObsPair

inherited

Definition at line 80 of file CGenericSensor.h.

Member Enumeration Documentation

◆ TSensorState

enum mrpt::hwdrivers::CGenericSensor::TSensorState

inherited

The current state of the sensor.

See also: CGenericSensor::getState

Enumerator
ssInitializing
ssWorking
ssError

Definition at line 85 of file CGenericSensor.h.

Constructor & Destructor Documentation

◆ CHokuyoURG()

CHokuyoURG::CHokuyoURG ( )

Constructor.

Definition at line 34 of file CHokuyoURG.cpp.

References mrpt::hwdrivers::CGenericSensor::m_sensorLabel.

◆ ~CHokuyoURG()

CHokuyoURG::~CHokuyoURG ( )

virtual

Destructor: turns the laser off.

Definition at line 57 of file CHokuyoURG.cpp.

References m_I_am_owner_serial_port, mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, m_win, and turnOff().

Here is the call graph for this function:

Member Function Documentation

◆ appendObservation()

void mrpt::hwdrivers::CGenericSensor::appendObservation ( const mrpt::utils::CSerializable::Ptr & obj )

inlineprotectedinherited

Like appendObservations() but for just one observation.

Definition at line 180 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::appendObservations().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendObservations()

void CGenericSensor::appendObservations ( const std::vector< mrpt::utils::CSerializable::Ptr > & obj )

protectedinherited

This method must be called by derived classes to enqueue a new observation in the list to be returned by getObservations.

Passed objects must be created in dynamic memory and a smart pointer passed. Example of creation:

      mrpt::obs::CObservationGPS::Ptr  o = CObservationGPS::Ptr( new
CObservationGPS() );
      o-> .... // Set data
      appendObservation(o);

If several observations are passed at once in the vector, they'll be considered as a block regarding the grabbing decimation factor.

Definition at line 53 of file CGenericSensor.cpp.

References CLASS_ID, mrpt::hwdrivers::CGenericSensor::m_csObjList, mrpt::hwdrivers::CGenericSensor::m_grab_decimation, mrpt::hwdrivers::CGenericSensor::m_grab_decimation_counter, mrpt::hwdrivers::CGenericSensor::m_objList, and THROW_EXCEPTION.

Referenced by mrpt::hwdrivers::CGenericSensor::appendObservation(), mrpt::hwdrivers::CNationalInstrumentsDAQ::doProcess(), and mrpt::hwdrivers::CKinect::doProcess().

Here is the caller graph for this function:

◆ assureBufferHasBytes()

bool CHokuyoURG::assureBufferHasBytes ( const size_t nDesiredBytes )

private

Assures a minimum number of bytes in the input buffer, reading from the serial port only if required.

Returns: false if the number of bytes are not available, even after trying to fetch more data from the serial port.

Definition at line 431 of file CHokuyoURG.cpp.

References ASSERT_, mrpt::utils::circular_buffer< T >::available(), mrpt::utils::circular_buffer< T >::capacity(), m_ip_dir, m_rx_buffer, mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, min, mrpt::utils::circular_buffer< T >::push_many(), mrpt::comms::CClientTCPSocket::readAsync(), mrpt::utils::CStream::ReadBuffer(), and mrpt::utils::circular_buffer< T >::size().

Referenced by receiveResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bindIO()

void C2DRangeFinderAbstract::bindIO ( mrpt::utils::CStream * streamIO )

inherited

Binds the object to a given I/O channel.

The stream object must not be deleted before the destruction of this class.

See also: comms::CSerialPort

Definition at line 43 of file C2DRangeFinderAbstract.cpp.

References mrpt::hwdrivers::C2DRangeFinderAbstract::m_csChangeStream, and mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream.

Referenced by checkCOMisOpen().

Here is the caller graph for this function:

◆ checkCOMisOpen()

bool CHokuyoURG::checkCOMisOpen ( )

protected

Returns true if there is a valid stream bound to the laser scanner, otherwise it first try to open the serial port "m_com_port".

Definition at line 1043 of file CHokuyoURG.cpp.

References mrpt::hwdrivers::C2DRangeFinderAbstract::bindIO(), mrpt::comms::CClientTCPSocket::connect(), mrpt::comms::CClientTCPSocket::isConnected(), mrpt::comms::CSerialPort::isOpen(), m_com_port, m_I_am_owner_serial_port, m_ip_dir, m_port_dir, mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, MRPT_END, MRPT_START, mrpt::comms::CSerialPort::open(), THROW_EXCEPTION, and turnOn().

Referenced by displaySensorInfo(), displayVersionInfo(), doProcessSimple(), enableSCIP20(), initialize(), purgeBuffers(), receiveResponse(), setHighBaudrate(), setHighSensitivityMode(), setMotorSpeed(), startScanningMode(), switchLaserOff(), switchLaserOn(), and turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSensor()

CGenericSensor * CGenericSensor::createSensor ( const std::string & className )

staticinherited

Creates a sensor by a name of the class.

Typically the user may want to create a smart pointer around the returned pointer, whis is made with:

CGenericSensor::Ptr sensor = CGenericSensor::Ptr(

CGenericSensor::createSensor("XXX") );

Returns: A pointer to a new class, or nullptr if class name is unknown.

Definition at line 103 of file CGenericSensor.cpp.

References mrpt::hwdrivers::CGenericSensor::get_registered_sensor_classes().

Referenced by mrpt::hwdrivers::CGenericSensor::createSensorPtr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSensorPtr()

static CGenericSensor::Ptr mrpt::hwdrivers::CGenericSensor::createSensorPtr ( const std::string & className )

inlinestaticinherited

Just like createSensor, but returning a smart pointer to the newly created sensor object.

Definition at line 220 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::createSensor().

Here is the call graph for this function:

◆ displaySensorInfo()

bool CHokuyoURG::displaySensorInfo ( CHokuyoURG::TSensorInfo * out_data = nullptr )

private

Ask to the device, and print to the debug stream, details about the sensor model.

It also optionally saves all the information in an user supplied data structure "out_data".

Returns: false on any error

Definition at line 879 of file CHokuyoURG.cpp.

Referenced by turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayVersionInfo()

bool CHokuyoURG::displayVersionInfo ( )

private

Ask to the device, and print to the debug stream, details about the firmware version,serial number,...

Returns: false on any error

Definition at line 826 of file CHokuyoURG.cpp.

References checkCOMisOpen(), mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, MRPT_LOG_DEBUG, MRPT_LOG_INFO_FMT, receiveResponse(), mrpt::system::os::sprintf(), and mrpt::utils::CStream::WriteBuffer().

Referenced by turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doProcess()

void C2DRangeFinderAbstract::doProcess ( )

virtualinherited

Main method for a CGenericSensor.

Implements mrpt::hwdrivers::CGenericSensor.

Reimplemented in mrpt::hwdrivers::CLMS100Eth.

Definition at line 70 of file C2DRangeFinderAbstract.cpp.

References mrpt::hwdrivers::CGenericSensor::appendObservation(), mrpt::hwdrivers::C2DRangeFinderAbstract::doProcessSimple(), mrpt::hwdrivers::C2DRangeFinderAbstract::m_nextObservation, mrpt::hwdrivers::CGenericSensor::m_state, mrpt::hwdrivers::CGenericSensor::ssError, mrpt::hwdrivers::CGenericSensor::ssWorking, and THROW_EXCEPTION.

Here is the call graph for this function:

◆ doProcessSimple()

void CHokuyoURG::doProcessSimple	(	bool &	outThereIsObservation,
		mrpt::obs::CObservation2DRangeScan &	outObservation,
		bool &	hardwareError
	)

virtual

Specific laser scanner "software drivers" must process here new data from the I/O stream, and, if a whole scan has arrived, return it.

This method will be typically called in a different thread than other methods, and will be called in a timely fashion.

Implements mrpt::hwdrivers::C2DRangeFinderAbstract.

Definition at line 74 of file CHokuyoURG.cpp.

Here is the call graph for this function:

◆ enableSCIP20()

bool CHokuyoURG::enableSCIP20 ( )

private

Enables the SCIP2.0 protocol (this must be called at the very begining!).

Returns: false on any error

Definition at line 605 of file CHokuyoURG.cpp.

References checkCOMisOpen(), mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, MRPT_LOG_DEBUG, receiveResponse(), mrpt::system::os::strcpy(), and mrpt::utils::CStream::WriteBuffer().

Referenced by turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableVerbose()

void mrpt::hwdrivers::CGenericSensor::enableVerbose ( bool enabled = true )

inlineinherited

Enable or disable extra debug info dumped to std::cout during sensor operation.

Default: disabled unless the environment variable "MRPT_HWDRIVERS_VERBOSE" is set to "1" during object creation.

Definition at line 106 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::m_verbose.

◆ filterByExclusionAngles()

void C2DRangeFinderAbstract::filterByExclusionAngles ( mrpt::obs::CObservation2DRangeScan & obs ) const

protectedinherited

Mark as invalid those ranges in a set of forbiden angle ranges.

See also: loadExclusionAreas

Definition at line 183 of file C2DRangeFinderAbstract.cpp.

References mrpt::obs::CObservation2DRangeScan::filterByExclusionAngles(), and mrpt::hwdrivers::C2DRangeFinderAbstract::m_lstExclusionAngles.

Referenced by mrpt::hwdrivers::CRoboPeakLidar::doProcessSimple(), mrpt::hwdrivers::CSickLaserUSB::doProcessSimple(), doProcessSimple(), and mrpt::hwdrivers::CSickLaserSerial::doProcessSimple().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ filterByExclusionAreas()

void C2DRangeFinderAbstract::filterByExclusionAreas ( mrpt::obs::CObservation2DRangeScan & obs ) const

protectedinherited

Mark as invalid those points which (x,y) coordinates fall within the exclusion polygons.

See also: loadExclusionAreas

Definition at line 174 of file C2DRangeFinderAbstract.cpp.

References mrpt::obs::CObservation2DRangeScan::filterByExclusionAreas(), and mrpt::hwdrivers::C2DRangeFinderAbstract::m_lstExclusionPolys.

Referenced by mrpt::hwdrivers::CRoboPeakLidar::doProcessSimple(), mrpt::hwdrivers::CSickLaserUSB::doProcessSimple(), doProcessSimple(), and mrpt::hwdrivers::CSickLaserSerial::doProcessSimple().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExternalImageJPEGQuality()

unsigned int mrpt::hwdrivers::CGenericSensor::getExternalImageJPEGQuality ( ) const

inlineinherited

Definition at line 290 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::m_external_images_jpeg_quality.

◆ getObservation()

void C2DRangeFinderAbstract::getObservation	(	bool &	outThereIsObservation,
		mrpt::obs::CObservation2DRangeScan &	outObservation,
		bool &	hardwareError
	)

inherited

Get the last observation from the sensor, if available, and unmarks it as being "the last one" (thus a new scan must arrive or subsequent calls will find no new observations).

Definition at line 53 of file C2DRangeFinderAbstract.cpp.

References mrpt::hwdrivers::C2DRangeFinderAbstract::m_csLastObservation, mrpt::hwdrivers::C2DRangeFinderAbstract::m_hardwareError, mrpt::hwdrivers::C2DRangeFinderAbstract::m_lastObservation, and mrpt::hwdrivers::C2DRangeFinderAbstract::m_lastObservationIsNew.

◆ getObservations()

void CGenericSensor::getObservations ( TListObservations & lstObjects )

inherited

Returns a list of enqueued objects, emptying it (thread-safe).

The objects must be freed by the invoker.

Definition at line 91 of file CGenericSensor.cpp.

References mrpt::hwdrivers::CGenericSensor::m_csObjList, and mrpt::hwdrivers::CGenericSensor::m_objList.

◆ getProcessRate()

double mrpt::hwdrivers::CGenericSensor::getProcessRate ( ) const

inlineinherited

Definition at line 94 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::m_process_rate.

◆ GetRuntimeClass()

virtual const mrpt::hwdrivers::TSensorClassId* mrpt::hwdrivers::CGenericSensor::GetRuntimeClass ( ) const

pure virtualinherited

◆ getSensorLabel()

std::string mrpt::hwdrivers::CGenericSensor::getSensorLabel ( ) const

inlineinherited

Definition at line 95 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::m_sensorLabel.

◆ getSerialPort()

const std::string mrpt::hwdrivers::CHokuyoURG::getSerialPort ( )

inline

Returns the currently set serial port.

See also: setSerialPort

Definition at line 220 of file CHokuyoURG.h.

References m_com_port.

◆ getState()

TSensorState mrpt::hwdrivers::CGenericSensor::getState ( ) const

inlineinherited

The current state of the sensor.

Definition at line 93 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::m_state.

◆ initialize()

void CHokuyoURG::initialize ( void )

privatevirtual

Turns the laser on.

Reimplemented from mrpt::hwdrivers::CGenericSensor.

Definition at line 1174 of file CHokuyoURG.cpp.

References checkCOMisOpen(), and turnOn().

Here is the call graph for this function:

◆ isVerboseEnabled()

bool mrpt::hwdrivers::CGenericSensor::isVerboseEnabled ( ) const

inlineinherited

Definition at line 107 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::m_verbose.

◆ loadCommonParams()

void C2DRangeFinderAbstract::loadCommonParams	(	const mrpt::utils::CConfigFileBase &	configSource,
		const std::string &	iniSection
	)

protectedinherited

Should be call by derived classes at "loadConfig" (loads exclusion areas AND exclusion angles).

This loads a sequence of vertices of a polygon given by its (x,y) coordinates relative to the vehicle, that is, taking into account the "sensorPose".

exclusionZoneu_x
exclusionZoneu_y for u=1,2,3,... All points within the 2D polygon will be ignored, for any Z, unless an optional entry is found:
exclusionZoneu_z=[z_min z_max] In that case, only the points within the 2D polygon AND the given range in Z will be ignored.

The number of zones is variable, but they must start at 1 and be consecutive.

This also loads any other common params (e.g. 'preview')

See also: filterByExclusionAreas

Definition at line 98 of file C2DRangeFinderAbstract.cpp.

References ASSERT_, ASSERTMSG_, DEG2RAD, mrpt::format(), mrpt::hwdrivers::C2DRangeFinderAbstract::m_lstExclusionAngles, mrpt::hwdrivers::C2DRangeFinderAbstract::m_lstExclusionPolys, M_PI, mrpt::hwdrivers::C2DRangeFinderAbstract::m_showPreview, mrpt::utils::CConfigFileBase::read_bool(), mrpt::utils::CConfigFileBase::read_double(), and mrpt::utils::CConfigFileBase::read_vector().

Referenced by mrpt::hwdrivers::CSickLaserUSB::loadConfig_sensorSpecific(), mrpt::hwdrivers::CRoboPeakLidar::loadConfig_sensorSpecific(), mrpt::hwdrivers::CSickLaserSerial::loadConfig_sensorSpecific(), and loadConfig_sensorSpecific().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadConfig()

void CGenericSensor::loadConfig	(	const mrpt::utils::CConfigFileBase &	cfg,
		const std::string &	sect
	)

inherited

Loads the generic settings common to any sensor (See CGenericSensor), then call to "loadConfig_sensorSpecific".

Exceptions

This	method throws an exception with a descriptive message if some critical parameter is missing or has an invalid value.

Definition at line 132 of file CGenericSensor.cpp.

References mrpt::hwdrivers::CGenericSensor::loadConfig_sensorSpecific(), mrpt::hwdrivers::CGenericSensor::m_grab_decimation, mrpt::hwdrivers::CGenericSensor::m_grab_decimation_counter, mrpt::hwdrivers::CGenericSensor::m_max_queue_len, mrpt::hwdrivers::CGenericSensor::m_process_rate, mrpt::hwdrivers::CGenericSensor::m_sensorLabel, MRPT_END, MRPT_START, mrpt::utils::CConfigFileBase::read_double(), mrpt::utils::CConfigFileBase::read_int(), and mrpt::utils::CConfigFileBase::read_string().

Here is the call graph for this function:

◆ loadConfig_sensorSpecific()

void CHokuyoURG::loadConfig_sensorSpecific	(	const mrpt::utils::CConfigFileBase &	configSource,
		const std::string &	iniSection
	)

protectedvirtual

See the class documentation at the top for expected parameters.

Implements mrpt::hwdrivers::CGenericSensor.

Definition at line 213 of file CHokuyoURG.cpp.

References ASSERTMSG_, DEG2RAD, mrpt::hwdrivers::C2DRangeFinderAbstract::loadCommonParams(), m_com_port, m_disable_firmware_timestamp, m_highSensMode, m_intensity, m_ip_dir, m_motorSpeed_rpm, m_port_dir, m_reduced_fov, m_sensorPose, mrpt::utils::CConfigFileBase::read_bool(), mrpt::utils::CConfigFileBase::read_float(), mrpt::utils::CConfigFileBase::read_int(), mrpt::utils::CConfigFileBase::read_string(), and mrpt::poses::CPose3D::setFromValues().

Here is the call graph for this function:

◆ processPreview()

void C2DRangeFinderAbstract::processPreview ( const mrpt::obs::CObservation2DRangeScan & obs )

protectedinherited

Must be called inside the capture method to allow optional GUI preview of scans.

Definition at line 189 of file C2DRangeFinderAbstract.cpp.

References mrpt::hwdrivers::CGenericSensor::m_sensorLabel, mrpt::hwdrivers::C2DRangeFinderAbstract::m_showPreview, mrpt::hwdrivers::C2DRangeFinderAbstract::m_win, and mrpt::opengl::CPlanarLaserScan::setScan().

Referenced by mrpt::hwdrivers::CRoboPeakLidar::doProcessSimple(), mrpt::hwdrivers::CSickLaserUSB::doProcessSimple(), doProcessSimple(), and mrpt::hwdrivers::CSickLaserSerial::doProcessSimple().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ purgeBuffers()

void CHokuyoURG::purgeBuffers ( )

Empties the RX buffers of the serial port.

Definition at line 1189 of file CHokuyoURG.cpp.

References checkCOMisOpen(), mrpt::comms::CClientTCPSocket::getReadPendingBytes(), m_ip_dir, mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, mrpt::comms::CSerialPort::purgeBuffers(), mrpt::utils::CStream::ReadBuffer(), and THROW_EXCEPTION.

Referenced by turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ receiveResponse()

bool CHokuyoURG::receiveResponse	(	const char *	sentCmd_forEchoVerification,
		char &	rcv_status0,
		char &	rcv_status1,
		char *	rcv_data,
		int &	rcv_dataLength
	)

private

Waits for a response from the device.

Returns: false on any error

Definition at line 474 of file CHokuyoURG.cpp.

References ASSERT_, assureBufferHasBytes(), checkCOMisOpen(), m_rx_buffer, and mrpt::utils::circular_buffer< T >::pop().

Referenced by displaySensorInfo(), displayVersionInfo(), doProcessSimple(), enableSCIP20(), setHighBaudrate(), setHighSensitivityMode(), setMotorSpeed(), startScanningMode(), switchLaserOff(), and switchLaserOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerClass()

void CGenericSensor::registerClass ( const TSensorClassId * pNewClass )

staticinherited

Register a class into the internal list of "CGenericSensor" descendents.

Used internally in the macros DEFINE_GENERIC_SENSOR, etc...

Can be used as "CGenericSensor::registerClass( SENSOR_CLASS_ID(CMySensor) );" if building custom sensors outside mrpt libraries in user code.

Definition at line 121 of file CGenericSensor.cpp.

References mrpt::hwdrivers::TSensorClassId::className, and mrpt::hwdrivers::CGenericSensor::get_registered_sensor_classes().

Referenced by mrpt::hwdrivers::CGenericSensor::CLASSINIT_GENERIC_SENSOR::CLASSINIT_GENERIC_SENSOR().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setExternalImageFormat()

void mrpt::hwdrivers::CGenericSensor::setExternalImageFormat ( const std::string & ext )

inlineinherited

Set the extension ("jpg","gif","png",...) that determines the format of images saved externally The default is "jpg".

See also: setPathForExternalImages, setExternalImageJPEGQuality

Definition at line 279 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::m_external_images_format.

◆ setExternalImageJPEGQuality()

void mrpt::hwdrivers::CGenericSensor::setExternalImageJPEGQuality ( const unsigned int quality )

inlineinherited

The quality of JPEG compression, when external images is enabled and the format is "jpg".

See also: setExternalImageFormat

Definition at line 286 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::m_external_images_jpeg_quality.

◆ setHighBaudrate()

bool CHokuyoURG::setHighBaudrate ( )

private

Passes to 115200bps bitrate.

Returns: false on any error

Definition at line 390 of file CHokuyoURG.cpp.

References checkCOMisOpen(), mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, MRPT_LOG_DEBUG, receiveResponse(), mrpt::system::os::strcpy(), and mrpt::utils::CStream::WriteBuffer().

Referenced by turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHighSensitivityMode()

bool CHokuyoURG::setHighSensitivityMode ( bool enabled )

Changes the high sensitivity mode (HS) (default: false)

Returns: false on any error

Definition at line 775 of file CHokuyoURG.cpp.

References checkCOMisOpen(), mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, MRPT_LOG_DEBUG, MRPT_LOG_DEBUG_FMT, receiveResponse(), mrpt::system::os::sprintf(), and mrpt::utils::CStream::WriteBuffer().

Referenced by turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIntensityMode()

bool CHokuyoURG::setIntensityMode ( bool enabled )

If true scans will capture intensity.

(default: false) Should not be called while scanning.

Returns: false on any error

Definition at line 817 of file CHokuyoURG.cpp.

References m_intensity.

◆ setIPandPort()

void mrpt::hwdrivers::CHokuyoURG::setIPandPort	(	const std::string &	ip,
		const unsigned int &	port
	)

inline

Set the ip direction and port to connect using Ethernet communication.

Definition at line 213 of file CHokuyoURG.h.

References m_ip_dir, and m_port_dir.

◆ setMotorSpeed()

bool CHokuyoURG::setMotorSpeed ( int motoSpeed_rpm )

private

Changes the motor speed in rpm's (default 600rpm)

Returns: false on any error

Definition at line 727 of file CHokuyoURG.cpp.

References checkCOMisOpen(), mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, MRPT_LOG_DEBUG, MRPT_LOG_DEBUG_FMT, receiveResponse(), mrpt::system::os::sprintf(), and mrpt::utils::CStream::WriteBuffer().

Referenced by turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPathForExternalImages()

virtual void mrpt::hwdrivers::CGenericSensor::setPathForExternalImages ( const std::string & directory )

inlinevirtualinherited

Set the path where to save off-rawlog image files (will be ignored in those sensors where this is not applicable).

An empty string (the default value at construction) means to save images embedded in the rawlog, instead of on separate files.

Exceptions

std::exception If the directory doesn't exists and cannot be created.

Reimplemented in mrpt::hwdrivers::CCameraSensor, mrpt::hwdrivers::CKinect, mrpt::hwdrivers::COpenNI2Sensor, mrpt::hwdrivers::COpenNI2_RGBD360, and mrpt::hwdrivers::CSwissRanger3DCamera.

Definition at line 268 of file CGenericSensor.h.

References MRPT_UNUSED_PARAM.

◆ setReducedFOV()

void mrpt::hwdrivers::CHokuyoURG::setReducedFOV ( const double fov )

inline

If called (before calling "turnOn"), the field of view of the laser is reduced to the given range (in radians), discarding the rest of measures.

Call with "0" to disable this reduction again (the default).

Definition at line 225 of file CHokuyoURG.h.

References m_reduced_fov.

◆ setSensorLabel()

void mrpt::hwdrivers::CGenericSensor::setSensorLabel ( const std::string & sensorLabel )

inlineinherited

Definition at line 96 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor::m_sensorLabel.

◆ setSerialPort()

void mrpt::hwdrivers::CHokuyoURG::setSerialPort ( const std::string & port_name )

inline

If set to non-empty, the serial port will be attempted to be opened automatically when this class is first used to request data from the laser.

Definition at line 211 of file CHokuyoURG.h.

References m_com_port.

◆ showPreview()

void mrpt::hwdrivers::C2DRangeFinderAbstract::showPreview ( bool enable = true )

inlineinherited

Enables GUI visualization in real-time.

Definition at line 120 of file C2DRangeFinderAbstract.h.

References mrpt::hwdrivers::C2DRangeFinderAbstract::m_showPreview.

◆ startScanningMode()

bool CHokuyoURG::startScanningMode ( )

private

Start the scanning mode, using parameters stored in the object (loaded from the .ini file) After this command the device will start to send scans until "switchLaserOff" is called.

Returns: false on any error

Definition at line 998 of file CHokuyoURG.cpp.

References checkCOMisOpen(), m_firstRange, m_intensity, m_lastRange, m_lastSentMeasCmd, mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, MRPT_LOG_DEBUG, receiveResponse(), mrpt::system::os::sprintf(), and mrpt::utils::CStream::WriteBuffer().

Referenced by turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ switchLaserOff()

bool CHokuyoURG::switchLaserOff ( )

private

Switchs the laser off.

Returns: false on any error

Definition at line 687 of file CHokuyoURG.cpp.

References checkCOMisOpen(), mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, MRPT_LOG_DEBUG, receiveResponse(), mrpt::system::os::strcpy(), and mrpt::utils::CStream::WriteBuffer().

Referenced by turnOff(), and turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ switchLaserOn()

bool CHokuyoURG::switchLaserOn ( )

private

Switchs the laser on.

Returns: false on any error

Definition at line 646 of file CHokuyoURG.cpp.

References checkCOMisOpen(), mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, MRPT_LOG_DEBUG, receiveResponse(), mrpt::system::os::strcpy(), and mrpt::utils::CStream::WriteBuffer().

Referenced by turnOn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ turnOff()

bool CHokuyoURG::turnOff ( )

virtual

Disables the scanning mode (this can be used to turn the device in low energy mode, if available)

Returns: If everything works "true", or "false" if there is any error.

Implements mrpt::hwdrivers::C2DRangeFinderAbstract.

Definition at line 379 of file CHokuyoURG.cpp.

References switchLaserOff().

Referenced by ~CHokuyoURG().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ turnOn()

bool CHokuyoURG::turnOn ( )

virtual

Enables the scanning mode (which may depend on the specific laser device); this must be called before asking for observations to assure that the protocol has been initializated.

Returns: If everything works "true", or "false" if there is any error.

Implements mrpt::hwdrivers::C2DRangeFinderAbstract.

Definition at line 269 of file CHokuyoURG.cpp.

References checkCOMisOpen(), displaySensorInfo(), displayVersionInfo(), enableSCIP20(), m_firstRange, m_highSensMode, m_ip_dir, m_lastRange, m_motorSpeed_rpm, M_PI, m_reduced_fov, m_sensor_info, mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream, MRPT_END, MRPT_START, mrpt::comms::CSerialPort::purgeBuffers(), purgeBuffers(), RAD2DEG, mrpt::hwdrivers::CHokuyoURG::TSensorInfo::scan_first, mrpt::hwdrivers::CHokuyoURG::TSensorInfo::scan_last, mrpt::hwdrivers::CHokuyoURG::TSensorInfo::scans_per_360deg, mrpt::comms::CSerialPort::setConfig(), setHighBaudrate(), setHighSensitivityMode(), setMotorSpeed(), mrpt::comms::CSerialPort::setTimeouts(), startScanningMode(), switchLaserOff(), and switchLaserOn().

Referenced by checkCOMisOpen(), and initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_com_port

std::string mrpt::hwdrivers::CHokuyoURG::m_com_port

protected

If set to non-empty, the serial port will be attempted to be opened automatically when this class is first used to request data from the laser.

Definition at line 249 of file CHokuyoURG.h.

Referenced by checkCOMisOpen(), getSerialPort(), loadConfig_sensorSpecific(), and setSerialPort().

◆ m_disable_firmware_timestamp

bool mrpt::hwdrivers::CHokuyoURG::m_disable_firmware_timestamp

protected

Definition at line 269 of file CHokuyoURG.h.

Referenced by doProcessSimple(), and loadConfig_sensorSpecific().

◆ m_external_images_format

std::string mrpt::hwdrivers::CGenericSensor::m_external_images_format

protectedinherited

The extension ("jpg","gif","png",...) that determines the format of images saved externally.

See also: setPathForExternalImages

Definition at line 158 of file CGenericSensor.h.

Referenced by mrpt::hwdrivers::CSwissRanger3DCamera::getNextObservation(), mrpt::hwdrivers::CSwissRanger3DCamera::loadConfig_sensorSpecific(), and mrpt::hwdrivers::CGenericSensor::setExternalImageFormat().

◆ m_external_images_jpeg_quality

unsigned int mrpt::hwdrivers::CGenericSensor::m_external_images_jpeg_quality

protectedinherited

For JPEG images, the quality (default=95%).

Definition at line 160 of file CGenericSensor.h.

Referenced by mrpt::hwdrivers::CGenericSensor::getExternalImageJPEGQuality(), mrpt::hwdrivers::CSwissRanger3DCamera::getNextObservation(), mrpt::hwdrivers::CSwissRanger3DCamera::loadConfig_sensorSpecific(), and mrpt::hwdrivers::CGenericSensor::setExternalImageJPEGQuality().

◆ m_firstRange

int mrpt::hwdrivers::CHokuyoURG::m_firstRange

private

The first and last ranges to consider from the scan.

Definition at line 94 of file CHokuyoURG.h.

Referenced by doProcessSimple(), startScanningMode(), and turnOn().

◆ m_grab_decimation

size_t mrpt::hwdrivers::CGenericSensor::m_grab_decimation

protectedinherited

If set to N>=2, only 1 out of N observations will be saved to m_objList.

Definition at line 139 of file CGenericSensor.h.

Referenced by mrpt::hwdrivers::CGenericSensor::appendObservations(), and mrpt::hwdrivers::CGenericSensor::loadConfig().

◆ m_grab_decimation_counter

size_t mrpt::hwdrivers::CGenericSensor::m_grab_decimation_counter

protectedinherited

Used when "m_grab_decimation" is enabled.

Definition at line 146 of file CGenericSensor.h.

Referenced by mrpt::hwdrivers::CGenericSensor::appendObservations(), and mrpt::hwdrivers::CGenericSensor::loadConfig().

◆ m_highSensMode

bool mrpt::hwdrivers::CHokuyoURG::m_highSensMode

private

High sensitivity [HS] mode (default: false)

Definition at line 106 of file CHokuyoURG.h.

Referenced by loadConfig_sensorSpecific(), and turnOn().

◆ m_I_am_owner_serial_port

bool mrpt::hwdrivers::CHokuyoURG::m_I_am_owner_serial_port

protected

Definition at line 261 of file CHokuyoURG.h.

Referenced by checkCOMisOpen(), and ~CHokuyoURG().

◆ m_intensity

bool mrpt::hwdrivers::CHokuyoURG::m_intensity

protected

Get intensity from lidar scan (default: false)

Definition at line 271 of file CHokuyoURG.h.

Referenced by doProcessSimple(), loadConfig_sensorSpecific(), setIntensityMode(), and startScanningMode().

◆ m_ip_dir

std::string mrpt::hwdrivers::CHokuyoURG::m_ip_dir

protected

If set to non-empty and m_port_dir too, the program will try to connect to a Hokuyo using Ethernet communication.

Definition at line 253 of file CHokuyoURG.h.

Referenced by assureBufferHasBytes(), checkCOMisOpen(), loadConfig_sensorSpecific(), purgeBuffers(), setIPandPort(), and turnOn().

◆ m_lastRange

int mrpt::hwdrivers::CHokuyoURG::m_lastRange

private

Definition at line 94 of file CHokuyoURG.h.

Referenced by doProcessSimple(), startScanningMode(), and turnOn().

◆ m_lastSentMeasCmd

std::string mrpt::hwdrivers::CHokuyoURG::m_lastSentMeasCmd

private

The last sent measurement command (MDXXX), including the last 0x0A.

Definition at line 103 of file CHokuyoURG.h.

Referenced by doProcessSimple(), and startScanningMode().

◆ m_max_queue_len

size_t mrpt::hwdrivers::CGenericSensor::m_max_queue_len

protectedinherited

See CGenericSensor.

Definition at line 136 of file CGenericSensor.h.

Referenced by mrpt::hwdrivers::CGenericSensor::loadConfig().

◆ m_motorSpeed_rpm

int mrpt::hwdrivers::CHokuyoURG::m_motorSpeed_rpm

private

The motor speed (default=600rpm)

Definition at line 96 of file CHokuyoURG.h.

Referenced by loadConfig_sensorSpecific(), and turnOn().

◆ m_path_for_external_images

std::string mrpt::hwdrivers::CGenericSensor::m_path_for_external_images

protectedinherited

The path where to save off-rawlog images: empty means save images embedded in the rawlog.

Definition at line 155 of file CGenericSensor.h.

Referenced by mrpt::hwdrivers::CSwissRanger3DCamera::getNextObservation(), and mrpt::hwdrivers::CSwissRanger3DCamera::setPathForExternalImages().

◆ m_port_dir

unsigned int mrpt::hwdrivers::CHokuyoURG::m_port_dir

protected

If set to non-empty and m_ip_dir too, the program will try to connect to a Hokuyo using Ethernet communication.

Definition at line 256 of file CHokuyoURG.h.

Referenced by checkCOMisOpen(), loadConfig_sensorSpecific(), and setIPandPort().

◆ m_process_rate

double mrpt::hwdrivers::CGenericSensor::m_process_rate

protectedinherited

See CGenericSensor.

Definition at line 134 of file CGenericSensor.h.

Referenced by mrpt::hwdrivers::CGenericSensor::getProcessRate(), mrpt::hwdrivers::CGyroKVHDSP3000::initialize(), and mrpt::hwdrivers::CGenericSensor::loadConfig().

◆ m_reduced_fov

double mrpt::hwdrivers::CHokuyoURG::m_reduced_fov

protected

Used to reduce artificially the interval of scan ranges.

Definition at line 244 of file CHokuyoURG.h.

Referenced by loadConfig_sensorSpecific(), setReducedFOV(), and turnOn().

◆ m_rx_buffer

mrpt::utils::circular_buffer<uint8_t> mrpt::hwdrivers::CHokuyoURG::m_rx_buffer

private

Auxiliary buffer for readings.

Definition at line 100 of file CHokuyoURG.h.

Referenced by assureBufferHasBytes(), and receiveResponse().

◆ m_sensor_info

TSensorInfo mrpt::hwdrivers::CHokuyoURG::m_sensor_info

protected

The information gathered when the laser is first open.

Definition at line 259 of file CHokuyoURG.h.

Referenced by doProcessSimple(), and turnOn().

◆ m_sensorLabel

std::string mrpt::hwdrivers::CGenericSensor::m_sensorLabel

protectedinherited

See CGenericSensor.

Definition at line 141 of file CGenericSensor.h.

◆ m_sensorPose

poses::CPose3D mrpt::hwdrivers::CHokuyoURG::m_sensorPose

private

The sensor 6D pose:

Definition at line 98 of file CHokuyoURG.h.

Referenced by doProcessSimple(), and loadConfig_sensorSpecific().

◆ m_state

TSensorState mrpt::hwdrivers::CGenericSensor::m_state

protectedinherited

Definition at line 148 of file CGenericSensor.h.

◆ m_stream

utils::CStream* mrpt::hwdrivers::C2DRangeFinderAbstract::m_stream

protectedinherited

The I/O channel (will be nullptr if not bound).

Definition at line 72 of file C2DRangeFinderAbstract.h.

◆ m_timeStartSynchDelay

int mrpt::hwdrivers::CHokuyoURG::m_timeStartSynchDelay

protected

Counter to discard to first few packets before setting the correspondence between device and computer timestamps.

Definition at line 267 of file CHokuyoURG.h.

Referenced by doProcessSimple().

◆ m_timeStartTT

mrpt::system::TTimeStamp mrpt::hwdrivers::CHokuyoURG::m_timeStartTT

protected

Definition at line 268 of file CHokuyoURG.h.

Referenced by doProcessSimple().

◆ m_timeStartUI

uint32_t mrpt::hwdrivers::CHokuyoURG::m_timeStartUI

protected

Time of the first data packet, for synchronization purposes.

Definition at line 264 of file CHokuyoURG.h.

Referenced by doProcessSimple().

◆ m_verbose

bool mrpt::hwdrivers::CGenericSensor::m_verbose

protectedinherited

Definition at line 149 of file CGenericSensor.h.

◆ m_win

mrpt::gui::CDisplayWindow3D::Ptr mrpt::hwdrivers::CHokuyoURG::m_win

private

Definition at line 107 of file CHokuyoURG.h.

Referenced by ~CHokuyoURG().

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ Ptr

◆ TListObservations

◆ TListObsPair

Member Enumeration Documentation

◆ TSensorState

Constructor & Destructor Documentation

◆ CHokuyoURG()

◆ ~CHokuyoURG()

Member Function Documentation

◆ appendObservation()

◆ appendObservations()

◆ assureBufferHasBytes()

◆ bindIO()

◆ checkCOMisOpen()

◆ createSensor()

◆ createSensorPtr()

◆ displaySensorInfo()

◆ displayVersionInfo()

◆ doProcess()

◆ doProcessSimple()

◆ enableSCIP20()

◆ enableVerbose()

◆ filterByExclusionAngles()

◆ filterByExclusionAreas()

◆ getExternalImageJPEGQuality()

◆ getObservation()

◆ getObservations()

◆ getProcessRate()

◆ GetRuntimeClass()

◆ getSensorLabel()

◆ getSerialPort()

◆ getState()

◆ initialize()

◆ isVerboseEnabled()

◆ loadCommonParams()

◆ loadConfig()

◆ loadConfig_sensorSpecific()

◆ processPreview()

◆ purgeBuffers()

◆ receiveResponse()

◆ registerClass()

◆ setExternalImageFormat()

◆ setExternalImageJPEGQuality()

◆ setHighBaudrate()

◆ setHighSensitivityMode()

◆ setIntensityMode()

◆ setIPandPort()

◆ setMotorSpeed()

◆ setPathForExternalImages()

◆ setReducedFOV()

◆ setSensorLabel()

◆ setSerialPort()

◆ showPreview()

◆ startScanningMode()

◆ switchLaserOff()

◆ switchLaserOn()

◆ turnOff()

◆ turnOn()

Member Data Documentation

◆ m_com_port

◆ m_disable_firmware_timestamp

◆ m_external_images_format

◆ m_external_images_jpeg_quality

◆ m_firstRange

◆ m_grab_decimation

◆ m_grab_decimation_counter

◆ m_highSensMode

◆ m_I_am_owner_serial_port

◆ m_intensity

◆ m_ip_dir