Public Member Functions | Private Member Functions | Friends | List of all members
karto::Drive Class Reference

#include <Karto.h>

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

Public Member Functions

 Drive (const std::string &rName)
 
virtual kt_bool Validate ()
 
virtual kt_bool Validate (SensorData *pSensorData)
 
virtual ~Drive ()
 
- Public Member Functions inherited from karto::Sensor
const Pose2GetOffsetPose () const
 
 Sensor ()
 
void SetOffsetPose (const Pose2 &rPose)
 
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 ()
 

Private Member Functions

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

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Member Functions inherited from karto::Sensor
 Sensor (const Name &rName)
 

Detailed Description

Sensor that provides pose information relative to world coordinates.

The user can set the offset pose of the drive sensor. If no value is provided by the user the default is no offset, i.e, the sensor is initially at the world origin, oriented along the positive z axis.

Definition at line 3851 of file Karto.h.

Constructor & Destructor Documentation

◆ Drive() [1/2]

karto::Drive::Drive ( const std::string &  rName)
inline

Constructs a Drive object

Definition at line 3862 of file Karto.h.

◆ ~Drive()

virtual karto::Drive::~Drive ( )
inlinevirtual

Destructor

Definition at line 3869 of file Karto.h.

◆ Drive() [2/2]

karto::Drive::Drive ( const Drive )
private

Member Function Documentation

◆ operator=()

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

◆ serialize()

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

Definition at line 3894 of file Karto.h.

◆ Validate() [1/2]

virtual kt_bool karto::Drive::Validate ( )
inlinevirtual

Validates sensor

Returns
true if valid

Implements karto::Sensor.

Definition at line 3874 of file Karto.h.

◆ Validate() [2/2]

virtual kt_bool karto::Drive::Validate ( SensorData pSensorData)
inlinevirtual

Validates sensor data

Parameters
pSensorDatasensor data
Returns
true if valid

Implements karto::Sensor.

Definition at line 3879 of file Karto.h.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 3892 of file Karto.h.


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


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