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

#include <Karto.h>

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

Public Member Functions

LaserRangeFinderGetLaserRangeFinder () const
 
kt_int32u GetNumberOfRangeReadings () const
 
kt_doubleGetRangeReadings () const
 
RangeReadingsVector GetRangeReadingsVector () const
 
 LaserRangeScan (const Name &rSensorName)
 
 LaserRangeScan ()
 
 LaserRangeScan (const Name &rSensorName, const RangeReadingsVector &rRangeReadings)
 
void SetRangeReadings (const RangeReadingsVector &rRangeReadings)
 
virtual ~LaserRangeScan ()
 
- Public Member Functions inherited from karto::SensorData
void AddCustomData (CustomData *pCustomData)
 
const CustomDataVectorGetCustomData () const
 
const NameGetSensorName () const
 
kt_int32s GetStateId () const
 
kt_double GetTime () const
 
kt_int32s GetUniqueId () const
 
 SensorData ()
 
void SetStateId (kt_int32s stateId)
 
void SetTime (kt_double time)
 
void SetUniqueId (kt_int32u uniqueId)
 
virtual ~SensorData ()
 
- 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

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

Private Attributes

kt_int32u m_NumberOfRangeReadings
 
kt_doublem_pRangeReadings
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Member Functions inherited from karto::SensorData
 SensorData (const Name &rSensorName)
 

Detailed Description

LaserRangeScan representing the range readings from a laser range finder sensor.

Definition at line 5286 of file Karto.h.

Constructor & Destructor Documentation

◆ LaserRangeScan() [1/4]

karto::LaserRangeScan::LaserRangeScan ( const Name rSensorName)
inline

Constructs a scan from the given sensor with the given readings

Parameters
rSensorName

Definition at line 5298 of file Karto.h.

◆ LaserRangeScan() [2/4]

karto::LaserRangeScan::LaserRangeScan ( )
inline

Definition at line 5305 of file Karto.h.

◆ LaserRangeScan() [3/4]

karto::LaserRangeScan::LaserRangeScan ( const Name rSensorName,
const RangeReadingsVector rRangeReadings 
)
inline

Constructs a scan from the given sensor with the given readings

Parameters
rSensorName
rRangeReadings

Definition at line 5314 of file Karto.h.

◆ ~LaserRangeScan()

virtual karto::LaserRangeScan::~LaserRangeScan ( )
inlinevirtual

Destructor

Definition at line 5327 of file Karto.h.

◆ LaserRangeScan() [4/4]

karto::LaserRangeScan::LaserRangeScan ( const LaserRangeScan )
private

Member Function Documentation

◆ GetLaserRangeFinder()

LaserRangeFinder* karto::LaserRangeScan::GetLaserRangeFinder ( ) const
inline

Gets the laser range finder sensor that generated this scan

Returns
laser range finder sensor of this scan

Definition at line 5395 of file Karto.h.

◆ GetNumberOfRangeReadings()

kt_int32u karto::LaserRangeScan::GetNumberOfRangeReadings ( ) const
inline

Gets the number of range readings

Returns
number of range readings

Definition at line 5404 of file Karto.h.

◆ GetRangeReadings()

kt_double* karto::LaserRangeScan::GetRangeReadings ( ) const
inline

Gets the range readings of this scan

Returns
range readings of this scan

Definition at line 5338 of file Karto.h.

◆ GetRangeReadingsVector()

RangeReadingsVector karto::LaserRangeScan::GetRangeReadingsVector ( ) const
inline

Definition at line 5343 of file Karto.h.

◆ operator=()

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

◆ serialize()

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

Definition at line 5419 of file Karto.h.

◆ SetRangeReadings()

void karto::LaserRangeScan::SetRangeReadings ( const RangeReadingsVector rRangeReadings)
inline

Sets the range readings for this scan

Parameters
rRangeReadings

Definition at line 5352 of file Karto.h.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 5417 of file Karto.h.

Member Data Documentation

◆ m_NumberOfRangeReadings

kt_int32u karto::LaserRangeScan::m_NumberOfRangeReadings
private

Definition at line 5415 of file Karto.h.

◆ m_pRangeReadings

kt_double* karto::LaserRangeScan::m_pRangeReadings
private

Definition at line 5414 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