hal::PluginPythonShell Class Reference

#include </home/runner/work/hal/hal/plugins/python_shell/include/python_shell/plugin_python_shell.h>

Inheritance diagram for hal::PluginPythonShell:

Collaboration diagram for hal::PluginPythonShell:

Public Member Functions
	PluginPythonShell ()
std::string	get_name () const override
std::string	get_version () const override
bool	exec (ProgramArguments &args) override
void	set_layout_locker (bool enable) override
Public Member Functions inherited from hal::UIPluginInterface
	UIPluginInterface ()=default
virtual	~UIPluginInterface ()=default
Public Member Functions inherited from hal::BasePluginInterface
	BasePluginInterface ()=default
virtual	~BasePluginInterface ()
virtual void	initialize ()
virtual std::string	get_description () const
virtual std::set< std::string >	get_dependencies () const
template<typename... Args>
void	log (const Args &... args) const
virtual void	on_load ()
virtual void	on_unload ()
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 an interactive Python shell on the command line.

Definition at line 55 of file plugin_python_shell.h.

Constructor & Destructor Documentation

PluginPythonShell()

hal::PluginPythonShell::PluginPythonShell ( )

inline

Definition at line 58 of file plugin_python_shell.h.

References hal::BasePluginInterface::m_extensions.

Member Function Documentation

exec()

bool hal::PluginPythonShell::exec ( ProgramArguments &  args )

overridevirtual

Excutes the plugin with given command line parameters.

Parameters

[in]

args

- The command line parameters.

Returns

true on success, false otherwise.

Implements hal::UIPluginInterface.

Definition at line 40 of file plugin_python_shell.cpp.

References hal::utils::ends_with(), hal::utils::get_library_directory(), get_name(), hal::ProgramArguments::get_parameter(), hal::ProgramArguments::is_option_set(), log_error, and hal::utils::split().

get_name()

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

overridevirtual

Get the name of the plugin.

Returns

Plugin name.

Implements hal::BasePluginInterface.

Definition at line 30 of file plugin_python_shell.cpp.

Referenced by exec().

get_version()

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

overridevirtual

Get the version of the plugin.

Returns

Plugin version.

Implements hal::BasePluginInterface.

Definition at line 35 of file plugin_python_shell.cpp.

set_layout_locker()

void hal::PluginPythonShell::set_layout_locker ( bool  enable )

inlineoverridevirtual

Nothing to do for GUI layout locker.

Parameters

[in]

enable

- Unused.

Implements hal::UIPluginInterface.

Definition at line 91 of file plugin_python_shell.h.

References hal::enable, and UNUSED.

---

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

• plugins/python_shell/include/python_shell/plugin_python_shell.h
• plugins/python_shell/src/plugin_python_shell.cpp