HAL
hal::CliExtensionInterface Class Referenceabstract

#include <cli_extension_interface.h>

Inheritance diagram for hal::CliExtensionInterface:
Inheritance graph
Collaboration diagram for hal::CliExtensionInterface:
Collaboration graph

Public Member Functions

 CliExtensionInterface ()
 
virtual ProgramOptions get_cli_options () const =0
 
virtual bool handle_cli_call (Netlist *netlist, ProgramArguments &args)=0
 
- Public Member Functions inherited from hal::AbstractExtensionInterface
 AbstractExtensionInterface ()
 
virtual ~AbstractExtensionInterface ()
 

Detailed Description

Definition at line 32 of file cli_extension_interface.h.

Constructor & Destructor Documentation

◆ CliExtensionInterface()

hal::CliExtensionInterface::CliExtensionInterface ( )
inline

Definition at line 35 of file cli_extension_interface.h.

Member Function Documentation

◆ get_cli_options()

virtual ProgramOptions hal::CliExtensionInterface::get_cli_options ( ) const
pure virtual

Returns command line interface options

Returns
The program options description.

Implemented in hal::CliExtensionDataflow.

Referenced by hal::plugin_manager::load(), and hal::GuiPluginEntry::updateFromLoaded().

◆ handle_cli_call()

virtual bool hal::CliExtensionInterface::handle_cli_call ( Netlist netlist,
ProgramArguments args 
)
pure virtual

Entry point to handle command line interface call

Parameters
[in]netlist- The netlist.
[in]args- Program options.
Returns
True on success.

Implemented in hal::CliExtensionDataflow.


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