hal::NetlistSimulatorPlugin Class Reference

#include </home/runner/work/hal/hal/plugins/simulator/hal_simulator/include/netlist_simulator/plugin_netlist_simulator.h>

Inheritance diagram for hal::NetlistSimulatorPlugin:

Collaboration diagram for hal::NetlistSimulatorPlugin:

Public Member Functions
std::string	get_name () const override
std::string	get_version () const override
std::string	get_description () const override
std::set< std::string >	get_dependencies () const override
void	on_load () override
void	on_unload () override
Public Member Functions inherited from hal::BasePluginInterface
	BasePluginInterface ()=default
virtual	~BasePluginInterface ()
virtual void	initialize ()
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

The plugin that provides HAL's built-in simulation engine.

Definition at line 38 of file plugin_netlist_simulator.h.

Member Function Documentation

get_dependencies()

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

overridevirtual

Get dependencies of plugin

Returns

Set of plugin names which must be loaded first, contains {netlist_simulator_controller}

Reimplemented from hal::BasePluginInterface.

Definition at line 28 of file plugin_netlist_simulator.cpp.

get_description()

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

overridevirtual

Short description for plugin.

Returns

The short description.

Reimplemented from hal::BasePluginInterface.

Definition at line 23 of file plugin_netlist_simulator.cpp.

get_name()

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

overridevirtual

Get the name of the plugin.

Returns

The name of the plugin.

Implements hal::BasePluginInterface.

Definition at line 13 of file plugin_netlist_simulator.cpp.

Referenced by hal::PYBIND11_PLUGIN().

get_version()

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

overridevirtual

Get the version of the plugin.

Returns

The version of the plugin.

Implements hal::BasePluginInterface.

Definition at line 18 of file plugin_netlist_simulator.cpp.

Referenced by hal::PYBIND11_PLUGIN().

on_load()

void hal::NetlistSimulatorPlugin::on_load ( )

overridevirtual

Creates instance and registers with NetlistSimulatorController

Reimplemented from hal::BasePluginInterface.

Definition at line 35 of file plugin_netlist_simulator.cpp.

References name.

on_unload()

void hal::NetlistSimulatorPlugin::on_unload ( )

overridevirtual

Unregisters and delete instance

Reimplemented from hal::BasePluginInterface.

Definition at line 41 of file plugin_netlist_simulator.cpp.

References hal::SimulationEngineFactories::deleteFactory(), and hal::SimulationEngineFactories::instance().

---

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

• plugins/simulator/hal_simulator/include/netlist_simulator/plugin_netlist_simulator.h
• plugins/simulator/hal_simulator/src/plugin_netlist_simulator.cpp