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

#include <sensors/sensors.hh>

Inheritance diagram for gazebo::sensors::DepthCameraSensor:
Inheritance graph
[legend]
Collaboration diagram for gazebo::sensors::DepthCameraSensor:
Collaboration graph
[legend]

Public Member Functions

 DepthCameraSensor ()
 Constructor. More...
 
virtual ~DepthCameraSensor ()
 Destructor. More...
 
rendering::DepthCameraPtr GetDepthCamera () const
 Returns a pointer to the rendering::DepthCamera. More...
 
bool SaveFrame (const std::string &_filename)
 Saves an image frame of depth camera sensor to file. More...
 
virtual void SetActive (bool _value)
 Set whether the sensor is active or not. 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...
 
NoisePtr GetNoise (unsigned int _index=0) const
 Get the sensor's noise model. 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...
 
virtual bool IsActive ()
 Returns true if sensor generation is active. More...
 
void ResetLastUpdateTime ()
 Reset the lastUpdateTime to zero. 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 camera. More...
 
virtual void Init ()
 Initialize the camera. More...
 
virtual 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 bool UpdateImpl (bool _force)
 This gets overwritten by derived sensor types. More...
 
- Protected Member Functions inherited from gazebo::sensors::Sensor
bool NeedsUpdate ()
 Return true if the sensor needs to be updated. 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...
 
transport::NodePtr node
 Node for communication. More...
 
std::vector< NoisePtrnoises
 Noise added to sensor data. 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...
 

Constructor & Destructor Documentation

gazebo::sensors::DepthCameraSensor::DepthCameraSensor ( )

Constructor.

virtual gazebo::sensors::DepthCameraSensor::~DepthCameraSensor ( )
virtual

Destructor.

Member Function Documentation

virtual void gazebo::sensors::DepthCameraSensor::Fini ( )
protectedvirtual

Finalize the camera.

Reimplemented from gazebo::sensors::Sensor.

rendering::DepthCameraPtr gazebo::sensors::DepthCameraSensor::GetDepthCamera ( ) const
inline

Returns a pointer to the rendering::DepthCamera.

Returns
Depth Camera pointer
virtual void gazebo::sensors::DepthCameraSensor::Init ( )
protectedvirtual

Initialize the camera.

Reimplemented from gazebo::sensors::Sensor.

virtual void gazebo::sensors::DepthCameraSensor::Load ( const std::string &  _worldName,
sdf::ElementPtr  _sdf 
)
protectedvirtual

Load the sensor with SDF parameters.

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

Reimplemented from gazebo::sensors::Sensor.

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

Load the sensor with default parameters.

Parameters
[in]_worldNameName of world to load from

Reimplemented from gazebo::sensors::Sensor.

bool gazebo::sensors::DepthCameraSensor::SaveFrame ( const std::string &  _filename)

Saves an image frame of depth camera sensor to file.

Parameters
[in]Nameof file to save as
Returns
True if saved, false if not
virtual void gazebo::sensors::DepthCameraSensor::SetActive ( bool  _value)
virtual

Set whether the sensor is active or not.

Parameters
[in]_valueTrue if active, false if not

Reimplemented from gazebo::sensors::Sensor.

virtual bool gazebo::sensors::DepthCameraSensor::UpdateImpl ( 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]_forceTrue if update is forced, false if not
Returns
True if the sensor was updated.

Reimplemented from gazebo::sensors::Sensor.


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