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

#include <Karto.h>

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

Public Member Functions

 Module (const std::string &rName)
 
virtual kt_bool Process (karto::Object *)
 
virtual void Reset ()=0
 
virtual ~Module ()
 
- 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

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

Friends

class boost::serialization::access
 

Detailed Description

Abstract base class for Karto modules.

Definition at line 818 of file Karto.h.

Constructor & Destructor Documentation

◆ Module() [1/2]

karto::Module::Module ( const std::string &  rName)

Construct a Module

Parameters
rNamemodule name

Definition at line 88 of file Karto.cpp.

◆ ~Module()

karto::Module::~Module ( )
virtual

Destructor

Definition at line 93 of file Karto.cpp.

◆ Module() [2/2]

karto::Module::Module ( const Module )
private

Member Function Documentation

◆ operator=()

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

◆ Process()

virtual kt_bool karto::Module::Process ( karto::Object )
inlinevirtual

Process an Object

Reimplemented in karto::Mapper.

Definition at line 846 of file Karto.h.

◆ Reset()

virtual void karto::Module::Reset ( )
pure virtual

Reset the module

Implemented in karto::Mapper.

◆ serialize()

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

Definition at line 857 of file Karto.h.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 855 of file Karto.h.


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


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