daq::Workspace Class Reference

Interface to interact with DPM workspace. More...

#include <workspace.hpp>

Inheritance diagram for daq::Workspace:

Public Member Functions
virtual	~Workspace ()
virtual auto	GetPath () const -> std::filesystem::path=0
virtual void	ArchiveDaq (std::string const &id)=0
	Archives specified DAQ without deleting any files, typically by moving files it to a specific location in the workspace. More...
virtual void	RemoveDaq (std::string const &id)=0
	Removes workspace and all containing files for DAQ without archiving it. More...
Load/store DAQ Context
virtual auto	LoadContext (std::string const &id) const -> DaqContext=0
	Get file name of the data product specification stored in StoreSpecification() More...
virtual void	StoreContext (DaqContext const &context) const =0
	Get file name of the data product specification stored in StoreSpecification() More...
Load/store DAQ status
virtual auto	LoadStatus (std::string const &id) const -> Status=0
	Loads last archived DAQ status if any. More...
virtual void	StoreStatus (Status const &status) const =0
	Loads last archived DAQ status if any. More...
virtual auto	LoadArchivedStatus (std::string const &id) const -> std::optional< Status >=0
	Loads last archived DAQ status if any. More...
Load/store DAQ list
virtual auto	LoadList () const -> std::vector< std::string >=0
virtual void	StoreList (std::vector< std::string > const &queue) const =0

Detailed Description

Interface to interact with DPM workspace.

The DPM workspace allows:

• Enumeration of Data Acquisitions that are not yet completed.
• Initialize and interact with per-DAq workspace.

Definition at line 32 of file workspace.hpp.

Constructor & Destructor Documentation

~Workspace()

virtual daq::Workspace::~Workspace ( )

inlinevirtual

Definition at line 34 of file workspace.hpp.

Member Function Documentation

ArchiveDaq()

virtual void daq::Workspace::ArchiveDaq ( std::string const &  id )

pure virtual

Archives specified DAQ without deleting any files, typically by moving files it to a specific location in the workspace.

Note

Once archived OCM/DPM the ID is essentially reusable. This means that archiving duplicate IDs must be foreseen.

Implemented in daq::WorkspaceImpl.

GetPath()

virtual auto daq::Workspace::GetPath ( ) const -> std::filesystem::path

pure virtual

Returns

Absolute path to workspace.

Implemented in daq::WorkspaceImpl.

LoadArchivedStatus()

virtual auto daq::Workspace::LoadArchivedStatus ( std::string const &  id ) const -> std::optional< Status >

pure virtual

Loads last archived DAQ status if any.

Parameters

id	Data Acquisition Id.

Returns

empty optional if id was not found or failed to load.

status otherwise.

Implemented in daq::WorkspaceImpl.

LoadContext()

virtual auto daq::Workspace::LoadContext ( std::string const &  id ) const -> DaqContext

pure virtual

Get file name of the data product specification stored in StoreSpecification()

Implemented in daq::WorkspaceImpl.

LoadList()

virtual auto daq::Workspace::LoadList ( ) const -> std::vector< std::string >

pure virtual

Implemented in daq::WorkspaceImpl.

LoadStatus()

virtual auto daq::Workspace::LoadStatus ( std::string const &  id ) const -> Status

pure virtual

Loads last archived DAQ status if any.

Parameters

id	Data Acquisition Id.

Returns

empty optional if id was not found or failed to load.

status otherwise.

Implemented in daq::WorkspaceImpl.

RemoveDaq()

virtual void daq::Workspace::RemoveDaq ( std::string const &  id )

pure virtual

Removes workspace and all containing files for DAQ without archiving it.

Workspace is e.g. removed either if user aborts a Data Acquisition or to roll back failed initialization of a workspace.

Parameters

id	Data Acquisition id.

Implemented in daq::WorkspaceImpl.

StoreContext()

virtual void daq::Workspace::StoreContext ( DaqContext const &  context ) const

pure virtual

Get file name of the data product specification stored in StoreSpecification()

Implemented in daq::WorkspaceImpl.

StoreList()

virtual void daq::Workspace::StoreList ( std::vector< std::string > const &  queue ) const

pure virtual

Implemented in daq::WorkspaceImpl.

StoreStatus()

virtual void daq::Workspace::StoreStatus ( Status const &  status ) const

pure virtual

Loads last archived DAQ status if any.

Parameters

id	Data Acquisition Id.

Returns

empty optional if id was not found or failed to load.

status otherwise.

Implemented in daq::WorkspaceImpl.

---

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

• common/libdaq/src/include/daq/workspace.hpp