HAL  v4.5.0-83-g30c8f0afc
The Hardware Analyzer - a comprehensive reverse engineering and manipulation framework for gate-level netlists.
hal::SimulationEngineScripted Class Referenceabstract

#include </home/runner/work/hal/hal/plugins/simulator/netlist_simulator_controller/include/netlist_simulator_controller/simulation_engine.h>

Inheritance diagram for hal::SimulationEngineScripted:
Inheritance graph
Collaboration diagram for hal::SimulationEngineScripted:
Collaboration graph

Public Member Functions

 SimulationEngineScripted (const std::string &nam)
 
virtual int numberCommandLines () const =0
 
virtual std::vector< std::string > commandLine (int lineIndex) const =0
 
- Public Member Functions inherited from hal::SimulationEngine
 SimulationEngine (const std::string &nam)
 
virtual ~SimulationEngine ()
 
std::string name () const
 
State state () const
 
int get_state () const
 
std::string get_working_directory () const
 
void set_working_directory (const std::string &workDir)
 
bool clock_events_required () const
 
bool can_share_memory () const
 
bool install_saleae_parser (std::string dirname) const
 
virtual bool setSimulationInput (SimulationInput *simInput)=0
 
virtual void setResultFilename (const std::string filename)
 
std::string get_result_filename () const
 
virtual bool finalize ()
 
virtual void failed ()
 
virtual void set_engine_property (const std::string &key, const std::string &value)
 
virtual std::string get_engine_property (const std::string &key)
 
virtual const std::unordered_map< std::string, std::string > & get_engine_properties () const
 
virtual SimulationInputget_simulation_input () const
 

Additional Inherited Members

- Public Types inherited from hal::SimulationEngine
enum  State { Failed = -1 , Done = 0 , Running = 1 , Preparing = 2 }
 
- Protected Attributes inherited from hal::SimulationEngine
bool mRequireClockEvents
 
bool mCanShareMemory
 
std::string mResultFilename
 
State mState
 
std::unordered_map< std::string, std::string > mProperties
 
SimulationInputmSimulationInput
 
std::string mWorkDir
 

Detailed Description

The base class for simulation engines that run as external processes driven by a sequence of shell commands.

Definition at line 257 of file simulation_engine.h.

Constructor & Destructor Documentation

◆ SimulationEngineScripted()

hal::SimulationEngineScripted::SimulationEngineScripted ( const std::string &  nam)
inline

Definition at line 262 of file simulation_engine.h.

Member Function Documentation

◆ commandLine()

virtual std::vector<std::string> hal::SimulationEngineScripted::commandLine ( int  lineIndex) const
pure virtual

Must be implemented by derived class

Returns command and argument to be executed

Parameters
[in]lineIndexthe line index of the script starting from 0
Returns
first element is command to be executed, subsequent elements are arguments

Implemented in hal::verilator::VerilatorEngine, and hal::DummyEngine.

◆ numberCommandLines()

virtual int hal::SimulationEngineScripted::numberCommandLines ( ) const
pure virtual

Must be implemented by derived class

Returns the information how many command lines are to be executed

Returns
number of command lines

Implemented in hal::verilator::VerilatorEngine, and hal::DummyEngine.


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