SensorRangeFinder Struct Reference
Configures a sensor to take range measurements. More...
#include <SensorInfo.h>
Detailed Description
Configures a sensor to take range measurements.
Will test for a collision shape between min and max range. If a hit is found at a distance less than saturationRange, it will be clamped at that value. If no hit is found within the specified min/max range, the maximum value will be reported.
Definition at line 39 of file SensorInfo.h.
Public Member Functions | |
| SensorRangeFinder () | |
| constructor | |
| SensorRangeFinder (const SensorRangeFinder &s) | |
| copy constructor for cloning | |
| virtual void | declareValues (DynamicRobotState &values) |
| Subclass should add name/value pairs to the dictionary to allow variable number of values per Sensor, as well as fast filtering and serialization to subscribers. | |
| virtual void | reclaimValues (DynamicRobotState &values) |
| Subclass should remove values added via previous declareValues(). | |
| virtual SensorRangeFinder * | clone () const __attribute__((warn_unused_result)) |
| clone implementation for Dictionary | |
Public Attributes | |
| plist::Primitive< float > | value |
| current sensor value | |
| plist::Primitive< std::string > | sensorName |
| Name of the sensor instance, to match up with the a sensorNames[] in RobotInfo header. | |
| plist::Primitive< float > | minRange |
| Minimum range for hit testing, obstacles closer than this won't be detected (will report max range). | |
| plist::Primitive< float > | saturationRange |
| Minimum range of sensitivity, obstacles closer than this (but further than min range) will be reported at this value. | |
| plist::Primitive< float > | maxRange |
| Maximum range for hit testing, obstacles further than this won't be detected (and thus will report this value). | |
Static Public Attributes | |
| static const std::string | autoRegister = FamilyFactory<SensorInfo>::getRegistry().registerType<SensorRangeFinder>("RangeFinder") |
| Provides registration with FamilyFactory<SensorInfo> | |
Protected Member Functions | |
| void | init () |
| performs common initialization | |
Constructor & Destructor Documentation
| SensorRangeFinder::SensorRangeFinder | ( | ) |
constructor
Definition at line 41 of file SensorInfo.h.
| SensorRangeFinder::SensorRangeFinder | ( | const SensorRangeFinder & | s | ) |
copy constructor for cloning
Definition at line 43 of file SensorInfo.h.
Member Function Documentation
| SensorRangeFinder * SensorRangeFinder::clone | ( | ) | const [virtual] |
clone implementation for Dictionary
implements the clone function for dictionary
Implements SensorInfo.
Definition at line 8 of file SensorInfo.cc.
| virtual void SensorRangeFinder::declareValues | ( | DynamicRobotState & | values | ) | [virtual] |
Subclass should add name/value pairs to the dictionary to allow variable number of values per Sensor, as well as fast filtering and serialization to subscribers.
A reference to a permanent plist::Primitive<float> instance should be added, this is how values are extracted from the sensor via this shared value.
Implements SensorInfo.
Definition at line 47 of file SensorInfo.h.
| void SensorRangeFinder::init | ( | ) | [protected] |
performs common initialization
Reimplemented from SensorInfo.
Definition at line 62 of file SensorInfo.h.
Referenced by SensorRangeFinder().
| virtual void SensorRangeFinder::reclaimValues | ( | DynamicRobotState & | values | ) | [virtual] |
Subclass should remove values added via previous declareValues().
Implements SensorInfo.
Definition at line 50 of file SensorInfo.h.
Member Data Documentation
const std::string SensorRangeFinder::autoRegister = FamilyFactory<SensorInfo>::getRegistry().registerType<SensorRangeFinder>("RangeFinder") [static] |
Provides registration with FamilyFactory<SensorInfo>
Definition at line 58 of file SensorInfo.h.
Maximum range for hit testing, obstacles further than this won't be detected (and thus will report this value).
Definition at line 57 of file SensorInfo.h.
Referenced by init().
Minimum range for hit testing, obstacles closer than this won't be detected (will report max range).
Definition at line 55 of file SensorInfo.h.
Referenced by init().
Minimum range of sensitivity, obstacles closer than this (but further than min range) will be reported at this value.
Definition at line 56 of file SensorInfo.h.
Referenced by init().
| plist::Primitive<std::string> SensorRangeFinder::sensorName |
Name of the sensor instance, to match up with the a sensorNames[] in RobotInfo header.
Definition at line 54 of file SensorInfo.h.
Referenced by declareValues(), init(), and reclaimValues().
The documentation for this struct was generated from the following files:
