Implements daq::DaqController for states responsible to be executed by OCM. More...

#include <daqController.hpp>

Inheritance diagram for daq::OcmDaqController:

Classes
struct	Aborted

struct	Aborting

struct	Acquiring

struct	NotStarted

struct	Starting

struct	Stopped

struct	Stopping

Public Member Functions
boost::future< State >	StartAsync () override
	Starts the data acquisition.

boost::future< Status >	StopAsync (ErrorPolicy policy) override
	Stops the data acquisition.

boost::future< Status >	AbortAsync (ErrorPolicy policy) override
	Aborts the data acquisition.

boost::future< State >	ScheduleMergeAsync () override
	Schedules DAQ for merging by sending request to DPM.

void	UpdateKeywords (fits::KeywordVector const &keywords) override
	Updates (replace or add) list of keywords.

boost::future< State >	AwaitAsync (std::vector< std::string > sources, std::chrono::milliseconds timeout) override
	Awaits that data acquisition stops or aborts.

State	GetState () const DAQ_NOEXCEPT override

constexpr log4cplus::Logger const &	GetLogger () const noexcept

Public Member Functions inherited from daq::CommonDaqController
	CommonDaqController (boost::asio::io_context &io_context, DaqContext context, std::shared_ptr< ObservableStatus > status, std::shared_ptr< ObservableEventLog > event_log)

std::shared_ptr< ObservableStatus >	GetStatus () DAQ_NOEXCEPT override

std::shared_ptr< ObservableStatus const >	GetStatus () const DAQ_NOEXCEPT override

std::shared_ptr< ObservableEventLog >	GetEventLog () DAQ_NOEXCEPT override

std::string const &	GetId () const DAQ_NOEXCEPT override

bool	GetErrorFlag () const DAQ_NOEXCEPT override

DaqContext const &	GetContext () const DAQ_NOEXCEPT override

boost::signals2::connection	ConnectContext (ContextSignal::slot_type const &slot) override
	Connect observer that is invoked when context is modified.

Public Member Functions inherited from daq::DaqController
	DaqController ()=default

virtual	~DaqController ()=default

virtual boost::future< State >	StartAsync ()=0
	Starts the data acquisition.

virtual boost::future< Status >	StopAsync (ErrorPolicy policy)=0
	Stops the data acquisition.

virtual boost::future< Status >	AbortAsync (ErrorPolicy policy)=0
	Aborts the data acquisition.

virtual boost::future< State >	ScheduleMergeAsync ()=0
	Schedules DAQ for merging by sending request to DPM.

virtual void	UpdateKeywords (fits::KeywordVector const &keywords)=0
	Updates (replace or add) list of keywords.

virtual boost::future< State >	AwaitAsync (std::vector< std::string > sources, std::chrono::milliseconds timeout)=0
	Awaits that data acquisition stops or aborts.

virtual State	GetState () const DAQ_NOEXCEPT=0

virtual std::shared_ptr< ObservableStatus >	GetStatus () DAQ_NOEXCEPT=0

virtual std::shared_ptr< ObservableStatus const >	GetStatus () const DAQ_NOEXCEPT=0

virtual std::shared_ptr< ObservableEventLog >	GetEventLog () DAQ_NOEXCEPT=0

virtual std::string const &	GetId () const DAQ_NOEXCEPT=0

virtual bool	GetErrorFlag () const DAQ_NOEXCEPT=0

virtual DaqContext const &	GetContext () const DAQ_NOEXCEPT=0

virtual boost::signals2::connection	ConnectContext (ContextSignal::slot_type const &slot)=0
	Connect observer that is invoked when context is modified.

Static Public Member Functions
static std::shared_ptr< OcmDaqController >	Create (boost::asio::io_context &io_context, fits::KeywordFormatter const &kw_formatter, DaqContext context, DaqSources const &sources, std::shared_ptr< ObservableStatus > status, std::shared_ptr< ObservableEventLog > event_log, OcmAsyncOperations operations)
	Construct object.

Protected Types
using	StateVariant = std::variant< NotStarted, Starting, Acquiring, Stopping, Stopped, Aborting, Aborted >

Protected Member Functions
StateVariant	MakeState (State s) const noexcept

	OcmDaqController (boost::asio::io_context &io_context, fits::KeywordFormatter const &kw_formatter, DaqContext context, DaqSources const &sources, std::shared_ptr< ObservableStatus > status, std::shared_ptr< ObservableEventLog > event_log, OcmAsyncOperations ops)

op::AsyncOpParams	MakeParams (op::AlertState &)
	Constructs the parameters used for asynchronous operations.

op::AwaitOpParams	MakeAwaitParams (op::AlertState &)

void	InitiateStopCondition ()
	Initiate async operation that triggers DAQ stop automatically.

void	CancelAwaitPrimarySources ()
	Cancels the awaiting of primary sources.

void	AddInitialKeywords ()

auto	HasStatefulSources () noexcept -> bool
	Queries if ctx has stateful sources (primary or metadata source).

void	SetAlert (std::string key, std::string description) noexcept
	Set alert with category alert::DAQ_CONTROLLER.

void	SetState (StateVariant &&s) noexcept

std::optional< std::variant< Source< PrimSource > , Source< MetaSource > > >	FindSource (std::string_view source_id)

template<class SourceType >
std::vector< Source< SourceType > >	MakeSources (std::vector< SourceType > sources)
	Helper to build source vector.

Protected Member Functions inherited from daq::CommonDaqController
template<class T , class... Args>
void	AddEvent (Args &&... args)

boost::asio::io_context &	GetIoCtx () noexcept

rad::IoExecutor &	GetIoExecutor () noexcept

DaqContext &	GetContextMut () noexcept

ObservableEventLog &	GetEventLogRef () noexcept

ObservableStatus &	GetStatusRef () noexcept

ObservableStatus const &	GetStatusRef () const noexcept

void	EmitContextSignal ()

Protected Attributes
fits::KeywordFormatter const &	m_kw_formatter

StateVariant	m_state

std::vector< Source< PrimSource > >	m_prim_sources
	Note: Consider vector immutable!

std::vector< Source< MetaSource > >	m_meta_sources
	Note: Consider vector immutable!

OcmAsyncOperations	m_async_ops

std::shared_ptr< PendingReplies >	m_pending_replies

std::vector< std::unique_ptr< boost::asio::steady_timer > >	m_timers

std::function< bool()>	m_abort_await_primary_sources
	If DaqController is awaiting the completion of primary data sources this function will hold the abort function.

log4cplus::Logger	m_logger

Additional Inherited Members
Public Types inherited from daq::DaqController
using	ContextSignal = boost::signals2::signal< void(DaqContext const &)>

Detailed Description

Implements daq::DaqController for states responsible to be executed by OCM.

The states executed by DPM are implemented by DpmDaqController.

Definition at line 396 of file daqController.hpp.

Class Documentation

◆ daq::OcmDaqController::Aborted

struct daq::OcmDaqController::Aborted

Definition at line 442 of file daqController.hpp.

◆ daq::OcmDaqController::Aborting

struct daq::OcmDaqController::Aborting

Definition at line 441 of file daqController.hpp.

◆ daq::OcmDaqController::Acquiring

struct daq::OcmDaqController::Acquiring

Definition at line 438 of file daqController.hpp.

◆ daq::OcmDaqController::NotStarted

struct daq::OcmDaqController::NotStarted

Definition at line 436 of file daqController.hpp.

◆ daq::OcmDaqController::Starting

struct daq::OcmDaqController::Starting

Definition at line 437 of file daqController.hpp.

◆ daq::OcmDaqController::Stopped

struct daq::OcmDaqController::Stopped

Definition at line 440 of file daqController.hpp.

◆ daq::OcmDaqController::Stopping

struct daq::OcmDaqController::Stopping

Definition at line 439 of file daqController.hpp.

Member Typedef Documentation

◆ StateVariant

using daq::OcmDaqController::StateVariant = std::variant<NotStarted, Starting, Acquiring, Stopping, Stopped, Aborting, Aborted>

protected

Definition at line 444 of file daqController.hpp.

Constructor & Destructor Documentation

◆ OcmDaqController()

daq::OcmDaqController::OcmDaqController	(	boost::asio::io_context &	io_context,
		fits::KeywordFormatter const &	kw_formatter,
		DaqContext	context,
		DaqSources const &	sources,
		std::shared_ptr< ObservableStatus >	status,
		std::shared_ptr< ObservableEventLog >	event_log,
		OcmAsyncOperations	ops
	)

protected

Definition at line 187 of file daqController.cpp.

Member Function Documentation

◆ AbortAsync()

boost::future< Status > daq::OcmDaqController::AbortAsync ( ErrorPolicy policy )

overridevirtual

Aborts the data acquisition.

Parameters

policy Error policy determining if errors are tolerated or not.

It is possible to issue this request more than once, to e.g. retry a failed abort attempt.

Precondition: GetState() not in (State::Aborted, State::Stopped)

Postcondition: GetState() == State::Aborting if a data acquisition was ongoing otherwise GetState() == State::Aborted.

Implements daq::DaqController.

Definition at line 438 of file daqController.cpp.

◆ AddInitialKeywords()

void daq::OcmDaqController::AddInitialKeywords ( )

protected

Definition at line 306 of file daqController.cpp.

◆ AwaitAsync()

boost::future< State > daq::OcmDaqController::AwaitAsync	(	std::vector< std::string >	sources,
		std::chrono::milliseconds	timeout
	)

overridevirtual

Awaits that data acquisition stops or aborts.

It is possible to await only only a subset of data sources by specifying their ids in sources.

Parameters

sources An optional vector of source-ids to await, if empty all primary sources are awaited on.

Returns: future set with std::invalid_argument if source-id is not recognized.; future set with boost::broken_promise if DaqController is destroyed before operation completes.

Implements daq::DaqController.

Definition at line 528 of file daqController.cpp.

◆ CancelAwaitPrimarySources()

void daq::OcmDaqController::CancelAwaitPrimarySources ( )

protected

Cancels the awaiting of primary sources.

This does nothing if no await process is ongoing.

Definition at line 781 of file daqController.cpp.

◆ Create()

std::shared_ptr< OcmDaqController > daq::OcmDaqController::Create	(	boost::asio::io_context &	io_context,
		fits::KeywordFormatter const &	kw_formatter,
		DaqContext	context,
		DaqSources const &	sources,
		std::shared_ptr< ObservableStatus >	status,
		std::shared_ptr< ObservableEventLog >	event_log,
		OcmAsyncOperations	operations
	)

static

Construct object.

Parameters

io_context	Executor used for continuations and timer.
context	General context used to control DAQ execution.
status	Data acquisition status object, also contains identifier (may not be empty). Caller is responsible for making the id unique.
prim	Primary data sources
meta	Metadata sources

Precondition: status == true.; event_log == true.

Exceptions

std::invalid_argument if arguments are invalid.

Definition at line 168 of file daqController.cpp.

◆ FindSource()

std::optional< std::variant< Source< PrimSource > *, Source< MetaSource > * > > daq::OcmDaqController::FindSource ( std::string_view source_id )

protected

Definition at line 665 of file daqController.cpp.

◆ GetLogger()

constexpr log4cplus::Logger const & daq::OcmDaqController::GetLogger ( ) const

constexprnoexcept

Returns: Logger associated with this DaqController.

Definition at line 246 of file daqController.cpp.

◆ GetState()

State daq::OcmDaqController::GetState ( ) const

overridevirtual

Returns: state of data acquisition.

Implements daq::DaqController.

Definition at line 219 of file daqController.cpp.

◆ HasStatefulSources()

auto daq::OcmDaqController::HasStatefulSources ( ) -> bool

protectednoexcept

Queries if ctx has stateful sources (primary or metadata source).

Returns: true if ctx has 1 or more of primary or metadata sources.; false otherwise.

Definition at line 310 of file daqController.cpp.

◆ InitiateStopCondition()

void daq::OcmDaqController::InitiateStopCondition ( )

protected

Initiate async operation that triggers DAQ stop automatically.

If there is no condition for automatic stop (e.g. meta data sources only) this method does nothing.

Definition at line 702 of file daqController.cpp.

◆ MakeAwaitParams()

op::AwaitOpParams daq::OcmDaqController::MakeAwaitParams ( op::AlertState & alerts )

protected

Definition at line 292 of file daqController.cpp.

◆ MakeParams()

op::AsyncOpParams daq::OcmDaqController::MakeParams ( op::AlertState & alerts )

protected

Constructs the parameters used for asynchronous operations.

Note: OcmAsyncOpParams will bind references to member variables so caller must guarantee that DaqController outlives the async operation. This is normally done by holding a shared copy in the last .then continuation for the async operation, thus guaranteeing that all intermediate continuations will access a valid object.

Definition at line 279 of file daqController.cpp.

◆ MakeSources()

template<class SourceType >

std::vector< Source< SourceType > > daq::OcmDaqController::MakeSources ( std::vector< SourceType > sources )

protected

Helper to build source vector.

Definition at line 690 of file daqController.cpp.

◆ MakeState()

OcmDaqController::StateVariant daq::OcmDaqController::MakeState ( State s ) const

protectednoexcept

Definition at line 250 of file daqController.cpp.

◆ ScheduleMergeAsync()

boost::future< State > daq::OcmDaqController::ScheduleMergeAsync ( )

overridevirtual

Schedules DAQ for merging by sending request to DPM.

Returns

future containing exception:

std::logic_error if DAQ has already been scheduled
mal::TimeoutException if DPM is offline (timeout).
unspecified DPM fails

Implements daq::DaqController.

Definition at line 508 of file daqController.cpp.

◆ SetAlert()

void daq::OcmDaqController::SetAlert	(	std::string	key,
		std::string	description
	)

protectednoexcept

Set alert with category alert::DAQ_CONTROLLER.

◆ SetState()

void daq::OcmDaqController::SetState ( OcmDaqController::StateVariant && s )

protectednoexcept

Definition at line 273 of file daqController.cpp.

◆ StartAsync()

boost::future< State > daq::OcmDaqController::StartAsync ( )

overridevirtual

Starts the data acquisition.

Returns: A future that will be Set once data acquisition has started or or fails.

Exceptions

std::exception-derived exception if internal error occurs.

Returns: Future that is ready once all sources are started or failed.

Precondition: GetState() == State::Notstarted

Postcondition: GetState() == State::Starting on success GetState() == State::Error on error

Implements daq::DaqController.

Definition at line 314 of file daqController.cpp.

◆ StopAsync()

boost::future< Status > daq::OcmDaqController::StopAsync ( ErrorPolicy policy )

overridevirtual

Stops the data acquisition.

Precondition: GetState() not in (State::Stopped or State::Aborted)

Postcondition: GetState() == State::Stopping

Implements daq::DaqController.

Definition at line 364 of file daqController.cpp.

◆ UpdateKeywords()

void daq::OcmDaqController::UpdateKeywords ( fits::KeywordVector const & keywords )

overridevirtual

Updates (replace or add) list of keywords.

Parameters

keywords Keywords to add.

Implements daq::DaqController.

Definition at line 513 of file daqController.cpp.

Member Data Documentation

◆ m_abort_await_primary_sources

std::function<bool()> daq::OcmDaqController::m_abort_await_primary_sources

protected

If DaqController is awaiting the completion of primary data sources this function will hold the abort function.

@important Users must check if it is valid before invoking it.

Definition at line 527 of file daqController.hpp.

◆ m_async_ops

OcmAsyncOperations daq::OcmDaqController::m_async_ops

protected

Definition at line 517 of file daqController.hpp.

◆ m_kw_formatter

fits::KeywordFormatter const& daq::OcmDaqController::m_kw_formatter

protected

Definition at line 511 of file daqController.hpp.

◆ m_logger

log4cplus::Logger daq::OcmDaqController::m_logger

protected

Definition at line 528 of file daqController.hpp.

◆ m_meta_sources

std::vector<Source<MetaSource> > daq::OcmDaqController::m_meta_sources

protected

Note: Consider vector immutable!

Definition at line 515 of file daqController.hpp.

◆ m_pending_replies

std::shared_ptr<PendingReplies> daq::OcmDaqController::m_pending_replies

protected

Definition at line 518 of file daqController.hpp.

◆ m_prim_sources

std::vector<Source<PrimSource> > daq::OcmDaqController::m_prim_sources

protected

Note: Consider vector immutable!

Definition at line 514 of file daqController.hpp.

◆ m_state

StateVariant daq::OcmDaqController::m_state

protected

Definition at line 512 of file daqController.hpp.

◆ m_timers

std::vector<std::unique_ptr<boost::asio::steady_timer> > daq::OcmDaqController::m_timers

protected

Definition at line 519 of file daqController.hpp.

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

common/libdaq/src/include/daq/daqController.hpp
common/libdaq/src/daqController.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Class Documentation

◆ daq::OcmDaqController::Aborted

◆ daq::OcmDaqController::Aborting

◆ daq::OcmDaqController::Acquiring

◆ daq::OcmDaqController::NotStarted

◆ daq::OcmDaqController::Starting

◆ daq::OcmDaqController::Stopped

◆ daq::OcmDaqController::Stopping

Member Typedef Documentation

◆ StateVariant

Constructor & Destructor Documentation

◆ OcmDaqController()

Member Function Documentation

◆ AbortAsync()

◆ AddInitialKeywords()

◆ AwaitAsync()

◆ CancelAwaitPrimarySources()

◆ Create()

◆ FindSource()

◆ GetLogger()

◆ GetState()

◆ HasStatefulSources()

◆ InitiateStopCondition()

◆ MakeAwaitParams()

◆ MakeParams()

◆ MakeSources()

◆ MakeState()

◆ ScheduleMergeAsync()

◆ SetAlert()

◆ SetState()

◆ StartAsync()

◆ StopAsync()

◆ UpdateKeywords()

Member Data Documentation

◆ m_abort_await_primary_sources

◆ m_async_ops

◆ m_kw_formatter

◆ m_logger

◆ m_meta_sources

◆ m_pending_replies

◆ m_prim_sources

◆ m_state

◆ m_timers