HAL  v4.5.0-83-g30c8f0afc
The Hardware Analyzer - a comprehensive reverse engineering and manipulation framework for gate-level netlists.
Public Member Functions | List of all members
hal::GuiExtensionPythonBase Class Reference

#include </home/runner/work/hal/hal/plugins/gui_extension_demo/include/gui_extension_demo/gui_extension_python_base.h>

Collaboration diagram for hal::GuiExtensionPythonBase:
Collaboration graph

Public Member Functions

 GuiExtensionPythonBase (const std::string &tag, const std::string &lab)
 
 ~GuiExtensionPythonBase ()
 
std::string get_tagname () const
 
std::string get_label () const
 
std::vector< PluginParameter > get_parameter () const
 
virtual void add_module_context (const std::string tagname, const std::string label)
 
virtual void add_gate_context (const std::string tagname, const std::string label)
 
virtual void add_net_context (const std::string tagname, const std::string label)
 
virtual void add_main_menu (const std::vector< PluginParameter > &params)
 
virtual void set_selection (const std::vector< u32 > &mods, const std::vector< u32 > &gats, const std::vector< u32 > &nets)
 
virtual void set_function_call (const std::string &fc)
 
std::string get_function_call () const
 
std::vector< u32 > get_selected_modules () const
 
std::vector< u32 > get_selected_gates () const
 
std::vector< u32 > get_selected_nets () const
 
void clear ()
 

Detailed Description

Demonstrates how a plugin can expose its GUI contribution to python.

Definition at line 37 of file gui_extension_python_base.h.

Constructor & Destructor Documentation

◆ GuiExtensionPythonBase()

hal::GuiExtensionPythonBase::GuiExtensionPythonBase ( const std::string &  tag,
const std::string &  lab 
)

Definition at line 8 of file gui_extension_python_base.cpp.

◆ ~GuiExtensionPythonBase()

hal::GuiExtensionPythonBase::~GuiExtensionPythonBase ( )

Definition at line 14 of file gui_extension_python_base.cpp.

Member Function Documentation

◆ add_gate_context()

void hal::GuiExtensionPythonBase::add_gate_context ( const std::string  tagname,
const std::string  label 
)
virtual

Definition at line 35 of file gui_extension_python_base.cpp.

References hal::GuiExtensionContext::add_gate_context(), and hal::GuiExtensionContext::sInstance.

Referenced by hal::PYBIND11_PLUGIN().

◆ add_main_menu()

void hal::GuiExtensionPythonBase::add_main_menu ( const std::vector< PluginParameter > &  params)
virtual

Definition at line 19 of file gui_extension_python_base.cpp.

References hal::GuiExtensionContext::add_main_menu(), and hal::GuiExtensionContext::sInstance.

Referenced by hal::PYBIND11_PLUGIN().

◆ add_module_context()

void hal::GuiExtensionPythonBase::add_module_context ( const std::string  tagname,
const std::string  label 
)
virtual

Definition at line 27 of file gui_extension_python_base.cpp.

References hal::GuiExtensionContext::add_module_context(), and hal::GuiExtensionContext::sInstance.

Referenced by hal::PYBIND11_PLUGIN().

◆ add_net_context()

void hal::GuiExtensionPythonBase::add_net_context ( const std::string  tagname,
const std::string  label 
)
virtual

Definition at line 43 of file gui_extension_python_base.cpp.

References hal::GuiExtensionContext::add_net_context(), and hal::GuiExtensionContext::sInstance.

Referenced by hal::PYBIND11_PLUGIN().

◆ clear()

void hal::GuiExtensionPythonBase::clear ( )

Definition at line 93 of file gui_extension_python_base.cpp.

References hal::GuiExtensionContext::clear(), and hal::GuiExtensionContext::sInstance.

Referenced by hal::PYBIND11_PLUGIN().

◆ get_function_call()

std::string hal::GuiExtensionPythonBase::get_function_call ( ) const

Definition at line 79 of file gui_extension_python_base.cpp.

Referenced by hal::PYBIND11_PLUGIN().

◆ get_label()

std::string hal::GuiExtensionPythonBase::get_label ( ) const
inline

Definition at line 53 of file gui_extension_python_base.h.

◆ get_parameter()

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

Definition at line 84 of file gui_extension_python_base.cpp.

References hal::GuiExtensionContext::get_parameter(), and hal::GuiExtensionContext::sInstance.

Referenced by hal::PYBIND11_PLUGIN().

◆ get_selected_gates()

std::vector< u32 > hal::GuiExtensionPythonBase::get_selected_gates ( ) const

Definition at line 64 of file gui_extension_python_base.cpp.

Referenced by hal::PYBIND11_PLUGIN().

◆ get_selected_modules()

std::vector< u32 > hal::GuiExtensionPythonBase::get_selected_modules ( ) const

Definition at line 59 of file gui_extension_python_base.cpp.

Referenced by hal::PYBIND11_PLUGIN().

◆ get_selected_nets()

std::vector< u32 > hal::GuiExtensionPythonBase::get_selected_nets ( ) const

Definition at line 69 of file gui_extension_python_base.cpp.

Referenced by hal::PYBIND11_PLUGIN().

◆ get_tagname()

std::string hal::GuiExtensionPythonBase::get_tagname ( ) const
inline

Definition at line 51 of file gui_extension_python_base.h.

◆ set_function_call()

void hal::GuiExtensionPythonBase::set_function_call ( const std::string &  fc)
virtual

Definition at line 74 of file gui_extension_python_base.cpp.

◆ set_selection()

void hal::GuiExtensionPythonBase::set_selection ( const std::vector< u32 > &  mods,
const std::vector< u32 > &  gats,
const std::vector< u32 > &  nets 
)
virtual

Definition at line 52 of file gui_extension_python_base.cpp.

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