awviz_common::Display Class Reference

Intermediate class for display items. More...

#include <display.hpp>

Inheritance diagram for awviz_common::Display:

Public Member Functions
	Display ()=default
virtual	~Display ()=default
virtual void	initialize (rclcpp::Node::SharedPtr node, std::shared_ptr< rerun::RecordingStream > stream)=0
	Initialize attributes.
virtual void	set_property (const std::string &topic, const std::shared_ptr< std::unordered_map< std::string, std::string > > entity_roots)=0
	Set attributes of property.
virtual void	start ()=0
	Start to display.
virtual void	end ()=0
	End to display.
virtual bool	is_initialized () const
	Return true if the initialization is completed.

Protected Attributes
rclcpp::Node::SharedPtr	node_
	Node shared pointer.
std::shared_ptr< rerun::RecordingStream >	stream_
	RecordingStream shared pointer.
bool	is_initialized_
	Whether the object has been initialized.

Detailed Description

Intermediate class for display items.

Constructor & Destructor Documentation

Display()

awviz_common::Display::Display ( )

default

~Display()

virtual awviz_common::Display::~Display ( )

virtualdefault

Member Function Documentation

end()

virtual void awviz_common::Display::end ( )

pure virtual

End to display.

Implemented in awviz_common::RosTopicDisplay< MsgType >, awviz_common::RosTopicDisplay< sensor_msgs::msg::CameraInfo >, awviz_common::RosTopicDisplay< sensor_msgs::msg::CompressedImage >, awviz_common::RosTopicDisplay< autoware_perception_msgs::msg::DetectedObjects >, awviz_common::RosTopicDisplay< sensor_msgs::msg::Image >, awviz_common::RosTopicDisplay< sensor_msgs::msg::NavSatFix >, awviz_common::RosTopicDisplay< sensor_msgs::msg::PointCloud2 >, and awviz_common::RosTopicDisplay< autoware_perception_msgs::msg::TrackedObjects >.

initialize()

virtual void awviz_common::Display::initialize ( rclcpp::Node::SharedPtr  node, std::shared_ptr< rerun::RecordingStream >  stream  )

pure virtual

Initialize attributes.

Parameters

node	ROS node instance.
stream	Recording stream.

Implemented in awviz_common::RosTopicDisplay< MsgType >, awviz_common::RosTopicDisplay< sensor_msgs::msg::CameraInfo >, awviz_common::RosTopicDisplay< sensor_msgs::msg::CompressedImage >, awviz_common::RosTopicDisplay< autoware_perception_msgs::msg::DetectedObjects >, awviz_common::RosTopicDisplay< sensor_msgs::msg::Image >, awviz_common::RosTopicDisplay< sensor_msgs::msg::NavSatFix >, awviz_common::RosTopicDisplay< sensor_msgs::msg::PointCloud2 >, and awviz_common::RosTopicDisplay< autoware_perception_msgs::msg::TrackedObjects >.

is_initialized()

virtual bool awviz_common::Display::is_initialized ( ) const

inlinevirtual

Return true if the initialization is completed.

Returns

bool Return the value of the private member named is_initialized_.

Reimplemented in awviz_common::RosTopicDisplay< MsgType >, awviz_common::RosTopicDisplay< sensor_msgs::msg::CameraInfo >, awviz_common::RosTopicDisplay< sensor_msgs::msg::CompressedImage >, awviz_common::RosTopicDisplay< autoware_perception_msgs::msg::DetectedObjects >, awviz_common::RosTopicDisplay< sensor_msgs::msg::Image >, awviz_common::RosTopicDisplay< sensor_msgs::msg::NavSatFix >, awviz_common::RosTopicDisplay< sensor_msgs::msg::PointCloud2 >, and awviz_common::RosTopicDisplay< autoware_perception_msgs::msg::TrackedObjects >.

set_property()

virtual void awviz_common::Display::set_property ( const std::string &  topic, const std::shared_ptr< std::unordered_map< std::string, std::string > >  entity_roots  )

pure virtual

Set attributes of property.

Parameters

topic	Name of topic.
entity	Entity path of the record.

Implemented in awviz_common::RosTopicDisplay< MsgType >, awviz_common::RosTopicDisplay< sensor_msgs::msg::CameraInfo >, awviz_common::RosTopicDisplay< sensor_msgs::msg::CompressedImage >, awviz_common::RosTopicDisplay< autoware_perception_msgs::msg::DetectedObjects >, awviz_common::RosTopicDisplay< sensor_msgs::msg::Image >, awviz_common::RosTopicDisplay< sensor_msgs::msg::NavSatFix >, awviz_common::RosTopicDisplay< sensor_msgs::msg::PointCloud2 >, and awviz_common::RosTopicDisplay< autoware_perception_msgs::msg::TrackedObjects >.

start()

virtual void awviz_common::Display::start ( )

pure virtual

Start to display.

Implemented in awviz_common::RosTopicDisplay< MsgType >, awviz_common::RosTopicDisplay< sensor_msgs::msg::CameraInfo >, awviz_common::RosTopicDisplay< sensor_msgs::msg::CompressedImage >, awviz_common::RosTopicDisplay< autoware_perception_msgs::msg::DetectedObjects >, awviz_common::RosTopicDisplay< sensor_msgs::msg::Image >, awviz_common::RosTopicDisplay< sensor_msgs::msg::NavSatFix >, awviz_common::RosTopicDisplay< sensor_msgs::msg::PointCloud2 >, and awviz_common::RosTopicDisplay< autoware_perception_msgs::msg::TrackedObjects >.

Member Data Documentation

is_initialized_

bool awviz_common::Display::is_initialized_

protected

Whether the object has been initialized.

node_

rclcpp::Node::SharedPtr awviz_common::Display::node_

protected

Node shared pointer.

stream_

std::shared_ptr<rerun::RecordingStream> awviz_common::Display::stream_

protected

RecordingStream shared pointer.

---

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

• awviz_common/include/awviz_common/display.hpp