hal::GuiExtensionDataflow Class Reference

#include </home/runner/work/hal/hal/plugins/dataflow_analysis/include/dataflow_analysis/plugin_dataflow.h>

Inheritance diagram for hal::GuiExtensionDataflow:

Collaboration diagram for hal::GuiExtensionDataflow:

Public Member Functions
	GuiExtensionDataflow ()=default
	Default constructor for GuiExtensionDataflow. 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...
void	execute_function (std::string tag, Netlist *nl, const std::vector< u32 > &mods, const std::vector< u32 > &gats, const std::vector< u32 > &nets) override
	Execute the plugin on the given netlist. More...
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 std::vector< ContextMenuContribution >	get_context_contribution (const Netlist *nl, const std::vector< u32 > &mods, const std::vector< u32 > &gats, const std::vector< u32 > &nets)
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 ()

Detailed Description

The GUI contribution of the dataflow analysis plugin, i.e., its configurable parameters and the entry points invoked from the GUI.

Definition at line 59 of file plugin_dataflow.h.

Constructor & Destructor Documentation

GuiExtensionDataflow()

hal::GuiExtensionDataflow::GuiExtensionDataflow ( )

default

Default constructor for GuiExtensionDataflow.

Member Function Documentation

execute_function()

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

overridevirtual

Execute the plugin on the given netlist.

All parameters but the netlist are ignored.

Parameters

[in]	tag	- A tag (ignored).
[in]	nl	- The netlist to operate on.
[in]	mods	- Module IDs (ignored).
[in]	gats	- Gate IDs (ignored).
[in]	nets	- Net IDs (ignored).

Reimplemented from hal::GuiExtensionInterface.

Definition at line 183 of file plugin_dataflow.cpp.

References hal::dataflow::analyze(), hal::clock, hal::enable, hal::ff, log_error, log_warning, hal::reset, hal::set, UNUSED, hal::dataflow::Configuration::with_control_pin_types(), hal::dataflow::Configuration::with_expected_sizes(), hal::dataflow::Configuration::with_min_group_size(), and hal::dataflow::Configuration::with_stage_identification().

get_parameter()

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

overridevirtual

Get a vector of configurable parameters.

Returns

The vector of parameters.

Reimplemented from hal::GuiExtensionInterface.

Definition at line 125 of file plugin_dataflow.cpp.

References hal::PluginParameter::Boolean, hal::PluginParameter::ExistingDir, hal::PluginParameter::Integer, hal::PluginParameter::PushButton, and hal::PluginParameter::String.

set_parameter()

void hal::GuiExtensionDataflow::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 139 of file plugin_dataflow.cpp.

---

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

• plugins/dataflow_analysis/include/dataflow_analysis/plugin_dataflow.h
• plugins/dataflow_analysis/src/plugin_dataflow.cpp