daq::dpm::DaqControllerImpl Class Reference

Internal data structure to SchedulerImpl. More...

#include <scheduler.hpp>

Inheritance diagram for daq::dpm::DaqControllerImpl:

Public Types
using	RsyncFactory = std::function< std::unique_ptr< RsyncAsyncProcessIf >(boost::asio::io_context &, std::string const &, std::string const &, RsyncOptions const &, RsyncAsyncProcess::DryRun)>
using	ProcFactory = std::function< std::unique_ptr< AsyncProcessIf >(boost::asio::io_context &, std::vector< std::string > const &)>

Public Member Functions
	DaqControllerImpl (rad::IoExecutor &executor, std::unique_ptr< DaqWorkspace > workspace, Resources &resources, RsyncFactory rsync_factory, ProcFactory proc_factory, DaqControllerOptions opts)
	Construct controller for existing workspace.
void	Start () override
	Start/stop operations.
void	Stop () override
auto	IsStopped () const noexcept -> bool override
auto	GetId () const noexcept -> std::string const &override
auto	GetErrorFlag () const noexcept -> bool override
auto	GetState () const noexcept -> State override
auto	GetResult () const noexcept -> std::filesystem::path const &override
auto	GetStatus () noexcept -> ObservableStatus &override
auto	GetStatus () const noexcept -> ObservableStatus const &override
void	Poll () override
Public Member Functions inherited from daq::dpm::DaqController
virtual	~DaqController ()
virtual auto	GetId () const noexcept -> std::string const &=0
virtual auto	GetErrorFlag () const noexcept -> bool=0
virtual auto	GetState () const noexcept -> State=0
virtual auto	GetResult () const noexcept -> std::filesystem::path const &=0
virtual auto	GetStatus () noexcept -> ObservableStatus &=0
virtual auto	GetStatus () const noexcept -> ObservableStatus const &=0
virtual void	Start ()=0
	Start/stop operations.
virtual void	Stop ()=0
virtual void	Poll ()=0
virtual bool	IsStopped () const noexcept=0

Detailed Description

Internal data structure to SchedulerImpl.

Definition at line 432 of file scheduler.hpp.

Member Typedef Documentation

ProcFactory

using daq::dpm::DaqControllerImpl::ProcFactory = std::function<std::unique_ptr<AsyncProcessIf>( boost::asio::io_context&, std::vector<std::string> const&)>

Definition at line 441 of file scheduler.hpp.

RsyncFactory

using daq::dpm::DaqControllerImpl::RsyncFactory = std::function<std::unique_ptr<RsyncAsyncProcessIf>(boost::asio::io_context&, std::string const&, std::string const&, RsyncOptions const&, RsyncAsyncProcess::DryRun)>

Definition at line 434 of file scheduler.hpp.

Constructor & Destructor Documentation

DaqControllerImpl()

daq::dpm::DaqControllerImpl::DaqControllerImpl	(	rad::IoExecutor &	executor,
		std::unique_ptr< DaqWorkspace >	workspace,
		Resources &	resources,
		RsyncFactory	rsync_factory,
		ProcFactory	proc_factory,
		DaqControllerOptions	opts
	)

Construct controller for existing workspace.

Postcondition

State is loaded from workspace.

Exceptions

std-exception

(possibly nested) containing error.

Definition at line 423 of file scheduler.cpp.

Member Function Documentation

GetErrorFlag()

auto daq::dpm::DaqControllerImpl::GetErrorFlag ( ) const -> bool

overridevirtualnoexcept

Returns

Error flag.

Implements daq::dpm::DaqController.

Definition at line 516 of file scheduler.cpp.

GetId()

auto daq::dpm::DaqControllerImpl::GetId ( ) const -> std::string const&

overridevirtualnoexcept

Returns

data acquisition identifier.

Implements daq::dpm::DaqController.

Definition at line 512 of file scheduler.cpp.

GetResult()

auto daq::dpm::DaqControllerImpl::GetResult ( ) const -> std::filesystem::path const &override

inlineoverridevirtualnoexcept

Returns

Data product filename.

Implements daq::dpm::DaqController.

Definition at line 475 of file scheduler.hpp.

GetState()

auto daq::dpm::DaqControllerImpl::GetState ( ) const -> State

overridevirtualnoexcept

Returns

state of data acquisition.

Implements daq::dpm::DaqController.

Definition at line 520 of file scheduler.cpp.

GetStatus() [1/2]

auto daq::dpm::DaqControllerImpl::GetStatus ( ) const -> ObservableStatus const&

overridevirtualnoexcept

Implements daq::dpm::DaqController.

Definition at line 528 of file scheduler.cpp.

GetStatus() [2/2]

auto daq::dpm::DaqControllerImpl::GetStatus ( ) -> ObservableStatus&

overridevirtualnoexcept

Returns

status object associated with this daq.

Implements daq::dpm::DaqController.

Definition at line 524 of file scheduler.cpp.

IsStopped()

auto daq::dpm::DaqControllerImpl::IsStopped ( ) const -> bool

overridevirtualnoexcept

Implements daq::dpm::DaqController.

Definition at line 508 of file scheduler.cpp.

Poll()

void daq::dpm::DaqControllerImpl::Poll ( )

overridevirtual

Implements daq::dpm::DaqController.

Definition at line 549 of file scheduler.cpp.

Start()

void daq::dpm::DaqControllerImpl::Start ( )

overridevirtual

Start/stop operations.

This assumes the implementation has an internal scheduler that it uses.

Implements daq::dpm::DaqController.

Definition at line 499 of file scheduler.cpp.

Stop()

void daq::dpm::DaqControllerImpl::Stop ( )

overridevirtual

Implements daq::dpm::DaqController.

Definition at line 504 of file scheduler.cpp.

---

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

• dpm/libdpm/src/include/daq/dpm/scheduler.hpp
• dpm/libdpm/src/scheduler.cpp