One state's timed hold: how long, where it lands, and whether a client may set the length. More...

Collaboration diagram for SequencerService::HoldRule:

Public Attributes
uint32_t	default_ms = 0
uint32_t	max_ms = 0
uint32_t	extended_ms = 0
	What EXTEND_FIRE restarts at.
State	return_state = State::UNKNOWN
bool	gui_settable = false
uint32_t	gate_open_delay_ms = 0
	Milliseconds the gate actuator waits after the transition before it opens, from the delays CSV.
uint32_t	gate_close_delay_ms = 0
	The same actuator's delay in the RETURN state's column.
std::string	gate_actuator

Detailed Description

One state's timed hold: how long, where it lands, and whether a client may set the length.

Assembled from config at load. Exactly two things create entries — [fire] and [flow] — and gui_settable is written as a literal in both places rather than read from config, so no config edit can make a burn window client-settable.

Definition at line 200 of file SequencerService.hpp.

Member Data Documentation

◆ default_ms

uint32_t sequencer::SequencerService::HoldRule::default_ms = 0

Definition at line 201 of file SequencerService.hpp.

◆ extended_ms

uint32_t sequencer::SequencerService::HoldRule::extended_ms = 0

What EXTEND_FIRE restarts at.

0 makes the hold a fixed window.

Definition at line 204 of file SequencerService.hpp.

◆ gate_actuator

std::string sequencer::SequencerService::HoldRule::gate_actuator

Definition at line 220 of file SequencerService.hpp.

◆ gate_close_delay_ms

uint32_t sequencer::SequencerService::HoldRule::gate_close_delay_ms = 0

The same actuator's delay in the RETURN state's column.

The valve does not close at the expiry transition either — it closes that much after it, so a stagger on the way out lengthens the open window exactly as a stagger on the way in shortens it.

Definition at line 219 of file SequencerService.hpp.

◆ gate_open_delay_ms

uint32_t sequencer::SequencerService::HoldRule::gate_open_delay_ms = 0

Milliseconds the gate actuator waits after the transition before it opens, from the delays CSV.

The hold runs for (this + the requested duration), so the requested duration is what the GATE VALVE is open for rather than what the STATE is held for. 0 when the state opens everything at once.

Definition at line 213 of file SequencerService.hpp.

◆ gui_settable

bool sequencer::SequencerService::HoldRule::gui_settable = false

Definition at line 206 of file SequencerService.hpp.

◆ max_ms

uint32_t sequencer::SequencerService::HoldRule::max_ms = 0

Definition at line 202 of file SequencerService.hpp.

◆ return_state

State sequencer::SequencerService::HoldRule::return_state = State::UNKNOWN

Definition at line 205 of file SequencerService.hpp.

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

daq-server/diablo_server/lib/include/control/SequencerService.hpp

Public Attributes