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

#include <Karto.h>

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

Public Member Functions

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 ()
 

Protected Member Functions

 SensorData (const Name &rSensorName)
 

Private Member Functions

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

Private Attributes

CustomDataVector m_CustomData
 
Name m_SensorName
 
kt_int32s m_StateId
 
kt_double m_Time
 
kt_int32s m_UniqueId
 

Friends

class boost::serialization::access
 

Detailed Description

SensorData is a base class for all sensor data

Definition at line 5123 of file Karto.h.

Constructor & Destructor Documentation

◆ SensorData() [1/3]

karto::SensorData::SensorData ( )
inline

Definition at line 5132 of file Karto.h.

◆ ~SensorData()

karto::SensorData::~SensorData ( )
virtual

Destructor

Definition at line 124 of file Karto.cpp.

◆ SensorData() [2/3]

karto::SensorData::SensorData ( const Name rSensorName)
protected

Construct a SensorData object with a sensor name

Definition at line 115 of file Karto.cpp.

◆ SensorData() [3/3]

karto::SensorData::SensorData ( const SensorData )
private

Restrict the copy constructor

Member Function Documentation

◆ AddCustomData()

void karto::SensorData::AddCustomData ( CustomData pCustomData)
inline

Add a CustomData object to sensor data

Parameters
pCustomData

Definition at line 5206 of file Karto.h.

◆ GetCustomData()

const CustomDataVector& karto::SensorData::GetCustomData ( ) const
inline

Get all custom data objects assigned to sensor data

Returns
CustomDataVector&

Definition at line 5215 of file Karto.h.

◆ GetSensorName()

const Name& karto::SensorData::GetSensorName ( ) const
inline

Get the sensor that created this sensor data

Returns
sensor

Definition at line 5197 of file Karto.h.

◆ GetStateId()

kt_int32s karto::SensorData::GetStateId ( ) const
inline

Gets sensor data id

Returns
sensor id

Definition at line 5143 of file Karto.h.

◆ GetTime()

kt_double karto::SensorData::GetTime ( ) const
inline

Gets sensor data time

Returns
time

Definition at line 5179 of file Karto.h.

◆ GetUniqueId()

kt_int32s karto::SensorData::GetUniqueId ( ) const
inline

Gets sensor unique id

Returns
unique id

Definition at line 5161 of file Karto.h.

◆ operator=()

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

Restrict the assignment operator

◆ serialize()

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

Definition at line 5262 of file Karto.h.

◆ SetStateId()

void karto::SensorData::SetStateId ( kt_int32s  stateId)
inline

Sets sensor data id

Parameters
stateIdid

Definition at line 5152 of file Karto.h.

◆ SetTime()

void karto::SensorData::SetTime ( kt_double  time)
inline

Sets sensor data time

Parameters
time

Definition at line 5188 of file Karto.h.

◆ SetUniqueId()

void karto::SensorData::SetUniqueId ( kt_int32u  uniqueId)
inline

Sets sensor unique id

Parameters
uniqueId

Definition at line 5170 of file Karto.h.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 5260 of file Karto.h.

Member Data Documentation

◆ m_CustomData

CustomDataVector karto::SensorData::m_CustomData
private

Definition at line 5258 of file Karto.h.

◆ m_SensorName

Name karto::SensorData::m_SensorName
private

Sensor that created this sensor data

Definition at line 5251 of file Karto.h.

◆ m_StateId

kt_int32s karto::SensorData::m_StateId
private

ID unique to individual sensor

Definition at line 5241 of file Karto.h.

◆ m_Time

kt_double karto::SensorData::m_Time
private

Time the sensor data was created

Definition at line 5256 of file Karto.h.

◆ m_UniqueId

kt_int32s karto::SensorData::m_UniqueId
private

ID unique across all sensor data

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