Implements daq::Manager. More...

#include <manager.hpp>

Inheritance diagram for daq::ManagerImpl:

Public Member Functions
	ManagerImpl (rad::IoExecutor &executor, ManagerParams params, Workspace &workspace, fits::KeywordFormatter const &formatter, std::shared_ptr< ObservableEventLog > event_log, DaqControllerFactory &daq_factory, std::shared_ptr< DpmClient > dpm_client, log4cplus::Logger const &logger)

	~ManagerImpl () noexcept

void	RestoreFromWorkspace () override
	Loads status and constructs DaqControllers corresponding to stored state.

std::string	MakeDaqId (std::chrono::system_clock::time_point *time=nullptr) const override
	Creates a new unique identifier based on the instrument id and current time.

bool	HaveDaq (std::string_view id, std::string_view file_id={}) const noexcept override
	Query existing data acquisition by `id` and optional `file_id`.

Status	GetStatus (std::string_view id) const override
	Get status.

boost::future< State >	StartDaqAsync (DaqContext ctx) override
	Start DaqController identified by `id`.

boost::future< Status >	StopDaqAsync (std::string_view id, ErrorPolicy policy) override
	Stop DaqController identified by `id`.

boost::future< Status >	AbortDaqAsync (std::string_view id, ErrorPolicy policy) override
	Abort DaqController identified by `id`.

boost::future< Result< Status > >	AwaitDaqStateAsync (std::string_view id, State, std::chrono::milliseconds timeout) override
	Await DAQ state.

void	UpdateKeywords (std::string_view id, fits::KeywordVector const &keywords) override
	Update FITS keywords for DaqController identified by `id`.

StatusSignal &	GetStatusSignal () override

std::vector< std::shared_ptr< DaqController const > >	GetDaqControllers () override

Public Member Functions inherited from daq::Manager
virtual	~Manager ()

virtual void	RestoreFromWorkspace ()=0
	Restore from state stored in workspace.

virtual std::string	MakeDaqId (std::chrono::system_clock::time_point *time=nullptr) const =0
	Creates a new unique identifier based on the instrument id and current time.

virtual bool	HaveDaq (std::string_view id, std::string_view file_id={}) const DAQ_NOEXCEPT=0
	Query existing data acquisition by `id` and optional `file_id`.

virtual Status	GetStatus (std::string_view id) const =0
	Get status.

virtual boost::future< State >	StartDaqAsync (DaqContext ctx)=0
	Start DaqController identified by `id`.

virtual boost::future< Status >	StopDaqAsync (std::string_view id, ErrorPolicy policy)=0
	Stop DaqController identified by `id`.

virtual boost::future< Status >	AbortDaqAsync (std::string_view id, ErrorPolicy policy)=0
	Abort DaqController identified by `id`.

virtual boost::future< Result< Status > >	AwaitDaqStateAsync (std::string_view id, State state, std::chrono::milliseconds timeout)=0
	Await DAQ state.

virtual void	UpdateKeywords (std::string_view id, fits::KeywordVector const &keywords)=0
	Update FITS keywords for DaqController identified by `id`.

virtual StatusSignal &	GetStatusSignal ()=0

virtual std::vector< std::shared_ptr< DaqController const > >	GetDaqControllers ()=0

Additional Inherited Members
Public Types inherited from daq::Manager
using	Signal = boost::signals2::signal< void(ObservableStatus const &)>

Detailed Description

Implements daq::Manager.

Definition at line 264 of file manager.hpp.

Constructor & Destructor Documentation

◆ ManagerImpl()

daq::ManagerImpl::ManagerImpl	(	rad::IoExecutor &	executor,
		ManagerParams	params,
		Workspace &	workspace,
		fits::KeywordFormatter const &	formatter,
		std::shared_ptr< ObservableEventLog >	event_log,
		DaqControllerFactory &	daq_factory,
		std::shared_ptr< DpmClient >	dpm_client,
		log4cplus::Logger const &	logger
	)

explicit

Parameters

instrument_id Instrument id.

Definition at line 105 of file manager.cpp.

◆ ~ManagerImpl()

daq::ManagerImpl::~ManagerImpl ( )

noexcept

Definition at line 124 of file manager.cpp.

Member Function Documentation

◆ AbortDaqAsync()

boost::future< Status > daq::ManagerImpl::AbortDaqAsync	(	std::string_view	id,
		ErrorPolicy	policy
	)

overridevirtual

Abort DaqController identified by id.

Parameters

id	Data acquisition id.
policy	Error policy determining if errors are tolerated or not.

Returns: Exceptional future containing std::invalid_argument, if data acquisition with id does not exist.; Future that will eventually be ready when data acquisition has aborted, or failed to abort.

Implements daq::Manager.

Definition at line 546 of file manager.cpp.

◆ AwaitDaqStateAsync()

boost::future< Result< Status > > daq::ManagerImpl::AwaitDaqStateAsync	(	std::string_view	id,
		State	state,
		std::chrono::milliseconds	timeout
	)

overridevirtual

Await DAQ state.

Parameters

id	Data acquisition id.
state	target state to await.
timeout	How long to wait for state to be reached.

Returns: Exceptional future containing std::invalid_argument, if data acquisition with id does not exist or timeout is negative.; Future with a value set when condition is fulfilled or times out.

Implements daq::Manager.

Definition at line 554 of file manager.cpp.

◆ GetDaqControllers()

std::vector< std::shared_ptr< DaqController const > > daq::ManagerImpl::GetDaqControllers ( )

overridevirtual

Returns: current Daq Controllers.

Implements daq::Manager.

Definition at line 619 of file manager.cpp.

◆ GetStatus()

Status daq::ManagerImpl::GetStatus ( std::string_view id ) const

overridevirtual

Get status.

Exceptions

std::invalid_argument if no data acquisition exist with provided id.

Implements daq::Manager.

Definition at line 424 of file manager.cpp.

◆ GetStatusSignal()

StatusSignal & daq::ManagerImpl::GetStatusSignal ( )

overridevirtual

Returns: status observer object.

The status observer observes any DAQ status changes.

Implements daq::Manager.

Definition at line 615 of file manager.cpp.

◆ HaveDaq()

bool daq::ManagerImpl::HaveDaq	(	std::string_view	id,
		std::string_view	file_id = `{}`
	)		const

overridevirtualnoexcept

Query existing data acquisition by id and optional file_id.

Parameters

id	DAQ id to look up.
file_id	Optional file_id to look up.

Returns: true if there is a already a DAQ with the same ID (or same file_id if argument is provided).; false otherwise.

Implements daq::Manager.

Definition at line 223 of file manager.cpp.

◆ MakeDaqId()

std::string daq::ManagerImpl::MakeDaqId ( std::chrono::system_clock::time_point * time = nullptr ) const

overridevirtual

Creates a new unique identifier based on the instrument id and current time.

If there is a id collision when using current time a millisecond jitter component is added until a unique id is found.

The format is the same as ARCFILE - the file extension: "<OLAS_ID>-2020-08-19T09:33:11.951"

Note: OLAS_ID is the first 5 characters of instrument id.; The returned ID is guaranteed to be unique for all IDs known by Manager (there is currently no global repository of previous IDs) and is suitable for both DAQ id and OLAS FileId.

Parameters

[out] time Optional time used to produce the ID.

Exceptions

std::system_error on failure.

Implements daq::Manager.

Definition at line 214 of file manager.cpp.

◆ RestoreFromWorkspace()

void daq::ManagerImpl::RestoreFromWorkspace ( )

overridevirtual

Loads status and constructs DaqControllers corresponding to stored state.

Implements daq::Manager.

Definition at line 139 of file manager.cpp.

◆ StartDaqAsync()

boost::future< State > daq::ManagerImpl::StartDaqAsync ( DaqContext ctx )

overridevirtual

Start DaqController identified by id.

Parameters

id	Data acquisition id.

Returns: Exceptional future containing std::invalid_argument, if data acquisition with id does not exist.; Future that will eventually be ready when data acquisition has started, or failed to start.

Implements daq::Manager.

Definition at line 498 of file manager.cpp.

◆ StopDaqAsync()

boost::future< Status > daq::ManagerImpl::StopDaqAsync	(	std::string_view	id,
		ErrorPolicy	policy
	)

overridevirtual

Stop DaqController identified by id.

Parameters

id	Data acquisition id.
policy	Error policy determining if errors are tolerated or not.

Returns: Exceptional future containing std::invalid_argument, if data acquisition with id does not exist.; Future that will eventually be ready when data acquisition has stopped, or failed to stop.

Implements daq::Manager.

Definition at line 538 of file manager.cpp.

◆ UpdateKeywords()

void daq::ManagerImpl::UpdateKeywords	(	std::string_view	id,
		fits::KeywordVector const &	keywords
	)

overridevirtual

Update FITS keywords for DaqController identified by id.

Parameters

id	Data acquisition id.
keywords	FITS keywords to update.

Exceptions

std::invalid_argument	if no data acquisition exist with provided `id`.
std::runtime_error	If DaqController state does not allow updating of keywords (it's e.g. already been submitted for merging).

Implements daq::Manager.

Definition at line 611 of file manager.cpp.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ManagerImpl()

◆ ~ManagerImpl()

Member Function Documentation

◆ AbortDaqAsync()

◆ AwaitDaqStateAsync()

◆ GetDaqControllers()

◆ GetStatus()

◆ GetStatusSignal()

◆ HaveDaq()

◆ MakeDaqId()

◆ RestoreFromWorkspace()

◆ StartDaqAsync()

◆ StopDaqAsync()

◆ UpdateKeywords()