The SaleaeDirectoryStoreRequest class is useful to bundle requests for updating SALEAE directory. Many operations such as renaming waveform, creating groups, assigning waveform to groups require update of SALEAE directory. To avoid multiple write_json() calls during the same operation it is recommended to create an instance of SaleaeDirectoryStoreRequest rather than calling write_json() directly. When leaving the scope the destructor of the last instance will perform the write operation. More...

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

Collaboration diagram for hal::SaleaeDirectoryStoreRequest:

Public Member Functions
	SaleaeDirectoryStoreRequest (SaleaeDirectory *sd)

	~SaleaeDirectoryStoreRequest ()

Static Public Attributes
static bool	sWriteDisabled = false

Detailed Description

The SaleaeDirectoryStoreRequest class is useful to bundle requests for updating SALEAE directory. Many operations such as renaming waveform, creating groups, assigning waveform to groups require update of SALEAE directory. To avoid multiple write_json() calls during the same operation it is recommended to create an instance of SaleaeDirectoryStoreRequest rather than calling write_json() directly. When leaving the scope the destructor of the last instance will perform the write operation.

Definition at line 52 of file saleae_directory.h.

Constructor & Destructor Documentation

◆ SaleaeDirectoryStoreRequest()

hal::SaleaeDirectoryStoreRequest::SaleaeDirectoryStoreRequest ( SaleaeDirectory * sd )

SaleaeDirectoryStoreRequest constructor

Parameters

[in] sd The SALEAE directory which needs to be persisted to disk eventually.

Definition at line 481 of file saleae_directory.cpp.

◆ ~SaleaeDirectoryStoreRequest()

hal::SaleaeDirectoryStoreRequest::~SaleaeDirectoryStoreRequest ( )

SaleaeDirectoryStoreRequest destructor. Last destructor on stack will peform write operation.

Definition at line 487 of file saleae_directory.cpp.

References sWriteDisabled.

Member Data Documentation

◆ sWriteDisabled

bool hal::SaleaeDirectoryStoreRequest::sWriteDisabled = false

static

Definition at line 69 of file saleae_directory.h.

Referenced by hal::NetlistSimulatorController::NetlistSimulatorController(), and ~SaleaeDirectoryStoreRequest().

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