hal::DotViewerPlugin Class Reference

Plugin interface for the DotViewerPlugin. More...

#include </home/runner/work/hal/hal/plugins/dot_viewer/include/dot_viewer/plugin_dot_viewer.h>

Inheritance diagram for hal::DotViewerPlugin:

Collaboration diagram for hal::DotViewerPlugin:

Public Member Functions
	DotViewerPlugin ()
	Default constructor for DotViewerPlugin. More...
	~DotViewerPlugin ()=default
	Default destructor for DotViewerPlugin. More...
std::string	get_name () const override
	Get the name of the plugin. More...
std::string	get_version () const override
	Get the version of the plugin. More...
std::string	get_description () const override
	Get a short description of the plugin. More...
std::set< std::string >	get_dependencies () const override
	Get the plugin dependencies. More...
void	initialize () override
void	on_load () override
void	on_unload () override
Public Member Functions inherited from hal::BasePluginInterface
	BasePluginInterface ()=default
virtual	~BasePluginInterface ()
template<typename... Args>
void	log (const Args &... args) const
virtual void	initialize_logging ()
virtual std::vector< AbstractExtensionInterface * >	get_extensions () const
template<typename T >
T *	get_first_extension () const
void	delete_extension (AbstractExtensionInterface *aeif)

Additional Inherited Members
Protected Attributes inherited from hal::BasePluginInterface
std::vector< AbstractExtensionInterface * >	m_extensions

Detailed Description

Plugin interface for the DotViewerPlugin.

This class provides an interface to integrate a .dot viewer as a plugin within the HAL framework.

Definition at line 49 of file plugin_dot_viewer.h.

Constructor & Destructor Documentation

DotViewerPlugin()

hal::DotViewerPlugin::DotViewerPlugin

(

)

Default constructor for DotViewerPlugin.

Definition at line 23 of file plugin_dot_viewer.cpp.

References hal::BasePluginInterface::m_extensions.

~DotViewerPlugin()

hal::DotViewerPlugin::~DotViewerPlugin ( )

default

Default destructor for DotViewerPlugin.

Member Function Documentation

get_dependencies()

std::set< std::string > hal::DotViewerPlugin::get_dependencies ( ) const

overridevirtual

Get the plugin dependencies.

Returns

A set of plugin names that this plugin depends on.

Reimplemented from hal::BasePluginInterface.

Definition at line 60 of file plugin_dot_viewer.cpp.

Referenced by hal::PYBIND11_PLUGIN().

get_description()

std::string hal::DotViewerPlugin::get_description ( ) const

overridevirtual

Get a short description of the plugin.

Returns

The short description of the plugin.

Reimplemented from hal::BasePluginInterface.

Definition at line 38 of file plugin_dot_viewer.cpp.

Referenced by hal::PYBIND11_PLUGIN().

get_name()

std::string hal::DotViewerPlugin::get_name ( ) const

overridevirtual

Get the name of the plugin.

Returns

The name of the plugin.

Implements hal::BasePluginInterface.

Definition at line 28 of file plugin_dot_viewer.cpp.

Referenced by on_load(), on_unload(), and hal::PYBIND11_PLUGIN().

get_version()

std::string hal::DotViewerPlugin::get_version ( ) const

overridevirtual

Get the version of the plugin.

Returns

The version of the plugin.

Implements hal::BasePluginInterface.

Definition at line 33 of file plugin_dot_viewer.cpp.

Referenced by hal::PYBIND11_PLUGIN().

initialize()

void hal::DotViewerPlugin::initialize ( )

overridevirtual

Initialize the plugin, which registers the DOT viewer content factory with the GUI.

Reimplemented from hal::BasePluginInterface.

Definition at line 56 of file plugin_dot_viewer.cpp.

on_load()

void hal::DotViewerPlugin::on_load ( )

overridevirtual

Called when the plugin is loaded, which sets up the log channel and the GUI extension.

Reimplemented from hal::BasePluginInterface.

Definition at line 43 of file plugin_dot_viewer.cpp.

References hal::ContentManager::addExternalWidget(), QList::append(), QString::fromStdString(), hal::gContentManager, get_name(), hal::gNetlist, and hal::ExternalContent::instance().

on_unload()

void hal::DotViewerPlugin::on_unload ( )

overridevirtual

Called when the plugin is unloaded, which releases the GUI extension again.

Reimplemented from hal::BasePluginInterface.

Definition at line 50 of file plugin_dot_viewer.cpp.

References QString::fromStdString(), get_name(), hal::ExternalContent::instance(), and hal::ExternalContent::removePlugin().

---

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

• plugins/dot_viewer/include/dot_viewer/plugin_dot_viewer.h
• plugins/dot_viewer/src/plugin_dot_viewer.cpp