Public Member Functions | Private Attributes
rviz::FailedTool Class Reference

A FailedTool instance represents a Tool class we tried and failed to instantiate. More...

#include <failed_tool.h>

Inheritance diagram for rviz::FailedTool:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void activate ()
virtual void deactivate ()
 FailedTool (const QString &desired_class_id, const QString &error_message)
virtual QString getDescription () const
 Set the description of the tool. This is called by ToolManager during tool initialization.
virtual void load (const Config &config)
 Store the given config data for later, so we can return it with save() when someone writes this back to a file.
virtual int processMouseEvent (ViewportMouseEvent &event)
virtual void save (Config config) const
 Copy saved config data from last call to load() into config.

Private Attributes

QString error_message_
Config saved_config_

Detailed Description

A FailedTool instance represents a Tool class we tried and failed to instantiate.

FailedTool stores the class id which it was supposed to be, and an error message describing the failure.

The load() and save() functions work together to ensure that loaded configuration data is saved out again without modification. This ensures that running rviz with a missing plugin library won't damage config files which refer to it.

Definition at line 47 of file failed_tool.h.


Constructor & Destructor Documentation

rviz::FailedTool::FailedTool ( const QString &  desired_class_id,
const QString &  error_message 
)

Definition at line 40 of file failed_tool.cpp.


Member Function Documentation

void rviz::FailedTool::activate ( ) [virtual]

Implements rviz::Tool.

Definition at line 64 of file failed_tool.cpp.

virtual void rviz::FailedTool::deactivate ( ) [inline, virtual]

Implements rviz::Tool.

Definition at line 55 of file failed_tool.h.

QString rviz::FailedTool::getDescription ( ) const [virtual]

Set the description of the tool. This is called by ToolManager during tool initialization.

Reimplemented from rviz::Tool.

Definition at line 46 of file failed_tool.cpp.

void rviz::FailedTool::load ( const Config config) [virtual]

Store the given config data for later, so we can return it with save() when someone writes this back to a file.

Reimplemented from rviz::Tool.

Definition at line 51 of file failed_tool.cpp.

virtual int rviz::FailedTool::processMouseEvent ( ViewportMouseEvent event) [inline, virtual]

Process a mouse event. This is the central function of all the tools, as it defines how the mouse is used.

Reimplemented from rviz::Tool.

Definition at line 57 of file failed_tool.h.

void rviz::FailedTool::save ( Config  config) const [virtual]

Copy saved config data from last call to load() into config.

Reimplemented from rviz::Tool.

Definition at line 56 of file failed_tool.cpp.


Member Data Documentation

Definition at line 68 of file failed_tool.h.

Definition at line 67 of file failed_tool.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Thu Aug 27 2015 15:02:28