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

Inheritance diagram for hal::SaleaeInputFile:

Collaboration diagram for hal::SaleaeInputFile:

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

SaleaeDataTuple	get_next_value ()
	Getter for next (time,value) tuple in sequential read. More...

std::string	get_last_error () const
	Get verbose error message based on internal status, empty string if no error. More...

SaleaeDataBuffer *	get_buffered_data (uint64_t nread)
	Returns pointer to data buffer reading from current file position up to `nread` events. It is the callers responsibility to dispose the buffer eventually. More...

int64_t	get_file_position (double t, bool successor=false)

void	set_file_position (int64_t pos)
	Goto position for next read access. Pos=0 is start value from header. More...

void	skip_transitions (int64_t delta)
	Goto position for next read access, skip number of transitions indicated by 'delta', delta can be negative. More...

int	get_int_value (double t)
	Get waveform value for time t. More...

const SaleaeHeader *	header () const
	Getter for header information. More...

Detailed Description

Reads waveform transitions from a SALEAE binary file.

Definition at line 180 of file saleae_file.h.

Constructor & Destructor Documentation

◆ SaleaeInputFile()

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

Definition at line 98 of file saleae_file.cpp.

References hal::SaleaeHeader::beginTime(), hal::SaleaeHeader::Coded, hal::SaleaeHeader::Double, hal::SaleaeStatus::ErrorOpenFile, hal::SaleaeHeader::read(), hal::SaleaeParser::sTimeScaleFactor, hal::SaleaeHeader::storageFormat(), and hal::SaleaeHeader::Uint64.

Member Function Documentation

◆ get_buffered_data()

SaleaeDataBuffer * hal::SaleaeInputFile::get_buffered_data ( uint64_t nread )

Returns pointer to data buffer reading from current file position up to nread events. It is the callers responsibility to dispose the buffer eventually.

Definition at line 138 of file saleae_file.cpp.

References hal::SaleaeHeader::beginTime(), hal::SaleaeHeader::Coded, hal::SaleaeHeader::Double, hal::SaleaeDataBuffer::mCount, hal::SaleaeDataBuffer::mTimeArray, hal::SaleaeDataBuffer::mValueArray, hal::SaleaeHeader::numTransitions(), hal::SaleaeParser::sTimeScaleFactor, hal::SaleaeHeader::storageFormat(), hal::SaleaeHeader::Uint64, and hal::SaleaeHeader::value().

Referenced by hal::WaveData::get_events(), hal::WaveData::loadSaleae(), hal::WaveDataProviderFile::nextPoint(), saleae_cat(), saleae_diff(), saleae_ls(), hal::WaveDataProviderFile::startValue(), and hal::WaveEditTable::WaveEditTable().

◆ get_file_position()

int64_t hal::SaleaeInputFile::get_file_position	(	double	t,
		bool	successor = `false`
	)

Definition at line 281 of file saleae_file.cpp.

References hal::SaleaeHeader::beginTime(), hal::SaleaeHeader::endTime(), and hal::SaleaeHeader::numTransitions().

Referenced by hal::WaveData::get_events(), get_int_value(), hal::WaveData::neighborTransition(), and hal::WaveEditTable::WaveEditTable().

◆ get_int_value()

int hal::SaleaeInputFile::get_int_value ( double t )

Get waveform value for time t.

Definition at line 342 of file saleae_file.cpp.

References hal::SaleaeHeader::Coded, get_file_position(), hal::SaleaeHeader::storageFormat(), and hal::SaleaeHeader::value().

Referenced by hal::WaveData::intValue(), and hal::WaveValueThread::run().

◆ get_last_error()

std::string hal::SaleaeInputFile::get_last_error ( ) const

Get verbose error message based on internal status, empty string if no error.

Definition at line 202 of file saleae_file.cpp.

References hal::SaleaeStatus::BadIndentifier, hal::SaleaeStatus::ErrorOpenFile, and hal::SaleaeStatus::UnsupportedType.

Referenced by hal::SaleaeParser::register_callback().

◆ get_next_value()

SaleaeDataTuple hal::SaleaeInputFile::get_next_value ( )

Getter for next (time,value) tuple in sequential read.

Definition at line 217 of file saleae_file.cpp.

References hal::SaleaeHeader::beginTime(), hal::SaleaeHeader::Coded, hal::SaleaeDataTuple::mTime, hal::SaleaeDataTuple::mValue, hal::SaleaeHeader::numTransitions(), hal::SaleaeDataTuple::sReadError, hal::SaleaeHeader::storageFormat(), and hal::SaleaeHeader::value().

Referenced by hal::WaveData::neighborTransition(), and hal::SaleaeParser::register_callback().

◆ header()

const SaleaeHeader* hal::SaleaeInputFile::header ( ) const

inline

Getter for header information.

Definition at line 214 of file saleae_file.h.

Referenced by hal::VcdSerializer::importSaleae(), hal::WaveData::neighborTransition(), saleae_cat(), saleae_diff(), and saleae_ls().

◆ set_file_position()

void hal::SaleaeInputFile::set_file_position ( int64_t pos )

Goto position for next read access. Pos=0 is start value from header.

Definition at line 275 of file saleae_file.cpp.

Referenced by hal::WaveData::neighborTransition().

◆ skip_transitions()

void hal::SaleaeInputFile::skip_transitions ( int64_t delta )

Goto position for next read access, skip number of transitions indicated by 'delta', delta can be negative.

Definition at line 251 of file saleae_file.cpp.

References hal::SaleaeHeader::numTransitions().

Referenced by hal::WaveEditTable::WaveEditTable().

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

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

Public Member Functions