Detailed Description

A class for interfacing an e-Noses via a FTDI USB link.

Implemented for the board v1.0 designed by 2007 @ ISA (University of Malaga).

 PARAMETERS IN THE ".INI"-LIKE CONFIGURATION STRINGS:
-------------------------------------------------------
  [supplied_section_name]
   USB_serialname=ENOSE001   // USB FTDI pipe: will open only if COM_port_* are not set or empty
   COM_port_WIN = COM1       // Serial port to connect to.
   COM_port_LIN = ttyS0
   COM_baudRate = 115200
   ; 3D position (in meters) of the master +slave eNoses
   enose_poses_x=<MASTER X> <SLAVE#1 X> <SLAVE#2 X> <SLAVE#3 X>...
   enose_poses_y=<MASTER Y> <SLAVE#1 Y> <SLAVE#2 Y> <SLAVE#3 Y>...
   enose_poses_z=<MASTER Z> <SLAVE#1 Z> <SLAVE#2 Z> <SLAVE#3 Z>...
   ; 3D pose angles (in degrees) of the master +slave eNoses
   enose_poses_yaw=<MASTER YAW> <SLAVE#1 YAW> <SLAVE#2 YAW> <SLAVE#3 YAW>...
   enose_poses_pitch=<MASTER PITCH> <SLAVE#1 PITCH> <SLAVE#2 PITCH> <SLAVE#3 PITCH>...
   enose_poses_roll=<MASTER ROLL> <SLAVE#1 ROLL> <SLAVE#2 ROLL> <SLAVE#3 ROLL>...

Definition at line 53 of file CBoardENoses.h.

#include <mrpt/hwdrivers/CBoardENoses.h>

Inheritance diagram for mrpt::hwdrivers::CBoardENoses:

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

typedef CGenericSensorPtr	Ptr

typedef std::shared_ptr< const CGenericSensor >	ConstPtr

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

virtual	~CBoardENoses ()
	Destructor. More...

bool	setActiveChamber (unsigned char chamber)
	Set the active chamber (afected by poluted air) on the device. More...

bool	queryFirmwareVersion (std::string &out_firmwareVersion)
	Query the firmware version on the device (can be used to test communications). More...

bool	getObservation (mrpt::obs::CObservationGasSensors &outObservation)
	Request the master eNose the latest readings from all the eNoses. More...

void	doProcess ()
	This method should be called periodically (at least at 1Hz to capture ALL the real-time data) It is thread safe, i.e. More...

virtual void	initialize ()
	Tries to open the camera, after setting all the parameters with a call to loadConfig. More...

void	setSerialPort (const std::string &port)
	If not an empty string, will open that serial port, otherwise will try to open USB FTDI device "m_usbSerialNumber" The default is an empty string. More...

std::string	getSerialPort () const

void	setSerialPortBaud (unsigned int baud)
	Set the serial port baud rate (default: 115200) More...

unsigned int	getSerialPortBaud () const

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 CGenericSensorPtr	createSensorPtr (const std::string &className)
	Just like createSensor, but returning a smart pointer to the newly created sensor object. More...

Protected Member Functions
mrpt::utils::CStream *	checkConnectionAndConnect ()
	Tries to connect to the USB device (if disconnected). More...

void	loadConfig_sensorSpecific (const mrpt::utils::CConfigFileBase &configSource, const std::string &section)
	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
std::string	m_usbSerialNumber
	A copy of the device serial number (to open the USB FTDI chip) More...

mrpt::system::TTimeStamp	initial_timestamp

bool	first_reading

std::string	m_COM_port
	If not an empty string (default), will open that serial port, otherwise will try to open USB FTDI device "m_usbSerialNumber". More...

unsigned int	m_COM_baud
	Default=115200. More...

CInterfaceFTDI *	m_stream_FTDI
	FTDI comms pipe (when not in serial port mode) More...

CSerialPort *	m_stream_SERIAL
	Serial port comms. More...

std::vector< float >	enose_poses_x
	The 3D pose of the master + N slave eNoses on the robot (meters & radians) More...

std::vector< float >	enose_poses_y

std::vector< float >	enose_poses_z

std::vector< float >	enose_poses_yaw

std::vector< float >	enose_poses_pitch

std::vector< float >	enose_poses_roll

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...

Member Typedef Documentation

◆ ConstPtr

typedef std::shared_ptr<const CGenericSensor> mrpt::hwdrivers::CGenericSensor::ConstPtr

inherited

Definition at line 124 of file CGenericSensor.h.

◆ Ptr

typedef CGenericSensorPtr mrpt::hwdrivers::CGenericSensor::Ptr

inherited

Definition at line 123 of file CGenericSensor.h.

◆ TListObservations

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

inherited

Definition at line 89 of file CGenericSensor.h.

◆ TListObsPair

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

inherited

Definition at line 90 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 95 of file CGenericSensor.h.

Constructor & Destructor Documentation

◆ CBoardENoses()

CBoardENoses::CBoardENoses ( )

Constructor.

Parameters

serialNumberUSBdevice The serial number (text) of the device to open. The constructor will try to open the device. You can check if it failed calling "isOpen()".

Definition at line 29 of file CBoardENoses.cpp.

◆ ~CBoardENoses()

CBoardENoses::~CBoardENoses ( )

virtual

Destructor.

Definition at line 40 of file CBoardENoses.cpp.

References mrpt::utils::delete_safe().

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

◆ appendObservations()

void 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
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::CNationalInstrumentsDAQ::doProcess(), and mrpt::hwdrivers::CKinect::doProcess().

◆ checkConnectionAndConnect()

CStream * CBoardENoses::checkConnectionAndConnect ( )

protected

Tries to connect to the USB device (if disconnected).

Returns: NULL on error, otherwise a stream to be used for comms.

Definition at line 125 of file CBoardENoses.cpp.

References ASSERT_, and mrpt::system::sleep().

◆ 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:

CGenericSensorPtr sensor = CGenericSensorPtr( CGenericSensor::createSensor("XXX") );

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

Definition at line 103 of file CGenericSensor.cpp.

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

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

◆ doProcess()

void CBoardENoses::doProcess ( )

virtual

This method should be called periodically (at least at 1Hz to capture ALL the real-time data) It is thread safe, i.e.

you can call this from one thread, then to other methods from other threads.

Implements mrpt::hwdrivers::CGenericSensor.

Definition at line 359 of file CBoardENoses.cpp.

References mrpt::obs::utils::getObservation().

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

◆ getExternalImageJPEGQuality()

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

inlineinherited

Definition at line 255 of file CGenericSensor.h.

◆ getObservation()

bool CBoardENoses::getObservation ( mrpt::obs::CObservationGasSensors & outObservation )

Request the master eNose the latest readings from all the eNoses.

The output observation contains a valid timestamp and 3D positions if "loadConfig" has been called previously.

Returns: true if OK, false if there were any error.

Definition at line 184 of file CBoardENoses.cpp.

References ASSERT_, mrpt::utils::CMessage::content, mrpt::obs::CObservationGasSensors::TObservationENose::eNosePoseOnTheRobot, mrpt::system::getCurrentTime(), mrpt::obs::CObservationGasSensors::TObservationENose::hasTemperature, mrpt::obs::CObservationGasSensors::TObservationENose::isActive, mrpt::obs::CObservationGasSensors::m_readings, mrpt::system::os::memcpy(), mrpt::obs::CObservationGasSensors::TObservationENose::readingsVoltage, mrpt::utils::CStream::receiveMessage(), mrpt::system::secondsToTimestamp(), mrpt::obs::CObservation::sensorLabel, mrpt::obs::CObservationGasSensors::TObservationENose::sensorTypes, mrpt::obs::CObservationGasSensors::TObservationENose::temperature, and mrpt::obs::CObservation::timestamp.

◆ 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 90 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 105 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 107 of file CGenericSensor.h.

◆ getSerialPort()

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

inline

Definition at line 129 of file CBoardENoses.h.

◆ getSerialPortBaud()

unsigned int mrpt::hwdrivers::CBoardENoses::getSerialPortBaud ( ) const

inline

Definition at line 133 of file CBoardENoses.h.

◆ getState()

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

inlineinherited

The current state of the sensor.

Definition at line 103 of file CGenericSensor.h.

◆ initialize()

void CBoardENoses::initialize ( void )

virtual

Tries to open the camera, after setting all the parameters with a call to loadConfig.

Exceptions

This	method must throw an exception with a descriptive message if some critical error is found.

Reimplemented from mrpt::hwdrivers::CGenericSensor.

Definition at line 382 of file CBoardENoses.cpp.

◆ isVerboseEnabled()

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

inlineinherited

Definition at line 114 of file CGenericSensor.h.

◆ 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 131 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().

Referenced by mrpt::hwdrivers::prepareVideoSourceFromPanel(), and mrpt::hwdrivers::prepareVideoSourceFromUserSelection().

◆ loadConfig_sensorSpecific()

void CBoardENoses::loadConfig_sensorSpecific	(	const mrpt::utils::CConfigFileBase &	configSource,
		const std::string &	section
	)

protectedvirtual

See the class documentation at the top for expected parameters.

Implements mrpt::hwdrivers::CGenericSensor.

Definition at line 49 of file CBoardENoses.cpp.

References ASSERT_, M_PIf, MRPT_END, MRPT_START, mrpt::utils::CConfigFileBase::read_string(), mrpt::utils::CConfigFileBase::read_uint64_t(), and mrpt::utils::CConfigFileBase::read_vector().

◆ queryFirmwareVersion()

bool CBoardENoses::queryFirmwareVersion ( std::string & out_firmwareVersion )

Query the firmware version on the device (can be used to test communications).

Returns: true on success, false on communications errors or device not found.

Definition at line 90 of file CBoardENoses.cpp.

References mrpt::utils::delete_safe(), mrpt::utils::CMessage::getContentAsString(), mrpt::utils::CStream::receiveMessage(), mrpt::utils::CStream::sendMessage(), and mrpt::utils::CMessage::type.

◆ 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 120 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().

◆ setActiveChamber()

bool CBoardENoses::setActiveChamber ( unsigned char chamber )

Set the active chamber (afected by poluted air) on the device.

Send to the MCE-nose the next Active Chamber.

Returns: true on success, false on communications errors or device not found.

Definition at line 397 of file CBoardENoses.cpp.

References mrpt::utils::delete_safe(), and mrpt::utils::CStream::WriteBuffer().

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

References quality.

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

References MRPT_UNUSED_PARAM.

◆ setSensorLabel()

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

inlineinherited

Definition at line 108 of file CGenericSensor.h.

◆ setSerialPort()

void mrpt::hwdrivers::CBoardENoses::setSerialPort ( const std::string & port )

inline

If not an empty string, will open that serial port, otherwise will try to open USB FTDI device "m_usbSerialNumber" The default is an empty string.

Example strings: "COM1", "ttyUSB0", ...

Definition at line 128 of file CBoardENoses.h.

◆ setSerialPortBaud()

void mrpt::hwdrivers::CBoardENoses::setSerialPortBaud ( unsigned int baud )

inline

Set the serial port baud rate (default: 115200)

Definition at line 132 of file CBoardENoses.h.

Member Data Documentation

◆ enose_poses_pitch

std::vector<float> mrpt::hwdrivers::CBoardENoses::enose_poses_pitch

protected

Definition at line 75 of file CBoardENoses.h.

◆ enose_poses_roll

std::vector<float> mrpt::hwdrivers::CBoardENoses::enose_poses_roll

protected

Definition at line 75 of file CBoardENoses.h.

◆ enose_poses_x

std::vector<float> mrpt::hwdrivers::CBoardENoses::enose_poses_x

protected

The 3D pose of the master + N slave eNoses on the robot (meters & radians)

Definition at line 75 of file CBoardENoses.h.

◆ enose_poses_y

std::vector<float> mrpt::hwdrivers::CBoardENoses::enose_poses_y

protected

Definition at line 75 of file CBoardENoses.h.

◆ enose_poses_yaw

std::vector<float> mrpt::hwdrivers::CBoardENoses::enose_poses_yaw

protected

Definition at line 75 of file CBoardENoses.h.

◆ enose_poses_z

std::vector<float> mrpt::hwdrivers::CBoardENoses::enose_poses_z

protected

Definition at line 75 of file CBoardENoses.h.

◆ first_reading

bool mrpt::hwdrivers::CBoardENoses::first_reading

protected

Definition at line 62 of file CBoardENoses.h.

◆ initial_timestamp

mrpt::system::TTimeStamp mrpt::hwdrivers::CBoardENoses::initial_timestamp

protected

Definition at line 61 of file CBoardENoses.h.

◆ m_COM_baud

unsigned int mrpt::hwdrivers::CBoardENoses::m_COM_baud

protected

Default=115200.

Definition at line 65 of file CBoardENoses.h.

◆ m_COM_port

std::string mrpt::hwdrivers::CBoardENoses::m_COM_port

protected

If not an empty string (default), will open that serial port, otherwise will try to open USB FTDI device "m_usbSerialNumber".

Definition at line 64 of file CBoardENoses.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 152 of file CGenericSensor.h.

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

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

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

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

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

◆ m_max_queue_len

size_t mrpt::hwdrivers::CGenericSensor::m_max_queue_len

protectedinherited

See CGenericSensor.

Definition at line 138 of file CGenericSensor.h.

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

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

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

◆ m_process_rate

double mrpt::hwdrivers::CGenericSensor::m_process_rate

protectedinherited

See CGenericSensor.

Definition at line 137 of file CGenericSensor.h.

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

◆ m_sensorLabel

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

protectedinherited

See CGenericSensor.

Definition at line 140 of file CGenericSensor.h.

◆ m_state

TSensorState mrpt::hwdrivers::CGenericSensor::m_state

protectedinherited

Definition at line 146 of file CGenericSensor.h.

◆ m_stream_FTDI

CInterfaceFTDI* mrpt::hwdrivers::CBoardENoses::m_stream_FTDI

protected

FTDI comms pipe (when not in serial port mode)

Definition at line 70 of file CBoardENoses.h.

◆ m_stream_SERIAL

CSerialPort* mrpt::hwdrivers::CBoardENoses::m_stream_SERIAL

protected

Serial port comms.

Definition at line 72 of file CBoardENoses.h.

◆ m_usbSerialNumber

std::string mrpt::hwdrivers::CBoardENoses::m_usbSerialNumber

protected

A copy of the device serial number (to open the USB FTDI chip)

Definition at line 60 of file CBoardENoses.h.

◆ m_verbose

bool mrpt::hwdrivers::CGenericSensor::m_verbose

protectedinherited

Definition at line 147 of file CGenericSensor.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

◆ TListObservations

◆ TListObsPair

Member Enumeration Documentation

◆ TSensorState

Constructor & Destructor Documentation

◆ CBoardENoses()

◆ ~CBoardENoses()

Member Function Documentation

◆ appendObservation()

◆ appendObservations()

◆ checkConnectionAndConnect()

◆ createSensor()

◆ createSensorPtr()

◆ doProcess()

◆ enableVerbose()

◆ getExternalImageJPEGQuality()

◆ getObservation()

◆ getObservations()

◆ getProcessRate()

◆ GetRuntimeClass()

◆ getSensorLabel()

◆ getSerialPort()

◆ getSerialPortBaud()

◆ getState()

◆ initialize()

◆ isVerboseEnabled()

◆ loadConfig()

◆ loadConfig_sensorSpecific()

◆ queryFirmwareVersion()

◆ registerClass()

◆ setActiveChamber()

◆ setExternalImageFormat()

◆ setExternalImageJPEGQuality()

◆ setPathForExternalImages()

◆ setSensorLabel()

◆ setSerialPort()

◆ setSerialPortBaud()

Member Data Documentation

◆ enose_poses_pitch

◆ enose_poses_roll

◆ enose_poses_x

◆ enose_poses_y

◆ enose_poses_yaw

◆ enose_poses_z

◆ first_reading

◆ initial_timestamp

◆ m_COM_baud

◆ m_COM_port

◆ m_external_images_format

◆ m_external_images_jpeg_quality

◆ m_grab_decimation

◆ m_grab_decimation_counter

◆ m_max_queue_len

◆ m_path_for_external_images

◆ m_process_rate

◆ m_sensorLabel

◆ m_state

◆ m_stream_FTDI

◆ m_stream_SERIAL

◆ m_usbSerialNumber

◆ m_verbose