Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
karto::Sensor Class Referenceabstract

#include <Karto.h>

Inheritance diagram for karto::Sensor:
Inheritance graph
[legend]

Public Member Functions

const Pose2GetOffsetPose () const
 
 Sensor ()
 
void SetOffsetPose (const Pose2 &rPose)
 
virtual kt_bool Validate ()=0
 
virtual kt_bool Validate (SensorData *pSensorData)=0
 
virtual ~Sensor ()
 
- Public Member Functions inherited from karto::Object
virtual const char * GetClassName () const =0
 
const NameGetName () const
 
virtual kt_objecttype GetObjectType () const =0
 
AbstractParameterGetParameter (const std::string &rName) const
 
virtual ParameterManagerGetParameterManager ()
 
const ParameterVectorGetParameters () const
 
 Object ()
 
 Object (const Name &rName)
 
 Object (const Object &)
 
const Objectoperator= (const Object &)
 
template<typename T >
void SetParameter (const std::string &rName, T value)
 
virtual ~Object ()
 
- Public Member Functions inherited from karto::NonCopyable
 NonCopyable ()
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
virtual ~NonCopyable ()
 

Protected Member Functions

 Sensor (const Name &rName)
 

Private Member Functions

const Sensoroperator= (const Sensor &)
 
 Sensor (const Sensor &)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

Parameter< Pose2 > * m_pOffsetPose
 

Friends

class boost::serialization::access
 

Detailed Description

Abstract Sensor base class

Definition at line 3598 of file Karto.h.

Constructor & Destructor Documentation

◆ Sensor() [1/3]

karto::Sensor::Sensor ( )
inline

Serialization: class Sensor

Definition at line 3605 of file Karto.h.

◆ Sensor() [2/3]

karto::Sensor::Sensor ( const Name rName)
protected

Construct a Sensor

Parameters
rNamesensor name

Definition at line 101 of file Karto.cpp.

◆ ~Sensor()

karto::Sensor::~Sensor ( )
virtual

Destructor

Definition at line 107 of file Karto.cpp.

◆ Sensor() [3/3]

karto::Sensor::Sensor ( const Sensor )
private

Restrict the copy constructor

Member Function Documentation

◆ GetOffsetPose()

const Pose2& karto::Sensor::GetOffsetPose ( ) const
inline

Gets this range finder sensor's offset

Returns
offset pose

Definition at line 3630 of file Karto.h.

◆ operator=()

const Sensor& karto::Sensor::operator= ( const Sensor )
private

Restrict the assignment operator

◆ serialize()

template<class Archive >
void karto::Sensor::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprivate

Definition at line 3675 of file Karto.h.

◆ SetOffsetPose()

void karto::Sensor::SetOffsetPose ( const Pose2 rPose)
inline

Sets this range finder sensor's offset

Parameters
rPose

Definition at line 3639 of file Karto.h.

◆ Validate() [1/2]

virtual kt_bool karto::Sensor::Validate ( )
pure virtual

Validates sensor

Returns
true if valid

Implemented in karto::LaserRangeFinder, and karto::Drive.

◆ Validate() [2/2]

virtual kt_bool karto::Sensor::Validate ( SensorData pSensorData)
pure virtual

Validates sensor data

Parameters
pSensorDatasensor data
Returns
true if valid

Implemented in karto::LaserRangeFinder, and karto::Drive.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 3673 of file Karto.h.

Member Data Documentation

◆ m_pOffsetPose

Parameter<Pose2>* karto::Sensor::m_pOffsetPose
private

Sensor offset pose

Definition at line 3672 of file Karto.h.


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


slam_toolbox
Author(s): Steve Macenski
autogenerated on Sat Oct 3 2020 03:51:02