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

A FailedDisplay instance represents a Display class we tried and failed to instantiate. More...

#include <failed_display.h>

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

List of all members.

Public Member Functions

 FailedDisplay (const QString &desired_class_id, const QString &error_message)
virtual QString getDescription () const
 Return the description.
virtual QVariant getViewData (int column, int role) const
 Return data appropriate for the given column (0 or 1) and role for this Display.
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 void save (Config config)
 Save Config equivalent to the last which was sent to load().

Private Attributes

QString error_message_
Config saved_config_

Detailed Description

A FailedDisplay instance represents a Display class we tried and failed to instantiate.

FailedDisplay 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_display.h.


Constructor & Destructor Documentation

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

Definition at line 41 of file failed_display.cpp.


Member Function Documentation

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

Return the description.

Reimplemented from rviz::Property.

Definition at line 62 of file failed_display.cpp.

QVariant rviz::FailedDisplay::getViewData ( int  column,
int  role 
) const [virtual]

Return data appropriate for the given column (0 or 1) and role for this Display.

Reimplemented from rviz::Display.

Definition at line 48 of file failed_display.cpp.

void rviz::FailedDisplay::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::Display.

Definition at line 67 of file failed_display.cpp.

void rviz::FailedDisplay::save ( Config  config) [virtual]

Save Config equivalent to the last which was sent to load().

Definition at line 73 of file failed_display.cpp.


Member Data Documentation

Definition at line 65 of file failed_display.h.

Definition at line 64 of file failed_display.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