hal::SaleaeDirectoryNetEntry Class Reference

The SaleaeDirectoryNetEntry class represents a regular waveform for a single simulated net. There is the possibility that no simulation data is available for the net (yet), so the number of associated binary files might be zero. The design allows to split the data into several files. This option however is currently not used. The ID must match the ID of the simulated net. The waveform name can be altered by user using the rename() method. More...

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

Inheritance diagram for hal::SaleaeDirectoryNetEntry:

Collaboration diagram for hal::SaleaeDirectoryNetEntry:

Public Types
enum	Type { None , Group , Boolean , Trigger }

Public Member Functions
	SaleaeDirectoryNetEntry (const std::string nam, uint32_t id_=0, Type tp=None)
	Constructor. More...
virtual	~SaleaeDirectoryNetEntry ()
uint32_t	id () const
	Getter for waveform ID = simulated net ID. More...
std::string	name () const
	Getter for waveform name. More...
Type	type () const
	Getter for composed type, None for regular waveform. More...
const std::vector< SaleaeDirectoryFileIndex > &	indexes () const
	Getter for list of associated binary files indexes. More...
void	addIndex (const SaleaeDirectoryFileIndex &sdfe)
	Add index for binary file to net entry instance. More...
void	rename (const std::string nam)
	Rename waveform. More...
int	dataFileIndex () const
	Return last data file index (currently there should be no more than one) More...
int	uniqueKey () const
	Unique key as reference (used e.g. in mComposedEntryMap) More...

Static Public Attributes
static const int	sComposedBaseKey = 1 << 16

Protected Attributes
uint32_t	mId
std::string	mName
Type	mType
std::vector< SaleaeDirectoryFileIndex >	mFileIndexes

Friends
class	SaleaeDirectory

Detailed Description

The SaleaeDirectoryNetEntry class represents a regular waveform for a single simulated net. There is the possibility that no simulation data is available for the net (yet), so the number of associated binary files might be zero. The design allows to split the data into several files. This option however is currently not used. The ID must match the ID of the simulated net. The waveform name can be altered by user using the rename() method.

Definition at line 109 of file saleae_directory.h.

Member Enumeration Documentation

Type

enum hal::SaleaeDirectoryNetEntry::Type

Enumerator
None
Group
Boolean
Trigger

Definition at line 113 of file saleae_directory.h.

Constructor & Destructor Documentation

SaleaeDirectoryNetEntry()

hal::SaleaeDirectoryNetEntry::SaleaeDirectoryNetEntry ( const std::string  nam, uint32_t  id_ = 0, Type  tp = None  )

inline

Constructor.

Definition at line 121 of file saleae_directory.h.

~SaleaeDirectoryNetEntry()

virtual hal::SaleaeDirectoryNetEntry::~SaleaeDirectoryNetEntry ( )

inlinevirtual

Definition at line 124 of file saleae_directory.h.

Member Function Documentation

addIndex()

void hal::SaleaeDirectoryNetEntry::addIndex ( const SaleaeDirectoryFileIndex &  sdfe )

inline

Add index for binary file to net entry instance.

Definition at line 139 of file saleae_directory.h.

References mFileIndexes.

Referenced by hal::SaleaeWriter::add_directory_entry(), hal::VcdSerializer::importSaleae(), hal::SaleaeDirectory::parse_json(), and hal::WaveData::saveSaleae().

dataFileIndex()

int hal::SaleaeDirectoryNetEntry::dataFileIndex

(

)

const

Return last data file index (currently there should be no more than one)

Definition at line 370 of file saleae_directory.cpp.

References mFileIndexes.

id()

uint32_t hal::SaleaeDirectoryNetEntry::id ( ) const

inline

Getter for waveform ID = simulated net ID.

Definition at line 127 of file saleae_directory.h.

References mId.

Referenced by hal::SaleaeDirectory::add_or_replace_net(), and hal::SaleaeDirectory::SaleaeDirectory().

indexes()

const std::vector<SaleaeDirectoryFileIndex>& hal::SaleaeDirectoryNetEntry::indexes ( ) const

inline

Getter for list of associated binary files indexes.

Definition at line 136 of file saleae_directory.h.

References mFileIndexes.

Referenced by hal::SaleaeDirectory::add_or_replace_net().

name()

std::string hal::SaleaeDirectoryNetEntry::name ( ) const

inline

Getter for waveform name.

Definition at line 130 of file saleae_directory.h.

References mName.

Referenced by hal::SaleaeDirectory::add_or_replace_net(), and hal::SaleaeDirectory::SaleaeDirectory().

rename()

void hal::SaleaeDirectoryNetEntry::rename ( const std::string  nam )

inline

Rename waveform.

Definition at line 142 of file saleae_directory.h.

References mName.

type()

Type hal::SaleaeDirectoryNetEntry::type ( ) const

inline

Getter for composed type, None for regular waveform.

Definition at line 133 of file saleae_directory.h.

References mType.

uniqueKey()

int hal::SaleaeDirectoryNetEntry::uniqueKey

(

)

const

Unique key as reference (used e.g. in mComposedEntryMap)

Definition at line 436 of file saleae_directory.cpp.

References mId, mType, and sComposedBaseKey.

Referenced by hal::SaleaeDirectory::add_or_replace_composed(), hal::SaleaeDirectory::get_composed(), hal::SaleaeDirectory::parse_json(), hal::SaleaeDirectory::remove_composed(), and hal::WaveDataTrigger::set_filter_wave().

Friends And Related Function Documentation

SaleaeDirectory

friend class SaleaeDirectory

friend

Definition at line 111 of file saleae_directory.h.

Member Data Documentation

mFileIndexes

std::vector<SaleaeDirectoryFileIndex> hal::SaleaeDirectoryNetEntry::mFileIndexes

protected

Definition at line 118 of file saleae_directory.h.

Referenced by addIndex(), dataFileIndex(), and indexes().

mId

uint32_t hal::SaleaeDirectoryNetEntry::mId

protected

Definition at line 115 of file saleae_directory.h.

Referenced by hal::SaleaeDirectoryComposedEntry::dump(), id(), hal::SaleaeDirectoryComposedEntry::isNull(), and uniqueKey().

mName

std::string hal::SaleaeDirectoryNetEntry::mName

protected

Definition at line 116 of file saleae_directory.h.

Referenced by hal::SaleaeDirectoryComposedEntry::dump(), name(), and rename().

mType

Type hal::SaleaeDirectoryNetEntry::mType

protected

Definition at line 117 of file saleae_directory.h.

Referenced by hal::SaleaeDirectoryComposedEntry::dump(), hal::SaleaeDirectoryComposedEntry::isNull(), type(), and uniqueKey().

sComposedBaseKey

const int hal::SaleaeDirectoryNetEntry::sComposedBaseKey = 1 << 16

static

Definition at line 150 of file saleae_directory.h.

Referenced by uniqueKey().

---

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

• plugins/simulator/netlist_simulator_controller/include/netlist_simulator_controller/saleae_directory.h
• plugins/simulator/netlist_simulator_controller/src/saleae_directory.cpp