hal::SaleaeDirectoryComposedEntry Class Reference

The SaleaeDirectoryComposedEntry class represents a composed waveform. There are currently three types of composed waveforms: net groups, boolean combinations and trigger time sets which are all calculated from a set of regular waveform. Additional data like data or filter are dependend of the used type. More...

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

Inheritance diagram for hal::SaleaeDirectoryComposedEntry:

Collaboration diagram for hal::SaleaeDirectoryComposedEntry:

Public Member Functions
	SaleaeDirectoryComposedEntry (const std::string nam=std::string(), uint32_t id_=0, Type tp=None)
	SaleaeDirectoryComposedEntry (const SaleaeDirectoryComposedEntry &other)
	~SaleaeDirectoryComposedEntry ()
void	add_child (int key)
	Add an additional child key to composed. More...
void	remove_child (int key)
	Remove child key from composed. More...
const std::vector< int > &	get_children () const
	Access to child keys. More...
const std::vector< int > &	get_data () const
	Getter for data list which is used a) Boolean: list of accepted(=true) net combinations b) Trigger: target value when to trigger. More...
void	set_data (const std::vector< int > &dat)
	Setter for data list described above. More...
int	get_filter_entry () const
	Only used for trigger: Pointer to filter (suppress trigger unless value 1), null if no filter used. More...
void	set_filter_entry (int filt)
	Setter for filter pointer described above. More...
bool	isNull () const
	Test for null. More...
void	dump () const
	Dump to stdout. More...
Public Member Functions inherited from hal::SaleaeDirectoryNetEntry
	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...

Friends
class	SaleaeDirectory

Additional Inherited Members
Public Types inherited from hal::SaleaeDirectoryNetEntry
enum	Type { None , Group , Boolean , Trigger }
Static Public Attributes inherited from hal::SaleaeDirectoryNetEntry
static const int	sComposedBaseKey = 1 << 16
Protected Attributes inherited from hal::SaleaeDirectoryNetEntry
uint32_t	mId
std::string	mName
Type	mType
std::vector< SaleaeDirectoryFileIndex >	mFileIndexes

Detailed Description

The SaleaeDirectoryComposedEntry class represents a composed waveform. There are currently three types of composed waveforms: net groups, boolean combinations and trigger time sets which are all calculated from a set of regular waveform. Additional data like data or filter are dependend of the used type.

Definition at line 159 of file saleae_directory.h.

Constructor & Destructor Documentation

SaleaeDirectoryComposedEntry() [1/2]

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

inline

Definition at line 167 of file saleae_directory.h.

SaleaeDirectoryComposedEntry() [2/2]

hal::SaleaeDirectoryComposedEntry::SaleaeDirectoryComposedEntry

(

const SaleaeDirectoryComposedEntry &

other

)

Definition at line 396 of file saleae_directory.cpp.

~SaleaeDirectoryComposedEntry()

hal::SaleaeDirectoryComposedEntry::~SaleaeDirectoryComposedEntry

(

)

Definition at line 400 of file saleae_directory.cpp.

Member Function Documentation

add_child()

void hal::SaleaeDirectoryComposedEntry::add_child ( int  key )

inline

Add an additional child key to composed.

Definition at line 173 of file saleae_directory.h.

Referenced by hal::SaleaeDirectory::parse_json(), and hal::WaveDataGroup::restoreIndex().

dump()

void hal::SaleaeDirectoryComposedEntry::dump

(

)

const

Dump to stdout.

Definition at line 420 of file saleae_directory.cpp.

References hal::SaleaeDirectoryNetEntry::mId, hal::SaleaeDirectoryNetEntry::mName, hal::SaleaeDirectoryNetEntry::mType, and x.

get_children()

const std::vector<int>& hal::SaleaeDirectoryComposedEntry::get_children ( ) const

inline

Access to child keys.

Definition at line 179 of file saleae_directory.h.

get_data()

const std::vector<int>& hal::SaleaeDirectoryComposedEntry::get_data ( ) const

inline

Getter for data list which is used a) Boolean: list of accepted(=true) net combinations b) Trigger: target value when to trigger.

Definition at line 182 of file saleae_directory.h.

get_filter_entry()

int hal::SaleaeDirectoryComposedEntry::get_filter_entry ( ) const

inline

Only used for trigger: Pointer to filter (suppress trigger unless value 1), null if no filter used.

Definition at line 188 of file saleae_directory.h.

isNull()

bool hal::SaleaeDirectoryComposedEntry::isNull ( ) const

inline

Test for null.

Definition at line 194 of file saleae_directory.h.

References hal::SaleaeDirectoryNetEntry::mId, and hal::SaleaeDirectoryNetEntry::mType.

Referenced by hal::WaveDataTrigger::set_filter_wave().

remove_child()

void hal::SaleaeDirectoryComposedEntry::remove_child

(

int

key

)

Remove child key from composed.

Definition at line 408 of file saleae_directory.cpp.

set_data()

void hal::SaleaeDirectoryComposedEntry::set_data

(

const std::vector< int > &

dat

)

Setter for data list described above.

Definition at line 403 of file saleae_directory.cpp.

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

set_filter_entry()

void hal::SaleaeDirectoryComposedEntry::set_filter_entry ( int  filt )

inline

Setter for filter pointer described above.

Definition at line 191 of file saleae_directory.h.

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

Friends And Related Function Documentation

SaleaeDirectory

friend class SaleaeDirectory

friend

Definition at line 161 of file saleae_directory.h.

---

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