hal::GuiExtensionLogicEvaluator Class Reference

#include </home/runner/work/hal/hal/plugins/logic_evaluator/include/logic_evaluator/plugin_logic_evaluator.h>

Inheritance diagram for hal::GuiExtensionLogicEvaluator:

Collaboration diagram for hal::GuiExtensionLogicEvaluator:

Public Member Functions
	GuiExtensionLogicEvaluator ()
	Default constructor for GuiExtensionEvaluator. More...
std::vector< PluginParameter >	get_parameter () const override
	Get a vector of configurable parameters. More...
void	set_parameter (const std::vector< PluginParameter > &params) override
	Set values for a vector of configurable parameters. More...
virtual std::vector< ContextMenuContribution >	get_context_contribution (const Netlist *nl, const std::vector< u32 > &mods, const std::vector< u32 > &gats, const std::vector< u32 > &nets) override
virtual void	execute_function (std::string tag, Netlist *nl, const std::vector< u32 > &mods, const std::vector< u32 > &gats, const std::vector< u32 > &nets) override
Public Member Functions inherited from hal::GuiExtensionInterface
	GuiExtensionInterface (const std::string &toplabel=std::string())
virtual	~GuiExtensionInterface ()
virtual void	register_progress_indicator (std::function< void(int, const std::string &)> pif)
virtual void	netlist_loaded (Netlist *nl)
virtual void	netlist_about_to_close (Netlist *nl)
bool	is_contribution_enabled () const
void	set_contribution_enabled (bool enabled)
std::string	contribution_top_label () const
Public Member Functions inherited from hal::AbstractExtensionInterface
	AbstractExtensionInterface ()
virtual	~AbstractExtensionInterface ()

Static Public Member Functions
static bool	acceptGate (const Gate *g)

Detailed Description

The GUI contribution of the logic evaluator plugin.

Definition at line 60 of file plugin_logic_evaluator.h.

Constructor & Destructor Documentation

GuiExtensionLogicEvaluator()

hal::GuiExtensionLogicEvaluator::GuiExtensionLogicEvaluator ( )

inline

Default constructor for GuiExtensionEvaluator.

Definition at line 69 of file plugin_logic_evaluator.h.

Member Function Documentation

acceptGate()

bool hal::GuiExtensionLogicEvaluator::acceptGate ( const Gate *  g )

static

Definition at line 90 of file plugin_logic_evaluator.cpp.

References hal::ff, hal::Gate::get_type(), hal::GateType::has_property(), hal::latch, and hal::ram.

Referenced by execute_function().

execute_function()

void hal::GuiExtensionLogicEvaluator::execute_function ( std::string  tag, Netlist *  nl, const std::vector< u32 > &  mods, const std::vector< u32 > &  gats, const std::vector< u32 > &  nets  )

overridevirtual

Call from GUI to execute function. This function gets called when user selected a plugin contribution (see get_context_contribution) in context menu of GUI graphical netlist view or when user clicked a push button in contributed plugin menu

Parameters

[in]	tag	- The function tagname (unique identifier)
[in]	nl	- The current netlist in GUI
[in]	mods	- List of selected modules
[in]	gats	- List of selected gates
[in]	nets	- List of selected nets

Reimplemented from hal::GuiExtensionInterface.

Definition at line 119 of file plugin_logic_evaluator.cpp.

References acceptGate(), QDialog::exec(), hal::Netlist::get_gate_by_id(), hal::Module::get_gates(), hal::Netlist::get_module_by_id(), QWidget::raise(), and QWidget::show().

get_context_contribution()

std::vector< ContextMenuContribution > hal::GuiExtensionLogicEvaluator::get_context_contribution ( const Netlist *  nl, const std::vector< u32 > &  mods, const std::vector< u32 > &  gats, const std::vector< u32 > &  nets  )

overridevirtual

Contribution to context menu. This function gets called when a context menu in GUI graphical netlist view pops up. Plugins that want to add their own entries in context menu will return one ContextMenuContribution record per entry line.

Parameters

[in]	nl	- The current netlist in GUI
[in]	mods	- List of selected modules
[in]	gats	- List of selected gates
[in]	nets	- List of selected nets

Returns

Reimplemented from hal::GuiExtensionInterface.

Definition at line 109 of file plugin_logic_evaluator.cpp.

get_parameter()

std::vector< PluginParameter > hal::GuiExtensionLogicEvaluator::get_parameter ( ) const

overridevirtual

Get a vector of configurable parameters.

Returns

The vector of parameters.

Reimplemented from hal::GuiExtensionInterface.

Definition at line 60 of file plugin_logic_evaluator.cpp.

References hal::PluginParameter::Boolean, hal::PluginParameter::Label, and hal::PluginParameter::PushButton.

set_parameter()

void hal::GuiExtensionLogicEvaluator::set_parameter ( const std::vector< PluginParameter > &  params )

overridevirtual

Set values for a vector of configurable parameters.

Parameters

[in]

params

- The parameters including their values.

Reimplemented from hal::GuiExtensionInterface.

Definition at line 77 of file plugin_logic_evaluator.cpp.

---

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

• plugins/logic_evaluator/include/logic_evaluator/plugin_logic_evaluator.h
• plugins/logic_evaluator/src/plugin_logic_evaluator.cpp