Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
grid_map_rviz_plugin::MessageFilterDisplay< MessageType > Class Template Referenceabstract

Display subclass using a tf2_ros::MessageFilter, templated on the ROS message type. More...

#include <message_filter_display.h>

Inheritance diagram for grid_map_rviz_plugin::MessageFilterDisplay< MessageType >:
Inheritance graph
[legend]

Public Types

typedef MessageFilterDisplay< MessageType > MFDClass
 Convenience typedef so subclasses don't have to use the long templated class name to refer to their super class. More...
 

Public Member Functions

 MessageFilterDisplay ()
 
void onInitialize () override
 
void reset () override
 
void setTopic (const QString &topic, const QString &) override
 
 ~MessageFilterDisplay () override
 
- Public Member Functions inherited from grid_map_rviz_plugin::_RosTopicDisplay
 _RosTopicDisplay ()
 
- Public Member Functions inherited from rviz::Display
virtual void deleteStatus (const QString &name)
 
void deleteStatusStd (const std::string &name)
 
 Display ()
 
void emitTimeSignal (ros::Time time)
 
QWidget * getAssociatedWidget () const
 
PanelDockWidgetgetAssociatedWidgetPanel ()
 
virtual QString getClassId () const
 
Ogre::SceneNode * getSceneNode () const
 
virtual QVariant getViewData (int column, int role) const
 
virtual Qt::ItemFlags getViewFlags (int column) const
 
uint32_t getVisibilityBits ()
 
void initialize (DisplayContext *context)
 
bool isEnabled () const
 
virtual void load (const Config &config)
 
virtual void save (Config config) const
 
void setAssociatedWidget (QWidget *widget)
 
virtual void setClassId (const QString &class_id)
 
void setFixedFrame (const QString &fixed_frame)
 
void setName (const QString &name)
 
virtual void setStatus (StatusProperty::Level level, const QString &name, const QString &text)
 
void setStatusStd (StatusProperty::Level level, const std::string &name, const std::string &text)
 
void setVisibilityBits (uint32_t bits)
 
void unsetVisibilityBits (uint32_t bits)
 
virtual void update (float wall_dt, float ros_dt)
 
virtual ~Display ()
 
- Public Member Functions inherited from rviz::BoolProperty
 BoolProperty (const QString &name=QString(), bool default_value=false, const QString &description=QString(), Property *parent=0, const char *changed_slot=0, QObject *receiver=0)
 
virtual bool getBool () const
 
virtual bool getDisableChildren ()
 
bool getDisableChildrenIfFalse ()
 
void setDisableChildrenIfFalse (bool disable)
 
virtual ~BoolProperty ()
 
- Public Member Functions inherited from rviz::Property
virtual void addChild (Property *child, int index=-1)
 
PropertychildAt (int index) const
 
virtual PropertychildAtUnchecked (int index) const
 
virtual void collapse ()
 
bool contains (Property *possible_child) const
 
virtual QWidget * createEditor (QWidget *parent, const QStyleOptionViewItem &option)
 
virtual void expand ()
 
virtual QString getDescription () const
 
virtual bool getHidden () const
 
virtual QIcon getIcon () const
 
PropertyTreeModelgetModel () const
 
virtual QString getName () const
 
std::string getNameStd () const
 
PropertygetParent () const
 
virtual bool getReadOnly ()
 
virtual QVariant getValue () const
 
void hide ()
 
bool isAncestorOf (Property *possible_child) const
 
virtual void moveChild (int from_index, int to_index)
 
virtual int numChildren () const
 
virtual bool paint (QPainter *painter, const QStyleOptionViewItem &option) const
 
 Property (const QString &name=QString(), const QVariant default_value=QVariant(), const QString &description=QString(), Property *parent=0, const char *changed_slot=0, QObject *receiver=0)
 
virtual void removeChildren (int start_index=0, int count=-1)
 
int rowNumberInParent () const
 
virtual void setDescription (const QString &description)
 
virtual void setHidden (bool hidden)
 
virtual void setIcon (const QIcon &icon)
 
void setModel (PropertyTreeModel *model)
 
void setParent (Property *new_parent)
 
virtual void setReadOnly (bool read_only)
 
void setShouldBeSaved (bool save)
 
virtual bool setValue (const QVariant &new_value)
 
bool shouldBeSaved () const
 
void show ()
 
virtual PropertysubProp (const QString &sub_name)
 
PropertytakeChild (Property *child)
 
virtual PropertytakeChildAt (int index)
 
virtual ~Property ()
 

Protected Member Functions

void fixedFrameChanged () override
 
void incomingMessage (const typename MessageType::ConstPtr &msg)
 Incoming message callback. Checks if the message pointer is valid, increments messages_received_, then calls processMessage(). More...
 
void onDisable () override
 
void onEnable () override
 
virtual void processMessage (const typename MessageType::ConstPtr &msg)=0
 Implement this to process the contents of a message. More...
 
virtual void subscribe ()
 
virtual void unsubscribe ()
 
void updateTopic () override
 
- Protected Member Functions inherited from rviz::Display
virtual void clearStatuses ()
 
bool initialized () const
 
- Protected Member Functions inherited from rviz::Property
void loadValue (const Config &config)
 

Protected Attributes

uint32_t messages_received_
 
message_filters::Subscriber< MessageType > sub_
 
tf2_ros::MessageFilter< MessageType > * tf_filter_
 
- Protected Attributes inherited from grid_map_rviz_plugin::_RosTopicDisplay
rviz::RosTopicPropertytopic_property_
 
rviz::BoolPropertyunreliable_property_
 
- Protected Attributes inherited from rviz::Display
DisplayContextcontext_
 
QString fixed_frame_
 
Ogre::SceneManager * scene_manager_
 
Ogre::SceneNode * scene_node_
 
ros::NodeHandle threaded_nh_
 
ros::NodeHandle update_nh_
 
- Protected Attributes inherited from rviz::Property
bool child_indexes_valid_
 
QIcon icon_
 
PropertyTreeModelmodel_
 
QVariant value_
 

Additional Inherited Members

- Public Slots inherited from rviz::Display
virtual void onEnableChanged ()
 
void queueRender ()
 
void setEnabled (bool enabled)
 
virtual void setIcon (const QIcon &icon)
 
- Public Slots inherited from rviz::BoolProperty
bool setBool (bool value)
 
- Signals inherited from rviz::Display
void timeSignal (rviz::Display *display, ros::Time time)
 
- Signals inherited from rviz::Property
void aboutToChange ()
 
void changed ()
 
void childListChanged (Property *this_property)
 
- Protected Slots inherited from grid_map_rviz_plugin::_RosTopicDisplay

Detailed Description

template<class MessageType>
class grid_map_rviz_plugin::MessageFilterDisplay< MessageType >

Display subclass using a tf2_ros::MessageFilter, templated on the ROS message type.

This class brings together some common things used in many Display types. It has a tf2_ros::MessageFilter to filter incoming messages, and it handles subscribing and unsubscribing when the display is enabled or disabled. It also has an Ogre::SceneNode which

Definition at line 70 of file message_filter_display.h.

Member Typedef Documentation

template<class MessageType>
typedef MessageFilterDisplay<MessageType> grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::MFDClass

Convenience typedef so subclasses don't have to use the long templated class name to refer to their super class.

Definition at line 75 of file message_filter_display.h.

Constructor & Destructor Documentation

template<class MessageType>
grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::MessageFilterDisplay ( )
inline

Definition at line 77 of file message_filter_display.h.

template<class MessageType>
grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::~MessageFilterDisplay ( )
inlineoverride

Definition at line 91 of file message_filter_display.h.

Member Function Documentation

template<class MessageType>
void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::fixedFrameChanged ( )
inlineoverrideprotectedvirtual

Reimplemented from rviz::Display.

Definition at line 142 of file message_filter_display.h.

template<class MessageType>
void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::incomingMessage ( const typename MessageType::ConstPtr &  msg)
inlineprotected

Incoming message callback. Checks if the message pointer is valid, increments messages_received_, then calls processMessage().

Definition at line 150 of file message_filter_display.h.

template<class MessageType>
void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::onDisable ( )
inlineoverrideprotectedvirtual

Reimplemented from rviz::Display.

Definition at line 137 of file message_filter_display.h.

template<class MessageType>
void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::onEnable ( )
inlineoverrideprotectedvirtual

Reimplemented from rviz::Display.

Definition at line 135 of file message_filter_display.h.

template<class MessageType>
void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::onInitialize ( )
inlineoverridevirtual

Reimplemented from rviz::Display.

Definition at line 83 of file message_filter_display.h.

template<class MessageType>
virtual void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::processMessage ( const typename MessageType::ConstPtr &  msg)
protectedpure virtual

Implement this to process the contents of a message.

This is called by incomingMessage().

template<class MessageType>
void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::reset ( )
inlineoverridevirtual

Reimplemented from rviz::Display.

Definition at line 97 of file message_filter_display.h.

template<class MessageType>
void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::setTopic ( const QString &  topic,
const QString &   
)
inlineoverridevirtual

Reimplemented from rviz::Display.

Definition at line 105 of file message_filter_display.h.

template<class MessageType>
virtual void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::subscribe ( )
inlineprotectedvirtual

Definition at line 115 of file message_filter_display.h.

template<class MessageType>
virtual void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::unsubscribe ( )
inlineprotectedvirtual

Definition at line 133 of file message_filter_display.h.

template<class MessageType>
void grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::updateTopic ( )
inlineoverrideprotectedvirtual

Implements grid_map_rviz_plugin::_RosTopicDisplay.

Definition at line 108 of file message_filter_display.h.

Member Data Documentation

template<class MessageType>
uint32_t grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::messages_received_
protected

Definition at line 168 of file message_filter_display.h.

template<class MessageType>
message_filters::Subscriber<MessageType> grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::sub_
protected

Definition at line 166 of file message_filter_display.h.

template<class MessageType>
tf2_ros::MessageFilter<MessageType>* grid_map_rviz_plugin::MessageFilterDisplay< MessageType >::tf_filter_
protected

Definition at line 167 of file message_filter_display.h.


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


grid_map_rviz_plugin
Author(s): Philipp Krüsi , Péter Fankhauser
autogenerated on Tue Jun 1 2021 02:13:47