rviz::Plugin Class Reference

#include <plugin.h>

List of all members.

Public Member Functions
void	autoLoad ()
Display *	createDisplay (const std::string &class_name, const std::string &name, VisualizationManager *manager)
const L_ClassTypeInfo *	getClassTypeInfoList (const std::string &base_class) const
YAML::Node &	getDescription ()
const std::string &	getDescriptionPath () const
DisplayTypeInfoPtr	getDisplayTypeInfo (const std::string &class_name) const
DisplayTypeInfoPtr	getDisplayTypeInfoByDisplayName (const std::string &display_name) const
const L_DisplayTypeInfo &	getDisplayTypeInfoList () const
PluginStatusSignal &	getLoadedSignal ()
PluginStatusSignal &	getLoadingSignal ()
const std::string &	getName ()
const std::string &	getPackageName () const
PluginStatusSignal &	getUnloadedSignal ()
PluginStatusSignal &	getUnloadingSignal ()
bool	isAutoLoad ()
bool	isLoaded ()
void	load ()
void	loadDescription (const std::string &description_path)
const std::string &	mapDisplayClassName (const std::string &class_name) const
const std::string &	mapDisplayName (const std::string &name) const
	Plugin ()
void	setAutoLoad (bool autoload)
void	unload ()
	~Plugin ()
Private Attributes
bool	auto_load_
bool	auto_load_tried_
M_ClassTypeInfo	class_info_
std::string	description_path_
M_string	display_class_mappings_
L_DisplayTypeInfo	display_info_
M_string	display_name_mappings_
YAML::Node *	doc_
wxDynamicLibrary	library_
std::string	library_path_
bool	loaded_
PluginStatusSignal	loaded_signal_
PluginStatusSignal	loading_signal_
std::string	name_
std::string	package_name_
PluginStatusSignal	unloaded_signal_
PluginStatusSignal	unloading_signal_

---

Detailed Description

Definition at line 101 of file plugin.h.

---

Constructor & Destructor Documentation

rviz::Plugin::Plugin

(

)

Definition at line 38 of file plugin.cpp.

rviz::Plugin::~Plugin

(

)

Definition at line 47 of file plugin.cpp.

---

Member Function Documentation

void rviz::Plugin::autoLoad

(

)

Definition at line 358 of file plugin.cpp.

Display * rviz::Plugin::createDisplay	(	const std::string &	class_name,
		const std::string &	name,
		VisualizationManager *	manager
	)

Definition at line 378 of file plugin.cpp.

const L_ClassTypeInfo * rviz::Plugin::getClassTypeInfoList

(

const std::string &

base_class

)

const

Definition at line 250 of file plugin.cpp.

YAML::Node& rviz::Plugin::getDescription

(

)

[inline]

Definition at line 135 of file plugin.h.

const std::string& rviz::Plugin::getDescriptionPath

(

)

const [inline]

Definition at line 124 of file plugin.h.

DisplayTypeInfoPtr rviz::Plugin::getDisplayTypeInfo

(

const std::string &

class_name

)

const

Definition at line 313 of file plugin.cpp.

DisplayTypeInfoPtr rviz::Plugin::getDisplayTypeInfoByDisplayName

(

const std::string &

display_name

)

const

Definition at line 341 of file plugin.cpp.

const L_DisplayTypeInfo& rviz::Plugin::getDisplayTypeInfoList

(

)

const [inline]

Definition at line 117 of file plugin.h.

PluginStatusSignal& rviz::Plugin::getLoadedSignal

(

)

[inline]

Definition at line 131 of file plugin.h.

PluginStatusSignal& rviz::Plugin::getLoadingSignal

(

)

[inline]

Definition at line 130 of file plugin.h.

const std::string& rviz::Plugin::getName

(

)

[inline]

Definition at line 125 of file plugin.h.

const std::string& rviz::Plugin::getPackageName

(

)

const [inline]

Definition at line 123 of file plugin.h.

PluginStatusSignal& rviz::Plugin::getUnloadedSignal

(

)

[inline]

Definition at line 133 of file plugin.h.

PluginStatusSignal& rviz::Plugin::getUnloadingSignal

(

)

[inline]

Definition at line 132 of file plugin.h.

bool rviz::Plugin::isAutoLoad

(

)

Definition at line 292 of file plugin.cpp.

bool rviz::Plugin::isLoaded

(

)

Definition at line 287 of file plugin.cpp.

void rviz::Plugin::load

(

)

Definition at line 170 of file plugin.cpp.

void rviz::Plugin::loadDescription

(

const std::string &

description_path

)

Definition at line 54 of file plugin.cpp.

const std::string & rviz::Plugin::mapDisplayClassName

(

const std::string &

class_name

)

const

Definition at line 302 of file plugin.cpp.

const std::string & rviz::Plugin::mapDisplayName

(

const std::string &

name

)

const

Definition at line 330 of file plugin.cpp.

void rviz::Plugin::setAutoLoad

(

bool

autoload

)

Definition at line 297 of file plugin.cpp.

void rviz::Plugin::unload

(

)

Definition at line 261 of file plugin.cpp.

---

Member Data Documentation

bool rviz::Plugin::auto_load_ [private]

Definition at line 154 of file plugin.h.

bool rviz::Plugin::auto_load_tried_ [private]

Definition at line 155 of file plugin.h.

M_ClassTypeInfo rviz::Plugin::class_info_ [private]

Definition at line 149 of file plugin.h.

std::string rviz::Plugin::description_path_ [private]

Definition at line 140 of file plugin.h.

M_string rviz::Plugin::display_class_mappings_ [private]

Definition at line 146 of file plugin.h.

L_DisplayTypeInfo rviz::Plugin::display_info_ [private]

Definition at line 145 of file plugin.h.

M_string rviz::Plugin::display_name_mappings_ [private]

Definition at line 147 of file plugin.h.

YAML::Node* rviz::Plugin::doc_ [private]

Definition at line 162 of file plugin.h.

wxDynamicLibrary rviz::Plugin::library_ [private]

Definition at line 151 of file plugin.h.

std::string rviz::Plugin::library_path_ [private]

Definition at line 142 of file plugin.h.

bool rviz::Plugin::loaded_ [private]

Definition at line 153 of file plugin.h.

PluginStatusSignal rviz::Plugin::loaded_signal_ [private]

Definition at line 158 of file plugin.h.

PluginStatusSignal rviz::Plugin::loading_signal_ [private]

Definition at line 157 of file plugin.h.

std::string rviz::Plugin::name_ [private]

Definition at line 143 of file plugin.h.

std::string rviz::Plugin::package_name_ [private]

Definition at line 141 of file plugin.h.

PluginStatusSignal rviz::Plugin::unloaded_signal_ [private]

Definition at line 160 of file plugin.h.

PluginStatusSignal rviz::Plugin::unloading_signal_ [private]

Definition at line 159 of file plugin.h.

---

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

• plugin.h
• plugin.cpp