Drake
RigidBodySensor Class Referenceabstract

An abstract parent class of all sensors. More...

#include <drake/systems/plants/RigidBodySystem.h>

Inheritance diagram for RigidBodySensor:

Public Member Functions

EIGEN_MAKE_ALIGNED_OPERATOR_NEW RigidBodySensor (const RigidBodySystem &sys, const std::string &name, std::shared_ptr< RigidBodyFrame > frame)
 The constructor. More...
 
virtual ~RigidBodySensor ()
 
virtual bool isDirectFeedthrough () const
 
virtual size_t getNumOutputs () const
 
virtual Eigen::VectorXd output (const double &t, const KinematicsCache< double > &rigid_body_state, const RigidBodySystem::InputVector< double > &u) const =0
 
const std::string & get_name () const
 Returns the name of the sensor. More...
 
const std::string & get_model_name () const
 Returns the name of the model (i.e., robot) that owns this sensor. More...
 
const RigidBodyFrameget_frame () const
 Returns the frame to which thi sensor is attached. More...
 
const RigidBodySystemget_rigid_body_system () const
 Returns the rigid body system to which this sensor attaches. More...
 

Detailed Description

An abstract parent class of all sensors.

This is an abstract top-level class of all rigid body sensors in Drake.

Constructor & Destructor Documentation

EIGEN_MAKE_ALIGNED_OPERATOR_NEW RigidBodySensor ( const RigidBodySystem sys,
const std::string &  name,
std::shared_ptr< RigidBodyFrame frame 
)
inline

The constructor.

Parameters
[in]sysThe rigid body system to which the sensor is attached.
[in]nameThe name of the sensor.
[in]frameThe frame within the rigid body system's rigid body tree to which the sensor is attached.
virtual ~RigidBodySensor ( )
inlinevirtual

Member Function Documentation

const RigidBodyFrame & get_frame ( ) const

Returns the frame to which thi sensor is attached.

Here is the caller graph for this function:

const std::string & get_model_name ( ) const

Returns the name of the model (i.e., robot) that owns this sensor.

Here is the caller graph for this function:

const std::string& get_name ( ) const
inline

Returns the name of the sensor.

Here is the caller graph for this function:

const RigidBodySystem & get_rigid_body_system ( ) const

Returns the rigid body system to which this sensor attaches.

Here is the caller graph for this function:

virtual size_t getNumOutputs ( ) const
inlinevirtual
virtual bool isDirectFeedthrough ( ) const
inlinevirtual

Reimplemented in RigidBodyAccelerometer.

virtual Eigen::VectorXd output ( const double t,
const KinematicsCache< double > &  rigid_body_state,
const RigidBodySystem::InputVector< double > &  u 
) const
pure virtual

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