failed_tool.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef FAILED_TOOL_H
30 #define FAILED_TOOL_H
31 
32 #include "tool.h"
33 
34 namespace rviz
35 {
46 class FailedTool : public Tool
47 {
48 public:
49  FailedTool(const QString& desired_class_id, const QString& error_message);
50 
51  virtual QString getDescription() const;
52 
53  void activate() override;
54  void deactivate() override
55  {
56  }
57 
58  int processMouseEvent(ViewportMouseEvent& /*event*/) override
59  {
60  return 0;
61  }
62 
65  void load(const Config& config) override;
66 
68  void save(Config config) const override;
69 
70 private:
72  QString error_message_;
73 };
74 
75 } // end namespace rviz
76 
77 #endif // FAILED_TOOL_H
rviz::FailedTool::getDescription
virtual QString getDescription() const
Definition: failed_tool.cpp:45
rviz::Tool
Definition: tool.h:56
rviz::FailedTool::processMouseEvent
int processMouseEvent(ViewportMouseEvent &) override
Definition: failed_tool.h:58
rviz::ViewportMouseEvent
Definition: viewport_mouse_event.h:45
rviz::FailedTool::error_message_
QString error_message_
Definition: failed_tool.h:72
tool.h
rviz::FailedTool::FailedTool
FailedTool(const QString &desired_class_id, const QString &error_message)
Definition: failed_tool.cpp:39
rviz
Definition: add_display_dialog.cpp:54
rviz::FailedTool::deactivate
void deactivate() override
Definition: failed_tool.h:54
rviz::FailedTool::load
void load(const Config &config) override
Store the given config data for later, so we can return it with save() when someone writes this back ...
Definition: failed_tool.cpp:51
rviz::FailedTool::save
void save(Config config) const override
Copy saved config data from last call to load() into config.
Definition: failed_tool.cpp:56
rviz::FailedTool::saved_config_
Config saved_config_
Definition: failed_tool.h:71
rviz::FailedTool::activate
void activate() override
Definition: failed_tool.cpp:64
rviz::FailedTool
A FailedTool instance represents a Tool class we tried and failed to instantiate.
Definition: failed_tool.h:46
rviz::Config
Configuration data storage class.
Definition: config.h:124


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Aug 2 2024 08:43:09