Automatically starts and stops a continuous acquisition in the current scope. More...

#include <daq.h>

Collaboration diagram for daq::stream::Scope:

Public Member Functions
	Scope (const run::Run &run, run::RunDataHandler *data_handler, bool start_=true)
	Construct a scoped continuous acquisition, starting it by default. Consider using get() instead.

virtual	~Scope ()
	Deconstruct a scoped continuous acquisition, stopping it.

status	process (bool partial=false)

Public Attributes
const run::Run &	run
	The run associated with this continuous acquisition, relevant for the run's ID and DAQConfig.

run::RunDataHandler *const	run_data_handler
	The run::RunDataHandler instance that will handle incoming data via process().

Detailed Description

Automatically starts and stops a continuous acquisition in the current scope.

Use get() to acquire. Continuous acquisition is usually done while a computation is running and should be stopped afterwards. A stream::Scope object does exactly that when it is constructed and deconstructed. See the introductory text for an usage example.

Definition at line 131 of file daq.h.

Constructor & Destructor Documentation

◆ Scope()

daq::stream::Scope::Scope	(	const run::Run &	run,
		run::RunDataHandler *	data_handler,
		bool	start_ = true )

inline

Construct a scoped continuous acquisition, starting it by default. Consider using get() instead.

Definition at line 140 of file daq.h.

References run_data_handler, and daq::stream::start().

◆ ~Scope()

virtual daq::stream::Scope::~Scope ( )

inlinevirtual

Deconstruct a scoped continuous acquisition, stopping it.

Definition at line 147 of file daq.h.

References daq::stream::stop().

Member Function Documentation

◆ process()

status daq::stream::Scope::process ( bool partial = false )

inline

Definition at line 165 of file daq.h.

References daq::stream::process(), and run_data_handler.

Member Data Documentation

◆ run

const run::Run& daq::stream::Scope::run

The run associated with this continuous acquisition, relevant for the run's ID and DAQConfig.

Definition at line 134 of file daq.h.

◆ run_data_handler

run::RunDataHandler* const daq::stream::Scope::run_data_handler

The run::RunDataHandler instance that will handle incoming data via process().

Definition at line 136 of file daq.h.

Referenced by process(), and Scope().

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

lib/computation/src/daq/daq.h

Public Member Functions

Public Attributes