A class for interfacing KVH DSP 3000 gyroscope with an assynchronous serial communication (product SN : 02-1222-01).
It uses a serial port connection to the device. The class implements the generic sensor class. See also the application "rawlog-grabber" for a ready-to-use application to gather data from the scanner. The generated observation is a CObservationIMU, but only the yaw angular velocity and the absolute yaw position are are set in the vector CObservationIMU::rawMeasurements. The sensor process rate is imposed by hardware at 100Hz. For now, this sensor is only supported on posix system.
In most of the communs applications, this class will be used as :
Definition at line 63 of file CGyroKVHDSP3000.h.
#include <mrpt/hwdrivers/CGyroKVHDSP3000.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 |
Public Member Functions | |||
CGyroKVHDSP3000 () | |||
Constructor. More... | |||
void | loadConfig_sensorSpecific (const mrpt::utils::CConfigFileBase &configSource, const std::string &iniSection) | ||
See the class documentation at the top for expected parameters. More... | |||
virtual | ~CGyroKVHDSP3000 () | ||
Destructor. More... | |||
void | doProcess () | ||
This method will be invoked at a minimum rate of "process_rate" (Hz)
| |||
void | initialize () | ||
Turns on the KVH DSP 3000 device and configure it for getting orientation data. More... | |||
void | resetIncrementalAngle (void) | ||
Send to the sensor the command 'Z' wich reset the integrated angle. More... | |||
void | changeMode (GYRO_MODE _newMode) | ||
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"
| |||
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 | |
bool | searchPortAndConnect () |
Search the port where the sensor is located and connect to it. 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 | |
int | m_COMbauds |
This serial port will be attempted to be opened automatically when this class is first used to request data from the device. More... | |
std::string | m_com_port |
mrpt::poses::CPose3D | m_sensorPose |
CSerialPort * | m_serialPort |
The serial port connection. More... | |
GYRO_MODE | m_mode |
bool | m_firstInteration |
mrpt::obs::CObservationIMUPtr | m_observationGyro |
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... | |
|
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.
mrpt::hwdrivers::CGyroKVHDSP3000::CGyroKVHDSP3000 | ( | ) |
Constructor.
|
virtual |
Destructor.
|
inlineprotectedinherited |
Like appendObservations() but for just one observation.
Definition at line 146 of file CGenericSensor.h.
|
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.
void mrpt::hwdrivers::CGyroKVHDSP3000::changeMode | ( | GYRO_MODE | _newMode | ) |
|
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:
|
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.
|
virtual |
This method will be invoked at a minimum rate of "process_rate" (Hz)
This | method must throw an exception with a descriptive message if some critical error is found. |
Implements mrpt::hwdrivers::CGenericSensor.
|
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 233 of file CGenericSensor.h.
References MRPT_MAKE_ALIGNED_OPERATOR_NEW.
|
inherited |
Returns a list of enqueued objects, emptying it (thread-safe).
The objects must be freed by the invoker.
|
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.
|
virtual |
Turns on the KVH DSP 3000 device and configure it for getting orientation data.
you must have called loadConfig_sensorSpecific before calling this function.
Reimplemented from mrpt::hwdrivers::CGenericSensor.
|
inlineinherited |
Definition at line 93 of file CGenericSensor.h.
References mrpt::utils::registerClass().
|
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. |
|
virtual |
See the class documentation at the top for expected parameters.
Implements mrpt::hwdrivers::CGenericSensor.
|
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().
void mrpt::hwdrivers::CGyroKVHDSP3000::resetIncrementalAngle | ( | void | ) |
Send to the sensor the command 'Z' wich reset the integrated angle.
(in both rate mode and incremental, this function has no effect)
|
protected |
Search the port where the sensor is located and connect to it.
|
inlineinherited |
Set the extension ("jpg","gif","png",...) that determines the format of images saved externally The default is "jpg".
Definition at line 225 of file CGenericSensor.h.
|
inlineinherited |
The quality of JPEG compression, when external images is enabled and the format is "jpg".
Definition at line 230 of file CGenericSensor.h.
|
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 216 of file CGenericSensor.h.
References MRPT_UNUSED_PARAM.
|
inlineinherited |
Definition at line 87 of file CGenericSensor.h.
|
protected |
Definition at line 72 of file CGyroKVHDSP3000.h.
|
protected |
This serial port will be attempted to be opened automatically when this class is first used to request data from the device.
Definition at line 71 of file CGyroKVHDSP3000.h.
|
protectedinherited |
The extension ("jpg","gif","png",...) that determines the format of images saved externally.
Definition at line 130 of file CGenericSensor.h.
|
protectedinherited |
For JPEG images, the quality (default=95%).
Definition at line 131 of file CGenericSensor.h.
|
protected |
Definition at line 82 of file CGyroKVHDSP3000.h.
|
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.
|
protectedinherited |
Used when "m_grab_decimation" is enabled.
Definition at line 122 of file CGenericSensor.h.
|
protectedinherited |
See CGenericSensor.
Definition at line 116 of file CGenericSensor.h.
|
protected |
Definition at line 81 of file CGyroKVHDSP3000.h.
|
protected |
Definition at line 84 of file CGyroKVHDSP3000.h.
|
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.
|
protectedinherited |
See CGenericSensor.
Definition at line 115 of file CGenericSensor.h.
|
protectedinherited |
See CGenericSensor.
Definition at line 118 of file CGenericSensor.h.
|
protected |
Definition at line 74 of file CGyroKVHDSP3000.h.
|
protected |
The serial port connection.
Definition at line 80 of file CGyroKVHDSP3000.h.
|
protectedinherited |
Definition at line 124 of file CGenericSensor.h.
|
protectedinherited |
Definition at line 125 of file CGenericSensor.h.
Page generated by Doxygen 1.8.11 for MRPT 1.3.2 SVN:Unversioned directory at Sun May 1 08:45:24 UTC 2016 |