Sensor class for RFID type of sensor.
More...
#include <sensors/sensors.hh>
Inherits Sensor.
|
| RFIDSensor () |
| Constructor.
|
|
virtual | ~RFIDSensor () |
| Destructor.
|
|
void | AddTag (RFIDTag *_tag) |
|
SensorCategory | Category () const |
| Get the category of the sensor.
|
|
event::ConnectionPtr | ConnectUpdated (std::function< void()> _subscriber) |
| Connect a signal that is triggered when the sensor is updated.
|
|
void | FillMsg (msgs::Sensor &_msg) |
| fills a msgs::Sensor message.
|
|
virtual void | Fini () |
| Finalize the sensor.
|
|
uint32_t | Id () const |
| Get the sensor's ID.
|
|
virtual void | Init () |
| Initialize the sensor.
|
|
virtual bool | IsActive () const |
| Returns true if sensor generation is active.
|
|
common::Time | LastMeasurementTime () const |
| Return last measurement time.
|
|
common::Time | LastUpdateTime () const |
| Return last update time.
|
|
virtual void | Load (const std::string &_worldName) |
| Load the sensor with default parameters.
|
|
virtual void | Load (const std::string &_worldName, sdf::ElementPtr _sdf) |
| Load the sensor with SDF parameters.
|
|
std::string | Name () const |
| Get name.
|
|
NoisePtr | Noise (const SensorNoiseType _type) const |
| Get the sensor's noise model for a specified noise type.
|
|
uint32_t | ParentId () const |
| Get the sensor's parent's ID.
|
|
std::string | ParentName () const |
| Returns the name of the sensor parent.
|
|
virtual ignition::math::Pose3d | Pose () const |
| Get the current pose.
|
|
void | ResetLastUpdateTime () |
| Reset the lastUpdateTime to zero.
|
|
std::string | ScopedName () const |
| Get fully scoped name of the sensor.
|
|
virtual void | SetActive (const bool _value) |
| Set whether the sensor is active or not.
|
|
void | SetParent (const std::string &_name, const uint32_t _id) |
| Set the sensor's parent.
|
|
virtual void | SetPose (const ignition::math::Pose3d &_pose) |
| Set the current pose.
|
|
void | SetUpdateRate (const double _hz) |
| Set the update rate of the sensor.
|
|
virtual std::string | Topic () const |
| Returns the topic name as set in SDF.
|
|
std::string | Type () const |
| Get sensor type.
|
|
void | Update (const bool _force) |
| Update the sensor.
|
|
double | UpdateRate () const |
| Get the update rate of the sensor.
|
|
bool | Visualize () const |
| Return true if user requests the sensor to be visualized via tag: <visualize>true</visualize> in SDF.
|
|
std::string | WorldName () const |
| Returns the name of the world the sensor is in.
|
|
|
bool | NeedsUpdate () |
| Return true if the sensor needs to be updated.
|
|
virtual bool | UpdateImpl (const bool _force) |
| This gets overwritten by derived sensor types.
|
|
Sensor class for RFID type of sensor.
◆ RFIDSensor()
◆ ~RFIDSensor()
◆ AddTag()
◆ Category()
Get the category of the sensor.
- Returns
- The category of the sensor.
- See also
- SensorCategory
◆ ConnectUpdated()
Connect a signal that is triggered when the sensor is updated.
- Parameters
-
[in] | _subscriber | Callback that receives the signal. |
- Returns
- A pointer to the connection. This must be kept in scope.
- See also
- Sensor::DisconnectUpdated
◆ FillMsg()
void FillMsg |
( |
msgs::Sensor & | _msg | ) |
|
|
inherited |
fills a msgs::Sensor message.
- Parameters
-
[out] | _msg | Message to fill. |
◆ Fini()
Finalize the sensor.
Reimplemented from Sensor.
◆ Id()
Get the sensor's ID.
- Returns
- The sensor's ID.
◆ Init()
Initialize the sensor.
Reimplemented from Sensor.
◆ IsActive()
virtual bool IsActive |
( |
| ) |
const |
|
virtualinherited |
◆ LastMeasurementTime()
Return last measurement time.
- Returns
- Time of last measurement.
◆ LastUpdateTime()
Return last update time.
- Returns
- Time of last update.
◆ Load() [1/2]
virtual void Load |
( |
const std::string & | _worldName | ) |
|
|
virtual |
Load the sensor with default parameters.
- Parameters
-
[in] | _worldName | Name of world to load from. |
Reimplemented from Sensor.
◆ Load() [2/2]
virtual void Load |
( |
const std::string & | _worldName, |
|
|
sdf::ElementPtr | _sdf ) |
|
virtual |
Load the sensor with SDF parameters.
- Parameters
-
[in] | _sdf | SDF Sensor parameters. |
[in] | _worldName | Name of world to load from. |
Reimplemented from Sensor.
◆ Name()
std::string Name |
( |
| ) |
const |
|
inherited |
Get name.
- Returns
- Name of sensor.
◆ NeedsUpdate()
Return true if the sensor needs to be updated.
- Returns
- True when sensor should be updated.
◆ Noise()
Get the sensor's noise model for a specified noise type.
- Parameters
-
[in] | _type | Index of the noise type. Refer to SensorNoiseType enumeration for possible indices |
- Returns
- The sensor's noise model for the given noise type
◆ ParentId()
uint32_t ParentId |
( |
| ) |
const |
|
inherited |
Get the sensor's parent's ID.
- Returns
- The sensor's parent's ID.
◆ ParentName()
std::string ParentName |
( |
| ) |
const |
|
inherited |
Returns the name of the sensor parent.
The parent name is set by Sensor::SetParent.
- Returns
- Name of Parent.
◆ Pose()
virtual ignition::math::Pose3d Pose |
( |
| ) |
const |
|
virtualinherited |
Get the current pose.
- Returns
- Current pose of the sensor.
- See also
- SetPose()
◆ ResetLastUpdateTime()
void ResetLastUpdateTime |
( |
| ) |
|
|
inherited |
Reset the lastUpdateTime to zero.
◆ ScopedName()
std::string ScopedName |
( |
| ) |
const |
|
inherited |
Get fully scoped name of the sensor.
- Returns
- world_name::model_name::link_name::sensor_name.
◆ SetActive()
virtual void SetActive |
( |
const bool | _value | ) |
|
|
virtualinherited |
Set whether the sensor is active or not.
- Parameters
-
[in] | _value | True if active, false if not. |
◆ SetParent()
void SetParent |
( |
const std::string & | _name, |
|
|
const uint32_t | _id ) |
|
inherited |
Set the sensor's parent.
- Parameters
-
[in] | _name | The sensor's parent's name. |
[in] | _id | The sensor's parent's ID. |
◆ SetPose()
virtual void SetPose |
( |
const ignition::math::Pose3d & | _pose | ) |
|
|
virtualinherited |
Set the current pose.
- Parameters
-
[in] | _pose | New pose of the sensor. |
- See also
- Pose()
◆ SetUpdateRate()
void SetUpdateRate |
( |
const double | _hz | ) |
|
|
inherited |
Set the update rate of the sensor.
- Parameters
-
[in] | _hz | update rate of sensor. |
◆ Topic()
virtual std::string Topic |
( |
| ) |
const |
|
virtualinherited |
◆ Type()
std::string Type |
( |
| ) |
const |
|
inherited |
Get sensor type.
- Returns
- Type of sensor.
◆ Update()
void Update |
( |
const bool | _force | ) |
|
|
inherited |
Update the sensor.
- Parameters
-
[in] | _force | True to force update, false otherwise. |
◆ UpdateImpl()
virtual bool UpdateImpl |
( |
const bool | | ) |
|
|
protectedvirtual |
This gets overwritten by derived sensor types.
This function is called during Sensor::Update. And in turn, Sensor::Update is called by SensorManager::Update
- Parameters
-
[in] | _force | True if update is forced, false if not |
- Returns
- True if the sensor was updated.
Reimplemented from Sensor.
◆ UpdateRate()
double UpdateRate |
( |
| ) |
const |
|
inherited |
Get the update rate of the sensor.
- Returns
- _hz update rate of sensor. Returns 0 if unthrottled.
◆ Visualize()
Return true if user requests the sensor to be visualized via tag: <visualize>true</visualize> in SDF.
- Returns
- True if visualized, false if not.
◆ WorldName()
std::string WorldName |
( |
| ) |
const |
|
inherited |
Returns the name of the world the sensor is in.
- Returns
- Name of the world.
◆ active
True if sensor generation is active.
◆ connections
◆ lastMeasurementTime
Stores last time that a sensor measurement was generated; this value must be updated within each sensor's UpdateImpl.
◆ lastUpdateTime
◆ node
◆ nodeIgn
ignition::transport::Node nodeIgn |
|
protectedinherited |
◆ noises
Noise added to sensor data.
◆ parentId
◆ parentName
◆ plugins
All the plugins for the sensor.
◆ pose
ignition::math::Pose3d pose |
|
protectedinherited |
◆ scene
◆ sdf
Pointer the the SDF element for the sensor.
◆ updatePeriod
◆ world
The documentation for this class was generated from the following file: