AWViz-ROS
Loading...
Searching...
No Matches
awviz_common::IDisplaySpawner Class Referenceabstract

Interface for creating display instances from topic metadata. More...

#include <display_spawner.hpp>

Inheritance diagram for awviz_common::IDisplaySpawner:
awviz_common::DisplaySpawner

Public Member Functions

virtual ~IDisplaySpawner ()=default
 
virtual std::shared_ptr< Displayspawn (const std::string &topic, const std::string &topic_type)=0
 Spawn a display instance for the given topic and message type.
 
virtual std::optional< std::string > resolve_lookup_name (const std::string &topic_type) const =0
 Resolve a plugin lookup name for the given message type.
 

Detailed Description

Interface for creating display instances from topic metadata.

Constructor & Destructor Documentation

◆ ~IDisplaySpawner()

virtual awviz_common::IDisplaySpawner::~IDisplaySpawner ( )
virtualdefault

Member Function Documentation

◆ resolve_lookup_name()

virtual std::optional< std::string > awviz_common::IDisplaySpawner::resolve_lookup_name ( const std::string &  topic_type) const
pure virtual

Resolve a plugin lookup name for the given message type.

Parameters
topic_typeROS message type name.
Returns
Lookup name if a plugin is registered, otherwise std::nullopt.

Implemented in awviz_common::DisplaySpawner.

◆ spawn()

virtual std::shared_ptr< Display > awviz_common::IDisplaySpawner::spawn ( const std::string &  topic,
const std::string &  topic_type 
)
pure virtual

Spawn a display instance for the given topic and message type.

Parameters
topicTopic name.
topic_typeROS message type name.
Returns
A display instance if a plugin is available, otherwise nullptr.

Implemented in awviz_common::DisplaySpawner.


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