Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
mrpt::hwdrivers::CBoardIR Class Referenceabstract

Detailed Description

A parser of NMEA commands, for connecting to a GPS by a serial port.

This class also supports more advanced GPS equipped with RTK corrections. See the JAVAD/TopCon extra initialization parameters.

PARAMETERS IN THE ".INI"-LIKE CONFIGURATION STRINGS:
-------------------------------------------------------
[supplied_section_name]
COM_port_WIN = COM3
COM_port_LIN = ttyS0
baudRate = 4800 // The baudrate of the communications (typ. 4800 bauds)
pose_x = 0 // 3D position of the sensed point relative to the robot (meters)
pose_y = 0
pose_z = 0
customInit = // See below for possible values
// The next parameters are optional and will be used only
// if customInit=="JAVAD" to enable/configure the usage of RTK corrections:
//JAVAD_rtk_src_port=/dev/ser/b
//JAVAD_rtk_src_baud=9600
//JAVAD_rtk_format=cmr

Definition at line 58 of file CBoardIR.h.

#include <mrpt/hwdrivers/CBoardIR.h>

Inheritance diagram for mrpt::hwdrivers::CBoardIR:
Inheritance graph

Public Types

enum  TSensorState { ssInitializing = 0, ssWorking, ssError }
 The current state of the sensor. More...
 
typedef std::multimap< mrpt::system::TTimeStamp, mrpt::utils::CSerializablePtr > TListObservations
 
typedef std::pair< mrpt::system::TTimeStamp, mrpt::utils::CSerializablePtr > TListObsPair
 

Public Member Functions

 CBoardIR (int BUFFER_LENGTH=13)
 Constructor. More...
 
virtual ~CBoardIR ()
 Destructor. More...
 
void getObservation (bool &outThereIsObservation, mrpt::obs::CObservationRange &outObservation, bool &hardwareError)
 This method tries to get a set of range measurements from the IR sensors. More...
 
void doProcess ()
 This method will be invoked at a minimum rate of "process_rate" (Hz) More...
 
void setSerialPortName (const std::string &COM_port)
 Set the serial port to use (COM1, ttyUSB0, etc). More...
 
std::string getSerialPortName () const
 Get the serial port to use (COM1, ttyUSB0, etc). More...
 
virtual const mrpt::hwdrivers::TSensorClassIdGetRuntimeClass () 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...
 
virtual void initialize ()
 This method can or cannot be implemented in the derived class, depending on the need for it. 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 printf_debug (const char *frmt,...)
 Sends a formated text to "debugOut" if not NULL, or to cout otherwise. More...
 
static void registerClass (const TSensorClassId *pNewClass)
 Register a class into the internal list of "CGenericSensor" descendents. More...
 
static CGenericSensorcreateSensor (const std::string &className)
 Creates a sensor by a name of the class. More...
 
static CGenericSensorPtr createSensorPtr (const std::string &className)
 Just like createSensor, but returning a smart pointer to the newly created sensor object. More...
 

Protected Member Functions

bool OnConnectionEstablished ()
 
void loadConfig_sensorSpecific (const mrpt::utils::CConfigFileBase &configSource, const std::string &iniSection)
 See the class documentation at the top for expected parameters. More...
 
void appendObservations (const std::vector< mrpt::utils::CSerializablePtr > &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::CSerializablePtr &obj)
 Like appendObservations() but for just one observation. More...
 

Protected Attributes

CSerialPort m_COM
 
poses::CPoint3D m_sensorPose
 
std::string m_customInit
 
float m_minRange
 The minimum range in meters (10cm). More...
 
float m_maxRange
 The maximum range in meters (80cm). More...
 
std::map< uint16_t, mrpt::math::TPose3Dm_IRPoses
 The poses of the IR: x[m] y[m] z[m] yaw[deg] pitch[deg] roll[deg] Up to 6 devices, but you can put any number of devices (from 1 to 6). 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 tryToOpenTheCOM ()
 Returns true if the COM port is already open, or try to open it in other case. More...
 

Private Attributes

std::string m_COMname
 
int m_COMbauds
 

Member Typedef Documentation

◆ TListObservations

typedef std::multimap< mrpt::system::TTimeStamp, mrpt::utils::CSerializablePtr > mrpt::hwdrivers::CGenericSensor::TListObservations
inherited

Definition at line 68 of file CGenericSensor.h.

◆ TListObsPair

typedef std::pair< mrpt::system::TTimeStamp, mrpt::utils::CSerializablePtr > mrpt::hwdrivers::CGenericSensor::TListObsPair
inherited

Definition at line 69 of file CGenericSensor.h.

Member Enumeration Documentation

◆ TSensorState

The current state of the sensor.

See also
CGenericSensor::getState
Enumerator
ssInitializing 
ssWorking 
ssError 

Definition at line 74 of file CGenericSensor.h.

Constructor & Destructor Documentation

◆ CBoardIR()

mrpt::hwdrivers::CBoardIR::CBoardIR ( int  BUFFER_LENGTH = 13)

Constructor.

Parameters
BUFFER_LENGTHThe size of the communications buffer (default value should be fine always)

◆ ~CBoardIR()

virtual mrpt::hwdrivers::CBoardIR::~CBoardIR ( )
virtual

Destructor.

Member Function Documentation

◆ appendObservation()

void mrpt::hwdrivers::CGenericSensor::appendObservation ( const mrpt::utils::CSerializablePtr &  obj)
inlineprotectedinherited

Like appendObservations() but for just one observation.

Definition at line 146 of file CGenericSensor.h.

◆ appendObservations()

void mrpt::hwdrivers::CGenericSensor::appendObservations ( const std::vector< mrpt::utils::CSerializablePtr > &  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::CObservationGPSPtr o = CObservationGPSPtr( new CObservationGPS() );
o-> .... // Set data

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

◆ createSensor()

static CGenericSensor* mrpt::hwdrivers::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:

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

◆ createSensorPtr()

static CGenericSensorPtr 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 179 of file CGenericSensor.h.

References mrpt::hwdrivers::CGenericSensor.

◆ doProcess()

void mrpt::hwdrivers::CBoardIR::doProcess ( )
virtual

This method will be invoked at a minimum rate of "process_rate" (Hz)

Exceptions
Thismethod must throw an exception with a descriptive message if some critical error is found.

Implements mrpt::hwdrivers::CGenericSensor.

◆ 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 92 of file CGenericSensor.h.

◆ getExternalImageJPEGQuality()

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

Definition at line 233 of file CGenericSensor.h.

References MRPT_MAKE_ALIGNED_OPERATOR_NEW.

◆ getObservation()

void mrpt::hwdrivers::CBoardIR::getObservation ( bool &  outThereIsObservation,
mrpt::obs::CObservationRange outObservation,
bool &  hardwareError 
)

This method tries to get a set of range measurements from the IR sensors.

Parameters
outObservationThe output observation
outThereIsObservationWill be true if an observation was sucessfully received.
hardwareErrorWill be true if there's some important error, e.g. serial port can't be open.

◆ getObservations()

void mrpt::hwdrivers::CGenericSensor::getObservations ( TListObservations lstObjects)
inherited

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

The objects must be freed by the invoker.

◆ getProcessRate()

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

Definition at line 84 of file CGenericSensor.h.

◆ 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 86 of file CGenericSensor.h.

◆ getSerialPortName()

std::string mrpt::hwdrivers::CBoardIR::getSerialPortName ( ) const

Get the serial port to use (COM1, ttyUSB0, etc).

◆ getState()

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

The current state of the sensor.

Definition at line 82 of file CGenericSensor.h.

◆ initialize()

virtual void mrpt::hwdrivers::CGenericSensor::initialize ( )
inlinevirtualinherited

◆ isVerboseEnabled()

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

Definition at line 93 of file CGenericSensor.h.

References mrpt::utils::registerClass().

◆ loadConfig()

void mrpt::hwdrivers::CGenericSensor::loadConfig ( const mrpt::utils::CConfigFileBase configSource,
const std::string &  section 
)
inherited

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

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

◆ loadConfig_sensorSpecific()

void mrpt::hwdrivers::CBoardIR::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.

◆ OnConnectionEstablished()

bool mrpt::hwdrivers::CBoardIR::OnConnectionEstablished ( )
protected

◆ printf_debug()

static void mrpt::utils::CDebugOutputCapable::printf_debug ( const char *  frmt,
  ... 
)
staticinherited

Sends a formated text to "debugOut" if not NULL, or to cout otherwise.

Referenced by mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute().

◆ registerClass()

static void mrpt::hwdrivers::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.

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

◆ 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 225 of file CGenericSensor.h.

◆ 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 230 of file CGenericSensor.h.

◆ 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::exceptionIf 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 216 of file CGenericSensor.h.

References MRPT_UNUSED_PARAM.

◆ setSensorLabel()

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

Definition at line 87 of file CGenericSensor.h.

◆ setSerialPortName()

void mrpt::hwdrivers::CBoardIR::setSerialPortName ( const std::string &  COM_port)

Set the serial port to use (COM1, ttyUSB0, etc).

◆ tryToOpenTheCOM()

bool mrpt::hwdrivers::CBoardIR::tryToOpenTheCOM ( )
private

Returns true if the COM port is already open, or try to open it in other case.

Returns
true if everything goes OK, or false if there are problems opening the port.

Member Data Documentation

◆ m_COM

CSerialPort mrpt::hwdrivers::CBoardIR::m_COM
protected

Definition at line 91 of file CBoardIR.h.

◆ m_COMbauds

int mrpt::hwdrivers::CBoardIR::m_COMbauds
private

Definition at line 117 of file CBoardIR.h.

◆ m_COMname

std::string mrpt::hwdrivers::CBoardIR::m_COMname
private

Definition at line 116 of file CBoardIR.h.

◆ m_customInit

std::string mrpt::hwdrivers::CBoardIR::m_customInit
protected

Definition at line 95 of file CBoardIR.h.

◆ 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 130 of file CGenericSensor.h.

◆ 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 131 of file CGenericSensor.h.

◆ 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 117 of file CGenericSensor.h.

◆ m_grab_decimation_counter

size_t mrpt::hwdrivers::CGenericSensor::m_grab_decimation_counter
protectedinherited

Used when "m_grab_decimation" is enabled.

Definition at line 122 of file CGenericSensor.h.

◆ m_IRPoses

std::map<uint16_t,mrpt::math::TPose3D> mrpt::hwdrivers::CBoardIR::m_IRPoses
protected

The poses of the IR: x[m] y[m] z[m] yaw[deg] pitch[deg] roll[deg] Up to 6 devices, but you can put any number of devices (from 1 to 6).

Definition at line 108 of file CBoardIR.h.

◆ m_max_queue_len

size_t mrpt::hwdrivers::CGenericSensor::m_max_queue_len
protectedinherited

See CGenericSensor.

Definition at line 116 of file CGenericSensor.h.

◆ m_maxRange

float mrpt::hwdrivers::CBoardIR::m_maxRange
protected

The maximum range in meters (80cm).

Definition at line 103 of file CBoardIR.h.

◆ m_minRange

float mrpt::hwdrivers::CBoardIR::m_minRange
protected

The minimum range in meters (10cm).

Definition at line 99 of file CBoardIR.h.

◆ 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 129 of file CGenericSensor.h.

◆ m_process_rate

double mrpt::hwdrivers::CGenericSensor::m_process_rate
protectedinherited

See CGenericSensor.

Definition at line 115 of file CGenericSensor.h.

◆ m_sensorLabel

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

See CGenericSensor.

Definition at line 118 of file CGenericSensor.h.

◆ m_sensorPose

poses::CPoint3D mrpt::hwdrivers::CBoardIR::m_sensorPose
protected

Definition at line 93 of file CBoardIR.h.

◆ m_state

TSensorState mrpt::hwdrivers::CGenericSensor::m_state
protectedinherited

Definition at line 124 of file CGenericSensor.h.

◆ m_verbose

bool mrpt::hwdrivers::CGenericSensor::m_verbose
protectedinherited

Definition at line 125 of file CGenericSensor.h.




Page generated by Doxygen 1.8.13 for MRPT 1.4.0 SVN: at Sat Sep 2 18:44:07 UTC 2017