RobWorkProject  24.5.15-
Public Types | Public Member Functions | Protected Member Functions | List of all members
Sensor Class Reference

a generel hardware sensor interface. The sensor should interface to a statefull instance of either a real world sensor or a simulated sensor. The sensor interface acts as a realistic handle to controlling some specific instance of a sensor. More...

#include <Sensor.hpp>

Inherited by Camera, FTSensor, Scanner, and TactileArray.

Public Types

typedef rw::core::Ptr< SensorPtr
 smart pointer type
 

Public Member Functions

virtual ~Sensor ()
 destructor
 
const std::string & getName () const
 returns the name of this sensor More...
 
const std::string & getDescription () const
 returns a description of this sensor More...
 
rw::core::Ptr< rw::sensor::SensorModelgetSensorModel () const
 The frame to which the sensor is attached. More...
 
virtual void setSensorModel (rw::core::Ptr< rw::sensor::SensorModel > smodel)
 Sets the frame to which the sensor should be attached. More...
 
rw::core::PropertyMapgetPropertyMap ()
 gets the propertymap of this sensor
 
const rw::core::PropertyMapgetPropertyMap () const
 gets the propertymap of this sensor
 

Protected Member Functions

 Sensor (const std::string &name)
 constructor More...
 
 Sensor (const std::string &name, const std::string &description)
 constructor More...
 
void setName (const std::string &name)
 sets the name of this sensor More...
 
void setDescription (const std::string &description)
 sets the description of this sensor More...
 

Detailed Description

a generel hardware sensor interface. The sensor should interface to a statefull instance of either a real world sensor or a simulated sensor. The sensor interface acts as a realistic handle to controlling some specific instance of a sensor.

Constructor & Destructor Documentation

◆ Sensor() [1/2]

Sensor ( const std::string &  name)
protected

constructor

Parameters
name[in] the name of this sensor

◆ Sensor() [2/2]

Sensor ( const std::string &  name,
const std::string &  description 
)
protected

constructor

Parameters
name[in] the name of this sensor
description[in] description of the sensor

Member Function Documentation

◆ getDescription()

const std::string& getDescription ( ) const
inline

returns a description of this sensor

Returns
reference to this sensors description

◆ getName()

const std::string& getName ( ) const
inline

returns the name of this sensor

Returns
name of sensor

◆ getSensorModel()

rw::core::Ptr<rw::sensor::SensorModel> getSensorModel ( ) const
inline

The frame to which the sensor is attached.

The frame can be NULL.

◆ setDescription()

void setDescription ( const std::string &  description)
inlineprotected

sets the description of this sensor

Parameters
description[in] description of this sensor

◆ setName()

void setName ( const std::string &  name)
inlineprotected

sets the name of this sensor

Parameters
name[in] name of this sensor

◆ setSensorModel()

virtual void setSensorModel ( rw::core::Ptr< rw::sensor::SensorModel smodel)
inlinevirtual

Sets the frame to which the sensor should be attached.

Parameters
smodel

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