ifw-daq  3.0.0-pre2
IFW Data Acquisition modules
Public Member Functions | List of all members
daq::dpm::DaqWorkspaceImpl Class Referencefinal

#include <workspace.hpp>

+ Inheritance diagram for daq::dpm::DaqWorkspaceImpl:

Public Member Functions

 DaqWorkspaceImpl (std::filesystem::path root, std::filesystem::path result)
 Construct providing absolute path to DAQ workspace root. More...
 
auto GetSourcesPath () const -> std::filesystem::path override
 
auto GetPath () const -> std::filesystem::path override
 
auto GetResultPath () const -> std::filesystem::path override
 
void MakeResultSymlink (std::filesystem::path const &result) const override
 Create symlink to result file. More...
 
auto Exists (std::filesystem::path const &path) const -> bool override
 
Load/store DAQ status
auto LoadStatus () const -> Status override
 
void StoreStatus (Status const &status) const override
 
Load/store DAQ sources
auto GetSourceLookupPath () const -> std::filesystem::path override
 
auto LoadSourceLookup () const -> SourceResolver::Mapping override
 
void StoreSourceLookup (SourceResolver::Mapping const &status) const override
 
Load/store Data Product specification.
auto GetSpecificationPath () const -> std::filesystem::path override
 Get file name of the data product specification stored in StoreSpecification() More...
 
auto LoadSpecification () const -> json::DpSpec override
 Get file name of the data product specification stored in StoreSpecification() More...
 
void StoreSpecification (std::string const &specification) const override
 Get file name of the data product specification stored in StoreSpecification() More...
 
- Public Member Functions inherited from daq::dpm::DaqWorkspace
virtual ~DaqWorkspace ()
 

Detailed Description

Definition at line 218 of file workspace.hpp.

Constructor & Destructor Documentation

◆ DaqWorkspaceImpl()

daq::dpm::DaqWorkspaceImpl::DaqWorkspaceImpl ( std::filesystem::path  root,
std::filesystem::path  result 
)

Construct providing absolute path to DAQ workspace root.

Definition at line 206 of file workspace.cpp.

Member Function Documentation

◆ Exists()

auto daq::dpm::DaqWorkspaceImpl::Exists ( std::filesystem::path const &  ) const -> bool
inlineoverridevirtual
Returns
true if file exists, false otherwise

Implements daq::dpm::DaqWorkspace.

Definition at line 238 of file workspace.hpp.

◆ GetPath()

auto daq::dpm::DaqWorkspaceImpl::GetPath ( ) const -> std::filesystem::path
inlineoverridevirtual
Returns
Absolute path to workspace.

Implements daq::dpm::DaqWorkspace.

Definition at line 228 of file workspace.hpp.

◆ GetResultPath()

auto daq::dpm::DaqWorkspaceImpl::GetResultPath ( ) const -> std::filesystem::path
inlineoverridevirtual
Returns
Root directory where the (unique) data product results should be written.

Implements daq::dpm::DaqWorkspace.

Definition at line 232 of file workspace.hpp.

◆ GetSourceLookupPath()

auto daq::dpm::DaqWorkspaceImpl::GetSourceLookupPath ( ) const -> std::filesystem::path
overridevirtual

Implements daq::dpm::DaqWorkspace.

Definition at line 242 of file workspace.cpp.

◆ GetSourcesPath()

auto daq::dpm::DaqWorkspaceImpl::GetSourcesPath ( ) const -> std::filesystem::path
overridevirtual
Returns
path relative to root containing source files.

Implements daq::dpm::DaqWorkspace.

Definition at line 218 of file workspace.cpp.

◆ GetSpecificationPath()

auto daq::dpm::DaqWorkspaceImpl::GetSpecificationPath ( ) const -> std::filesystem::path
overridevirtual

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

Implements daq::dpm::DaqWorkspace.

Definition at line 271 of file workspace.cpp.

◆ LoadSourceLookup()

auto daq::dpm::DaqWorkspaceImpl::LoadSourceLookup ( ) const -> SourceResolver::Mapping
overridevirtual

Implements daq::dpm::DaqWorkspace.

Definition at line 251 of file workspace.cpp.

◆ LoadSpecification()

auto daq::dpm::DaqWorkspaceImpl::LoadSpecification ( ) const -> json::DpSpec
overridevirtual

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

Implements daq::dpm::DaqWorkspace.

Definition at line 275 of file workspace.cpp.

◆ LoadStatus()

auto daq::dpm::DaqWorkspaceImpl::LoadStatus ( ) const -> Status
overridevirtual

Implements daq::dpm::DaqWorkspace.

Definition at line 222 of file workspace.cpp.

◆ MakeResultSymlink()

void daq::dpm::DaqWorkspaceImpl::MakeResultSymlink ( std::filesystem::path const &  result) const
overridevirtual

Create symlink to result file.

Used to create relative symlink between

Parameters
resultAbsolute path to file result.

Implements daq::dpm::DaqWorkspace.

Definition at line 246 of file workspace.cpp.

◆ StoreSourceLookup()

void daq::dpm::DaqWorkspaceImpl::StoreSourceLookup ( SourceResolver::Mapping const &  status) const
overridevirtual

Implements daq::dpm::DaqWorkspace.

Definition at line 261 of file workspace.cpp.

◆ StoreSpecification()

void daq::dpm::DaqWorkspaceImpl::StoreSpecification ( std::string const &  specification) const
overridevirtual

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

Implements daq::dpm::DaqWorkspace.

Definition at line 287 of file workspace.cpp.

◆ StoreStatus()

void daq::dpm::DaqWorkspaceImpl::StoreStatus ( Status const &  status) const
overridevirtual

Implements daq::dpm::DaqWorkspace.

Definition at line 232 of file workspace.cpp.


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