stadls::vx::ReinitStackEntry Class Reference

#include <reinit_stack_entry.h>

Public Member Functions
	ReinitStackEntry ()=delete
template<typename Connection >
	ReinitStackEntry (Connection &connection)
	ReinitStackEntry (ReinitStackEntry &&)=default
	ReinitStackEntry (ReinitStackEntry const &)=delete
	~ReinitStackEntry () SYMBOL_VISIBLE
void	enforce () SYMBOL_VISIBLE
ReinitStackEntry &	operator= (ReinitStackEntry &&)=default
void	pop () SYMBOL_VISIBLE
void	set (PlaybackProgram const &pbmem_request, std::optional< PlaybackProgram > const &pbmem_snapshot=std::nullopt, bool enforce=true) SYMBOL_VISIBLE
	Set and maybe enforce reinit stack entry value. More...

Detailed Description

Definition at line 10 of file reinit_stack_entry.h.

Constructor & Destructor Documentation

ReinitStackEntry() [1/4]

stadls::vx::ReinitStackEntry::ReinitStackEntry ( )

delete

ReinitStackEntry() [2/4]

template<typename Connection >

stadls::vx::ReinitStackEntry::ReinitStackEntry

(

Connection &

connection

)

ReinitStackEntry() [3/4]

stadls::vx::ReinitStackEntry::ReinitStackEntry ( ReinitStackEntry const &  )

delete

ReinitStackEntry() [4/4]

stadls::vx::ReinitStackEntry::ReinitStackEntry ( ReinitStackEntry &&  )

default

~ReinitStackEntry()

stadls::vx::ReinitStackEntry::~ReinitStackEntry

(

)

Member Function Documentation

enforce()

void stadls::vx::ReinitStackEntry::enforce

(

)

operator=()

ReinitStackEntry& stadls::vx::ReinitStackEntry::operator= ( ReinitStackEntry &&  )

default

pop()

void stadls::vx::ReinitStackEntry::pop

(

)

set()

void stadls::vx::ReinitStackEntry::set	(	PlaybackProgram const &	pbmem_request,
		std::optional< PlaybackProgram > const &	pbmem_snapshot = std::nullopt,
		bool	enforce = true
	)

Set and maybe enforce reinit stack entry value.

Parameters

pbmem_request	Playback program to be executed once a reinit is required.
pbmem_snapshot	Playback program to be executed once the exclusive access to the hardware is relinquished. All read commands within this program are translated to writes and replace the pbmem_request for future reinit operations. This is to be used to snapshot (parts of) the current state of the hardware prior to releasing the exclusive access to other users and be able to reapply this state at the next reinit operation without need for client-side synchronisation and transform of the read-out data. Currently only Omnibus read -> write operations are supported.
enforce	Whether to directly apply the pbmem_request or only apply it during the next reinit.

---

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

• /jenkins/jenlib_workspaces_f9/bld_nightly-haldls.YmxkX25pZ2h0bHktaGFsZGxzIzEzNzk.x/haldls/include/stadls/vx/reinit_stack_entry.h