: An interface for the phidget Interface kit board (1018).
An interface for the Phidgets Interface kit board (part number 1018) on wich it could be plugged either an Sharp IR adaptater board (phidget's part number : 1101),or a MaxBotix EZ-1 sonar (phidget's part number : 1118). The configuration file describe what is plugged to this board, and the geometry of the sensors on the robots. See the exemple below.
The maximum number of sensors on this board is 8. Sensor 1 is the first sensor. If you haven't plugged any sensor on an entry of the board, you haven't to specify anyithing about this sensor in the configuration file. The following table enumerate the different sensors supported by this class.
Definition at line 72 of file CPhidgetInterfaceKitProximitySensors.h.
#include <mrpt/hwdrivers/CPhidgetInterfaceKitProximitySensors.h>
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 stlplus::smart_ptr< const CGenericSensor > | ConstPtr |
Public Member Functions | |
CPhidgetInterfaceKitProximitySensors () | |
Constructor. More... | |
virtual | ~CPhidgetInterfaceKitProximitySensors () |
Destructor. More... | |
void | getObservation (mrpt::obs::CObservationRange &outObservation) |
This method tries to get a set of range measurements from the IR sensors. More... | |
void | initialize () |
Initialize the sensor according to the parameters previously read in the configuration file. More... | |
void | doProcess () |
This method should be called periodically. 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 §ion) |
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 | |
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 | |
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 | |
void | loadConfig_sensorSpecific (const mrpt::utils::CConfigFileBase &configSource, const std::string &iniSection) |
See the class documentation at the top for expected parameters. More... | |
Private Attributes | |
std::vector< bool > | m_sensorIsPlugged |
An 8 dimension vector of boolean value wich store the presence or abscence of a sensor on the phidget interface kit board. More... | |
std::vector< float > | m_minRange |
The minimum range in meters, this field is automaticaly filled according to the sensor part number read in the configuration file. More... | |
std::vector< float > | m_maxRange |
The maximum range in meters, this field is automaticaly filled according to the sensor part number read in the configuration file. More... | |
std::vector< SensorType > | m_sensorType |
The sensor type. More... | |
std::vector< mrpt::poses::CPose3D > | m_sensorPoses |
The poses of the 8 sensors x[m] y[m] z[m] yaw[deg] pitch[deg] roll[deg]. More... | |
int | m_serialNumber |
The board serial number read in the configuration file. More... | |
float | m_minOfMinRanges |
float | m_maxOfMaxRanges |
void * | m_carteInterfaceKit |
|
inherited |
Definition at line 103 of file CGenericSensor.h.
|
inherited |
Definition at line 102 of file CGenericSensor.h.
|
inherited |
Definition at line 68 of file CGenericSensor.h.
|
inherited |
Definition at line 69 of file CGenericSensor.h.
|
inherited |
The current state of the sensor.
Enumerator | |
---|---|
ssInitializing | |
ssWorking | |
ssError |
Definition at line 74 of file CGenericSensor.h.
CPhidgetInterfaceKitProximitySensors::CPhidgetInterfaceKitProximitySensors | ( | ) |
Constructor.
serialNumber | The board's serial number. Set -1 to choose the first available board |
Definition at line 33 of file CPhidgetInterfaceKitProximitySensors.cpp.
References THROW_EXCEPTION, and mrpt::hwdrivers::UNPLUGGED.
|
virtual |
Destructor.
Definition at line 208 of file CPhidgetInterfaceKitProximitySensors.cpp.
|
inlineprotectedinherited |
Like appendObservations() but for just one observation.
Definition at line 147 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CIMUXSens_MT4::doProcess(), mrpt::hwdrivers::CIMUXSens::doProcess(), mrpt::hwdrivers::CSkeletonTracker::doProcess(), mrpt::hwdrivers::CSwissRanger3DCamera::doProcess(), mrpt::hwdrivers::CIMUIntersense::doProcess(), mrpt::hwdrivers::CGyroKVHDSP3000::doProcess(), mrpt::hwdrivers::C2DRangeFinderAbstract::doProcess(), mrpt::hwdrivers::CCANBusReader::doProcess(), mrpt::hwdrivers::CVelodyneScanner::doProcess(), and mrpt::hwdrivers::CGPSInterface::flushParsedMessagesNow().
|
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:
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().
|
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:
Definition at line 103 of file CGenericSensor.cpp.
References mrpt::hwdrivers::CGenericSensor::get_registered_sensor_classes().
|
inlinestaticinherited |
Just like createSensor, but returning a smart pointer to the newly created sensor object.
Definition at line 180 of file CGenericSensor.h.
|
virtual |
This method should be called periodically.
Period depend on the process_rate in the configuration file.
Implements mrpt::hwdrivers::CGenericSensor.
Definition at line 222 of file CPhidgetInterfaceKitProximitySensors.cpp.
References mrpt::obs::utils::getObservation(), and THROW_EXCEPTION.
|
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.
|
inlineinherited |
Definition at line 234 of file CGenericSensor.h.
void CPhidgetInterfaceKitProximitySensors::getObservation | ( | mrpt::obs::CObservationRange & | outObservation | ) |
This method tries to get a set of range measurements from the IR sensors.
outThereIsObservation | Will be true if an observation was sucessfully received. |
Definition at line 246 of file CPhidgetInterfaceKitProximitySensors.cpp.
References DEG2RAD, mrpt::obs::gnss::error, mrpt::hwdrivers::EZ1, mrpt::system::getCurrentTime(), mrpt::obs::CObservationRange::maxSensorDistance, mrpt::obs::CObservationRange::minSensorDistance, MRPT_UNUSED_PARAM, mrpt::obs::CObservationRange::sensedData, mrpt::obs::CObservationRange::TMeasurement::sensedDistance, mrpt::obs::CObservationRange::sensorConeApperture, mrpt::obs::CObservationRange::TMeasurement::sensorID, mrpt::obs::CObservation::sensorLabel, mrpt::obs::CObservationRange::TMeasurement::sensorPose, mrpt::hwdrivers::SHARP_30cm, mrpt::hwdrivers::SHARP_80cm, THROW_EXCEPTION, and mrpt::obs::CObservation::timestamp.
|
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.
|
inlineinherited |
Definition at line 84 of file CGenericSensor.h.
|
pure virtualinherited |
|
inlineinherited |
Definition at line 86 of file CGenericSensor.h.
|
inlineinherited |
The current state of the sensor.
Definition at line 82 of file CGenericSensor.h.
Initialize the sensor according to the parameters previously read in the configuration file.
throw | an exception if the board could not be found. |
throw | an exception if the process rate can't be set on one of the board channel. |
Reimplemented from mrpt::hwdrivers::CGenericSensor.
Definition at line 168 of file CPhidgetInterfaceKitProximitySensors.cpp.
References mrpt::hwdrivers::CGenericSensor::ssError, mrpt::hwdrivers::CGenericSensor::ssWorking, and THROW_EXCEPTION.
|
inlineinherited |
Definition at line 93 of file CGenericSensor.h.
|
inherited |
Loads the generic settings common to any sensor (See CGenericSensor), then call to "loadConfig_sensorSpecific".
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().
|
privatevirtual |
See the class documentation at the top for expected parameters.
Implements mrpt::hwdrivers::CGenericSensor.
Definition at line 56 of file CPhidgetInterfaceKitProximitySensors.cpp.
References mrpt::hwdrivers::EZ1, mrpt::format(), MRPT_UNUSED_PARAM, mrpt::obs::gnss::pitch, mrpt::utils::CConfigFileBase::read_bool(), mrpt::utils::CConfigFileBase::read_float(), mrpt::utils::CConfigFileBase::read_int(), mrpt::utils::CConfigFileBase::read_string(), mrpt::obs::gnss::roll, mrpt::utils::CConfigFileBase::sectionExists(), mrpt::hwdrivers::SHARP_30cm, mrpt::hwdrivers::SHARP_80cm, mrpt::hwdrivers::CGenericSensor::ssError, THROW_EXCEPTION, and mrpt::hwdrivers::UNPLUGGED.
|
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().
|
inlineinherited |
Set the extension ("jpg","gif","png",...) that determines the format of images saved externally The default is "jpg".
Definition at line 226 of file CGenericSensor.h.
|
inlineinherited |
The quality of JPEG compression, when external images is enabled and the format is "jpg".
Definition at line 231 of file CGenericSensor.h.
References quality.
|
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.
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 217 of file CGenericSensor.h.
References MRPT_UNUSED_PARAM.
|
inlineinherited |
Definition at line 87 of file CGenericSensor.h.
|
private |
Definition at line 128 of file CPhidgetInterfaceKitProximitySensors.h.
|
protectedinherited |
The extension ("jpg","gif","png",...) that determines the format of images saved externally.
Definition at line 131 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CSwissRanger3DCamera::getNextObservation(), and mrpt::hwdrivers::CSwissRanger3DCamera::loadConfig_sensorSpecific().
|
protectedinherited |
For JPEG images, the quality (default=95%).
Definition at line 132 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CSwissRanger3DCamera::getNextObservation(), and mrpt::hwdrivers::CSwissRanger3DCamera::loadConfig_sensorSpecific().
|
protectedinherited |
If set to N>=2, only 1 out of N observations will be saved to m_objList.
Definition at line 118 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CGenericSensor::appendObservations(), and mrpt::hwdrivers::CGenericSensor::loadConfig().
|
protectedinherited |
Used when "m_grab_decimation" is enabled.
Definition at line 123 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CGenericSensor::appendObservations(), and mrpt::hwdrivers::CGenericSensor::loadConfig().
|
protectedinherited |
See CGenericSensor.
Definition at line 117 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CGenericSensor::loadConfig().
|
private |
Definition at line 126 of file CPhidgetInterfaceKitProximitySensors.h.
|
private |
The maximum range in meters, this field is automaticaly filled according to the sensor part number read in the configuration file.
Size of this vector depend on the number of sensors described in the configuration file.
Definition at line 112 of file CPhidgetInterfaceKitProximitySensors.h.
|
private |
Definition at line 125 of file CPhidgetInterfaceKitProximitySensors.h.
|
private |
The minimum range in meters, this field is automaticaly filled according to the sensor part number read in the configuration file.
Size of this vector depend on the number of sensors described in the configuration file.
Definition at line 107 of file CPhidgetInterfaceKitProximitySensors.h.
|
protectedinherited |
The path where to save off-rawlog images: empty means save images embedded in the rawlog.
Definition at line 130 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CSwissRanger3DCamera::getNextObservation(), and mrpt::hwdrivers::CSwissRanger3DCamera::setPathForExternalImages().
|
protectedinherited |
See CGenericSensor.
Definition at line 116 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CGyroKVHDSP3000::initialize(), and mrpt::hwdrivers::CGenericSensor::loadConfig().
|
private |
An 8 dimension vector of boolean value wich store the presence or abscence of a sensor on the phidget interface kit board.
Definition at line 103 of file CPhidgetInterfaceKitProximitySensors.h.
|
protectedinherited |
See CGenericSensor.
Definition at line 119 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CCANBusReader::CCANBusReader(), mrpt::hwdrivers::CGPSInterface::CGPSInterface(), mrpt::hwdrivers::CGyroKVHDSP3000::CGyroKVHDSP3000(), mrpt::hwdrivers::CHokuyoURG::CHokuyoURG(), mrpt::hwdrivers::CIMUIntersense::CIMUIntersense(), mrpt::hwdrivers::CIMUXSens::CIMUXSens(), mrpt::hwdrivers::CIMUXSens_MT4::CIMUXSens_MT4(), mrpt::hwdrivers::CKinect::CKinect(), mrpt::hwdrivers::CNationalInstrumentsDAQ::CNationalInstrumentsDAQ(), mrpt::hwdrivers::CRoboPeakLidar::CRoboPeakLidar(), mrpt::hwdrivers::CSickLaserSerial::CSickLaserSerial(), mrpt::hwdrivers::CSickLaserUSB::CSickLaserUSB(), mrpt::hwdrivers::CSkeletonTracker::CSkeletonTracker(), mrpt::hwdrivers::CSwissRanger3DCamera::CSwissRanger3DCamera(), mrpt::hwdrivers::CVelodyneScanner::CVelodyneScanner(), mrpt::hwdrivers::CIMUXSens_MT4::doProcess(), mrpt::hwdrivers::CIMUXSens::doProcess(), mrpt::hwdrivers::CSkeletonTracker::doProcess(), mrpt::hwdrivers::CGyroKVHDSP3000::doProcess(), mrpt::hwdrivers::CIMUIntersense::doProcess(), mrpt::hwdrivers::CRoboPeakLidar::doProcessSimple(), mrpt::hwdrivers::CSickLaserUSB::doProcessSimple(), mrpt::hwdrivers::CCANBusReader::doProcessSimple(), mrpt::hwdrivers::CSickLaserSerial::doProcessSimple(), mrpt::hwdrivers::CHokuyoURG::doProcessSimple(), mrpt::hwdrivers::CGPSInterface::flushParsedMessagesNow(), mrpt::hwdrivers::CSwissRanger3DCamera::getNextObservation(), mrpt::hwdrivers::CKinect::getNextObservation(), mrpt::hwdrivers::CVelodyneScanner::getNextObservation(), mrpt::hwdrivers::CNationalInstrumentsDAQ::grabbing_thread(), mrpt::hwdrivers::CGenericSensor::loadConfig(), mrpt::hwdrivers::CSkeletonTracker::processPreview(), mrpt::hwdrivers::C2DRangeFinderAbstract::processPreview(), and mrpt::hwdrivers::CSkeletonTracker::processPreviewNone().
|
private |
The poses of the 8 sensors x[m] y[m] z[m] yaw[deg] pitch[deg] roll[deg].
This field is automaticaly filled according to the sensor described in the configuration file.
Definition at line 120 of file CPhidgetInterfaceKitProximitySensors.h.
|
private |
The sensor type.
Definition at line 116 of file CPhidgetInterfaceKitProximitySensors.h.
|
private |
The board serial number read in the configuration file.
-1 for any board.
Definition at line 124 of file CPhidgetInterfaceKitProximitySensors.h.
|
protectedinherited |
Definition at line 125 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CGyroKVHDSP3000::CGyroKVHDSP3000(), mrpt::hwdrivers::CIMUXSens_MT4::doProcess(), mrpt::hwdrivers::CIMUXSens::doProcess(), mrpt::hwdrivers::CSkeletonTracker::doProcess(), mrpt::hwdrivers::CSwissRanger3DCamera::doProcess(), mrpt::hwdrivers::CIMUIntersense::doProcess(), mrpt::hwdrivers::CGyroKVHDSP3000::doProcess(), mrpt::hwdrivers::C2DRangeFinderAbstract::doProcess(), mrpt::hwdrivers::CGPSInterface::doProcess(), mrpt::hwdrivers::CNationalInstrumentsDAQ::doProcess(), mrpt::hwdrivers::CKinect::doProcess(), mrpt::hwdrivers::CVelodyneScanner::doProcess(), mrpt::hwdrivers::CSickLaserUSB::doProcessSimple(), mrpt::hwdrivers::CCANBusReader::doProcessSimple(), mrpt::hwdrivers::CSickLaserSerial::doProcessSimple(), mrpt::hwdrivers::CHokuyoURG::doProcessSimple(), mrpt::hwdrivers::CGPSInterface::flushParsedMessagesNow(), mrpt::hwdrivers::CVelodyneScanner::getNextObservation(), mrpt::hwdrivers::CIMUXSens_MT4::initialize(), mrpt::hwdrivers::CIMUXSens::initialize(), mrpt::hwdrivers::CSkeletonTracker::initialize(), mrpt::hwdrivers::CIMUIntersense::initialize(), mrpt::hwdrivers::CGyroKVHDSP3000::initialize(), mrpt::hwdrivers::CVelodyneScanner::initialize(), mrpt::hwdrivers::CNationalInstrumentsDAQ::readFromDAQ(), and mrpt::hwdrivers::CIMUXSens::searchPortAndConnect().
|
protectedinherited |
Definition at line 126 of file CGenericSensor.h.
Referenced by mrpt::hwdrivers::CGenericSensor::CGenericSensor(), mrpt::hwdrivers::CRoboPeakLidar::checkCOMMs(), mrpt::hwdrivers::CNTRIPEmitter::doProcess(), mrpt::hwdrivers::CGPSInterface::doProcess(), mrpt::hwdrivers::CNationalInstrumentsDAQ::grabbing_thread(), mrpt::hwdrivers::CIMUXSens_MT4::initialize(), mrpt::hwdrivers::CVelodyneScanner::internal_read_PCAP_packet(), mrpt::hwdrivers::CGPSInterface::JAVAD_sendMessage(), mrpt::hwdrivers::CGPSInterface::legacy_topcon_setup_commands(), mrpt::hwdrivers::CGPSInterface::OnConnectionEstablished(), mrpt::hwdrivers::CGPSInterface::OnConnectionShutdown(), mrpt::hwdrivers::CNationalInstrumentsDAQ::stop(), and mrpt::hwdrivers::CGPSInterface::tryToOpenTheCOM().
Page generated by Doxygen 1.8.14 for MRPT 1.5.5 Git: e06b63dbf Fri Dec 1 14:41:11 2017 +0100 at lun oct 28 01:31:35 CET 2019 |