All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
gazebo::sensors::ImuSensor Class Reference

An IMU sensor. More...

#include <sensors/sensors.hh>

Inheritance diagram for gazebo::sensors::ImuSensor:
Inheritance graph

Public Member Functions

 ImuSensor ()
 Constructor. More...
virtual ~ImuSensor ()
 Destructor. More...
math::Vector3 GetAngularVelocity () const
 Returns the angular velocity. More...
msgs::IMU GetImuMessage () const
 Returns the imu message. More...
math::Vector3 GetLinearAcceleration () const
 Returns the imu linear acceleration. More...
math::Quaternion GetOrientation () const
 get orientation of the IMU relative to the reference pose More...
virtual void Init ()
 Initialize the IMU. More...
virtual bool IsActive ()
 Returns true if sensor generation is active. More...
void SetReferencePose ()
 Sets the current pose as the IMU reference pose. More...
- Public Member Functions inherited from gazebo::sensors::Sensor
 Sensor (SensorCategory _cat)
 Constructor. More...
virtual ~Sensor ()
 Destructor. More...
template<typename T >
event::ConnectionPtr ConnectUpdated (T _subscriber)
 Connect a signal that is triggered when the sensor is updated. More...
void DisconnectUpdated (event::ConnectionPtr &_c)
 Disconnect from a the updated signal. More...
void FillMsg (msgs::Sensor &_msg)
 fills a msgs::Sensor message. More...
SensorCategory GetCategory () const
 Get the category of the sensor. More...
uint32_t GetId () const
 Get the sensor's ID. More...
common::Time GetLastMeasurementTime ()
 Return last measurement time. More...
common::Time GetLastUpdateTime ()
 Return last update time. More...
std::string GetName () const
 Get name. More...
uint32_t GetParentId () const
 Get the sensor's parent's ID. More...
std::string GetParentName () const
 Returns the name of the sensor parent. More...
virtual math::Pose GetPose () const
 Get the current pose. More...
std::string GetScopedName () const
 Get fully scoped name of the sensor. More...
virtual std::string GetTopic () const
 Returns the topic name as set in SDF. More...
std::string GetType () const
 Get sensor type. More...
double GetUpdateRate ()
 Get the update rate of the sensor. More...
bool GetVisualize () const
 Return true if user requests the sensor to be visualized via tag: <visualize>true</visualize> in SDF. More...
std::string GetWorldName () const
 Returns the name of the world the sensor is in. More...
void ResetLastUpdateTime ()
 Reset the lastUpdateTime to zero. More...
virtual void SetActive (bool _value)
 Set whether the sensor is active or not. More...
virtual void SetParent (const std::string &_name) GAZEBO_DEPRECATED(1.10)
 Set the parent of the sensor. More...
void SetParent (const std::string &_name, uint32_t _id)
 Set the sensor's parent. More...
void SetUpdateRate (double _hz)
 Set the update rate of the sensor. More...
void Update (bool _force)
 Update the sensor. More...

Protected Member Functions

virtual void Fini ()
 Finalize the sensor. More...
void Load (const std::string &_worldName, sdf::ElementPtr _sdf)
 Load the sensor with SDF parameters. More...
virtual void Load (const std::string &_worldName)
 Load the sensor with default parameters. More...
virtual void UpdateImpl (bool _force)
 This gets overwritten by derived sensor types. More...

Additional Inherited Members

- Protected Attributes inherited from gazebo::sensors::Sensor
bool active
 True if sensor generation is active. More...
std::vector< event::ConnectionPtrconnections
 All event connections. More...
common::Time lastMeasurementTime
 Stores last time that a sensor measurement was generated; this value must be updated within each sensor's UpdateImpl. More...
common::Time lastUpdateTime
 Time of the last update. More...
boost::mutex mutexLastUpdateTime
 Mutex to protect resetting lastUpdateTime. More...
transport::NodePtr node
 Node for communication. More...
uint32_t parentId
 The sensor's parent ID. More...
std::string parentName
 Name of the parent. More...
std::vector< SensorPluginPtrplugins
 All the plugins for the sensor. More...
math::Pose pose
 Pose of the sensor. More...
transport::SubscriberPtr poseSub
 Subscribe to pose updates. More...
gazebo::rendering::ScenePtr scene
 Pointer to the Scene. More...
sdf::ElementPtr sdf
 Pointer the the SDF element for the sensor. More...
common::Time updatePeriod
 Desired time between updates, set indirectly by Sensor::SetUpdateRate. More...
gazebo::physics::WorldPtr world
 Pointer to the world. More...

Detailed Description

An IMU sensor.

Constructor & Destructor Documentation

gazebo::sensors::ImuSensor::ImuSensor ( )


virtual gazebo::sensors::ImuSensor::~ImuSensor ( )


Member Function Documentation

virtual void gazebo::sensors::ImuSensor::Fini ( )

Finalize the sensor.

Reimplemented from gazebo::sensors::Sensor.

math::Vector3 gazebo::sensors::ImuSensor::GetAngularVelocity ( ) const

Returns the angular velocity.

Angular velocity.
msgs::IMU gazebo::sensors::ImuSensor::GetImuMessage ( ) const

Returns the imu message.

Imu message.
math::Vector3 gazebo::sensors::ImuSensor::GetLinearAcceleration ( ) const

Returns the imu linear acceleration.

Linear acceleration.
math::Quaternion gazebo::sensors::ImuSensor::GetOrientation ( ) const

get orientation of the IMU relative to the reference pose

returns the orientation quaternion of the IMU relative to the imu reference pose.
virtual void gazebo::sensors::ImuSensor::Init ( )

Initialize the IMU.

Reimplemented from gazebo::sensors::Sensor.

virtual bool gazebo::sensors::ImuSensor::IsActive ( )

Returns true if sensor generation is active.

True if active, false if not.

Reimplemented from gazebo::sensors::Sensor.

void gazebo::sensors::ImuSensor::Load ( const std::string &  _worldName,
sdf::ElementPtr  _sdf 

Load the sensor with SDF parameters.

[in]_sdfSDF Sensor parameters.
[in]_worldNameName of world to load from.

Reimplemented from gazebo::sensors::Sensor.

virtual void gazebo::sensors::ImuSensor::Load ( const std::string &  _worldName)

Load the sensor with default parameters.

[in]_worldNameName of world to load from.

Reimplemented from gazebo::sensors::Sensor.

void gazebo::sensors::ImuSensor::SetReferencePose ( )

Sets the current pose as the IMU reference pose.

virtual void gazebo::sensors::ImuSensor::UpdateImpl ( bool  )

This gets overwritten by derived sensor types.

   This function is called during Sensor::Update.
   And in turn, Sensor::Update is called by
[in]_forceTrue if update is forced, false if not

Reimplemented from gazebo::sensors::Sensor.

The documentation for this class was generated from the following file: