The SaleaeWriter class is a helper class which provides utility methods when importing data to SALEAE database. The SaleaeWriter class is used for importing VCD, CSD, or external SALEAE files. More...

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

Collaboration diagram for hal::SaleaeWriter:

Public Member Functions
	SaleaeWriter (const std::string &filename)

	~SaleaeWriter ()
	Destructor closes all open binary files updating their file header. It also updates SALEAE directory. More...

SaleaeOutputFile *	add_or_replace_waveform (const std::string &name, uint32_t id)
	Create new empty output file. Will delete existing binary file if directory links already a data file with net entry. More...

void	add_directory_entry (int inx, const std::string &name, uint32_t id)
	Adds directory entry for net/waveform with binary file index inx. More...

Detailed Description

The SaleaeWriter class is a helper class which provides utility methods when importing data to SALEAE database. The SaleaeWriter class is used for importing VCD, CSD, or external SALEAE files.

Definition at line 41 of file saleae_writer.h.

Constructor & Destructor Documentation

◆ SaleaeWriter()

hal::SaleaeWriter::SaleaeWriter ( const std::string & filename )

Constructor for SaleaeWriter

Parameters

filename Full path and filename of SALEAE directory file

Definition at line 12 of file saleae_writer.cpp.

◆ ~SaleaeWriter()

hal::SaleaeWriter::~SaleaeWriter ( )

Destructor closes all open binary files updating their file header. It also updates SALEAE directory.

Definition at line 20 of file saleae_writer.cpp.

References hal::SaleaeOutputFile::close(), hal::SaleaeOutputFile::fileIndex(), hal::gate_library_manager::save(), and hal::SaleaeDirectory::update_file_indexes().

Member Function Documentation

◆ add_directory_entry()

void hal::SaleaeWriter::add_directory_entry	(	int	inx,
		const std::string &	name,
		uint32_t	id
	)

Adds directory entry for net/waveform with binary file index inx.

Definition at line 34 of file saleae_writer.cpp.

References hal::SaleaeDirectory::add_or_replace_net(), hal::SaleaeDirectoryNetEntry::addIndex(), and name.

Referenced by add_or_replace_waveform().

◆ add_or_replace_waveform()

SaleaeOutputFile * hal::SaleaeWriter::add_or_replace_waveform	(	const std::string &	name,
		uint32_t	id
	)

Create new empty output file. Will delete existing binary file if directory links already a data file with net entry.

Definition at line 41 of file saleae_writer.cpp.

References add_directory_entry(), hal::SaleaeDirectory::get_datafile_index(), hal::SaleaeDirectory::get_datafile_path(), hal::SaleaeDirectory::get_next_available_index(), and name.

Referenced by hal::WavedataTableEditor::generateSimulationInput().

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

plugins/simulator/netlist_simulator_controller/include/netlist_simulator_controller/saleae_writer.h
plugins/simulator/netlist_simulator_controller/src/saleae_writer.cpp