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

Public Member Functions

void AddRunningScan (LocalizedRangeScan *pScan)
 
void AddScan (LocalizedRangeScan *pScan, kt_int32s uniqueId)
 
void Clear ()
 
void ClearLastScan ()
 
void ClearRunningScans ()
 
LocalizedRangeScanGetLastScan ()
 
kt_int32uGetRunningScanBufferSize ()
 
LocalizedRangeScanVectorGetRunningScans ()
 
LocalizedRangeScanMapGetScans ()
 
void RemoveScan (LocalizedRangeScan *pScan)
 
 ScanManager ()
 
 ScanManager (kt_int32u runningBufferMaximumSize, kt_double runningBufferMaximumDistance)
 
void SetLastScan (LocalizedRangeScan *pScan)
 
void SetRunningScanBufferMaximumDistance (const kt_int32u &rScanBufferMaxDistance)
 
void SetRunningScanBufferSize (const kt_int32u &rScanBufferSize)
 
virtual ~ScanManager ()
 

Private Member Functions

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

Private Attributes

kt_int32u m_NextStateId
 
LocalizedRangeScanm_pLastScan
 
kt_double m_RunningBufferMaximumDistance
 
kt_int32u m_RunningBufferMaximumSize
 
LocalizedRangeScanVector m_RunningScans
 
LocalizedRangeScanMap m_Scans
 

Friends

class boost::serialization::access
 

Detailed Description

Manages the scan data for a device

Definition at line 57 of file Mapper.cpp.

Constructor & Destructor Documentation

◆ ScanManager() [1/2]

karto::ScanManager::ScanManager ( kt_int32u  runningBufferMaximumSize,
kt_double  runningBufferMaximumDistance 
)
inline

Default constructor

Definition at line 63 of file Mapper.cpp.

◆ ScanManager() [2/2]

karto::ScanManager::ScanManager ( )
inline

Definition at line 71 of file Mapper.cpp.

◆ ~ScanManager()

virtual karto::ScanManager::~ScanManager ( )
inlinevirtual

Destructor

Definition at line 76 of file Mapper.cpp.

Member Function Documentation

◆ AddRunningScan()

void karto::ScanManager::AddRunningScan ( LocalizedRangeScan pScan)
inline

Adds scan to vector of running scans

Parameters
pScan

Definition at line 176 of file Mapper.cpp.

◆ AddScan()

void karto::ScanManager::AddScan ( LocalizedRangeScan pScan,
kt_int32s  uniqueId 
)
inline

Adds scan to vector of processed scans tagging scan with given unique id

Parameters
pScan

Definition at line 86 of file Mapper.cpp.

◆ Clear()

void karto::ScanManager::Clear ( )
inline

Deletes data of this buffered device

Definition at line 228 of file Mapper.cpp.

◆ ClearLastScan()

void karto::ScanManager::ClearLastScan ( )
inline

Clears last scan

Parameters
deviceId

Definition at line 113 of file Mapper.cpp.

◆ ClearRunningScans()

void karto::ScanManager::ClearRunningScans ( )
inline

Clears the vector of running scans

Definition at line 220 of file Mapper.cpp.

◆ GetLastScan()

LocalizedRangeScan* karto::ScanManager::GetLastScan ( )
inline

Gets last scan

Parameters
deviceId
Returns
last localized range scan

Definition at line 104 of file Mapper.cpp.

◆ GetRunningScanBufferSize()

kt_int32u& karto::ScanManager::GetRunningScanBufferSize ( )
inline

Gets running scan buffer size

Returns
running scan buffer size

Definition at line 149 of file Mapper.cpp.

◆ GetRunningScans()

LocalizedRangeScanVector& karto::ScanManager::GetRunningScans ( )
inline

Gets running scans

Returns
running scans

Definition at line 140 of file Mapper.cpp.

◆ GetScans()

LocalizedRangeScanMap& karto::ScanManager::GetScans ( )
inline

Gets scans

Returns
scans

Definition at line 131 of file Mapper.cpp.

◆ RemoveScan()

void karto::ScanManager::RemoveScan ( LocalizedRangeScan pScan)
inline

Finds and replaces a scan from m_scans with NULL

Parameters
pScan

Definition at line 203 of file Mapper.cpp.

◆ serialize()

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

Definition at line 237 of file Mapper.cpp.

◆ SetLastScan()

void karto::ScanManager::SetLastScan ( LocalizedRangeScan pScan)
inline

Sets the last scan

Parameters
pScan

Definition at line 122 of file Mapper.cpp.

◆ SetRunningScanBufferMaximumDistance()

void karto::ScanManager::SetRunningScanBufferMaximumDistance ( const kt_int32u rScanBufferMaxDistance)
inline

Sets running scan buffer maximum distance

Parameters
rScanBufferMaxDistance

Definition at line 167 of file Mapper.cpp.

◆ SetRunningScanBufferSize()

void karto::ScanManager::SetRunningScanBufferSize ( const kt_int32u rScanBufferSize)
inline

Sets running scan buffer size

Parameters
rScanBufferSize

Definition at line 158 of file Mapper.cpp.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 235 of file Mapper.cpp.

Member Data Documentation

◆ m_NextStateId

kt_int32u karto::ScanManager::m_NextStateId
private

Definition at line 251 of file Mapper.cpp.

◆ m_pLastScan

LocalizedRangeScan* karto::ScanManager::m_pLastScan
private

Definition at line 250 of file Mapper.cpp.

◆ m_RunningBufferMaximumDistance

kt_double karto::ScanManager::m_RunningBufferMaximumDistance
private

Definition at line 254 of file Mapper.cpp.

◆ m_RunningBufferMaximumSize

kt_int32u karto::ScanManager::m_RunningBufferMaximumSize
private

Definition at line 253 of file Mapper.cpp.

◆ m_RunningScans

LocalizedRangeScanVector karto::ScanManager::m_RunningScans
private

Definition at line 249 of file Mapper.cpp.

◆ m_Scans

LocalizedRangeScanMap karto::ScanManager::m_Scans
private

Definition at line 248 of file Mapper.cpp.


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


slam_toolbox
Author(s): Steve Macenski
autogenerated on Thu Jan 11 2024 03:37:56