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

#include <Karto.h>

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

Public Member Functions

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

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

Private Attributes

Name m_Name
 
ParameterManagerm_pParameterManager
 

Friends

class boost::serialization::access
 

Detailed Description

Abstract base class for Karto objects.

Definition at line 632 of file Karto.h.

Constructor & Destructor Documentation

◆ Object() [1/3]

karto::Object::Object ( )

Default constructor

Definition at line 67 of file Karto.cpp.

◆ Object() [2/3]

karto::Object::Object ( const Name rName)

Constructs an object with the given name

Parameters
rName

Definition at line 72 of file Karto.cpp.

◆ ~Object()

karto::Object::~Object ( )
virtual

Default constructor

Definition at line 78 of file Karto.cpp.

◆ Object() [3/3]

karto::Object::Object ( const Object )

Member Function Documentation

◆ GetClassName()

virtual const char* karto::Object::GetClassName ( ) const
pure virtual

Gets the class name of this object

Returns
class name

◆ GetName()

const Name& karto::Object::GetName ( ) const
inline

Gets the name of this object

Returns
name

Definition at line 656 of file Karto.h.

◆ GetObjectType()

virtual kt_objecttype karto::Object::GetObjectType ( ) const
pure virtual

Gets the type of this object

Returns
object type

◆ GetParameter()

AbstractParameter* karto::Object::GetParameter ( const std::string &  rName) const
inline

Gets the named parameter

Parameters
rNamename of parameter
Returns
parameter

Definition at line 687 of file Karto.h.

◆ GetParameterManager()

virtual ParameterManager* karto::Object::GetParameterManager ( )
inlinevirtual

Gets the parameter manager of this dataset

Returns
parameter manager

Definition at line 677 of file Karto.h.

◆ GetParameters()

const ParameterVector& karto::Object::GetParameters ( ) const
inline

Gets all parameters

Returns
parameters

Definition at line 704 of file Karto.h.

◆ operator=()

const Object& karto::Object::operator= ( const Object )

◆ serialize()

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

Definition at line 720 of file Karto.h.

◆ SetParameter()

template<typename T >
void karto::Object::SetParameter ( const std::string &  rName,
value 
)
inline

Sets the parameter with the given name with the given value

Parameters
rNamename
valuevalue

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Serialization: class Object

Definition at line 718 of file Karto.h.

Member Data Documentation

◆ m_Name

Name karto::Object::m_Name
private

Definition at line 713 of file Karto.h.

◆ m_pParameterManager

ParameterManager* karto::Object::m_pParameterManager
private

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