daq::DaqContext Struct Reference

Structure carrying context needed to start a Data Acquisition and construct a Data Product Specification needed to execute merge. More...

#include <daqContext.hpp>

Classes
struct	Source

Public Member Functions
	DaqContext ()=default
	DaqContext (DaqContext const &)=default
	DaqContext (DaqContext &&)=default
DaqContext &	operator= (DaqContext &&)=default
DaqContext &	operator= (DaqContext const &)=default

Public Attributes
std::string	id
	DAQ identfier, possibly provided by user. More...
std::string	file_id
	Data Product FileId as specified by OLAS ICD. More...
std::string	process_name
	User defined process name. More...
std::string	dp_name_prefix
	Data product file name prefix. More...
std::vector< Source >	prim_sources
std::vector< Source >	meta_sources
std::vector< daq::fits::KeywordVariant >	keywords
	Keyword list provided by OCM to Data Product. More...
std::chrono::milliseconds	await_interval = std::chrono::seconds(10)
	Interval (and thus duration) of the requests sent to primary sources to await end of recording. More...
DpParts	results
	Results from Data Acquisition (FITS files and keywords). More...
std::chrono::system_clock::time_point	creation_time
	Time when DAQ was created. More...
std::optional< json::StartDaqV2Spec >	specification
	Optional specification, if DAQ was started using StartDaqV2. More...

Detailed Description

Structure carrying context needed to start a Data Acquisition and construct a Data Product Specification needed to execute merge.

This information can be serialized and deserialized to facilitate persitant storage.

In practice this means it must contain:

• Data sources
• Results from acquisition phase (files and keywords)
• Per-DAQ User options

When creating a Data Product Specification consider:

• results contain files and keywords from data sources and keywords the user-provided keywords via request/reply interface (StartDaq/UpdateKeywords). Both must be considered when creating the final Data Product Specification.
• results is not sorted according.

@seealso daq::Status

Definition at line 44 of file daqContext.hpp.

---

Class Documentation

daq::DaqContext::Source

struct daq::DaqContext::Source

Definition at line 45 of file daqContext.hpp.

Class Members
string	name
string	rr_uri

Constructor & Destructor Documentation

DaqContext() [1/3]

daq::DaqContext::DaqContext ( )

default

DaqContext() [2/3]

daq::DaqContext::DaqContext ( DaqContext const &  )

default

DaqContext() [3/3]

daq::DaqContext::DaqContext ( DaqContext &&  )

default

Member Function Documentation

operator=() [1/2]

DaqContext& daq::DaqContext::operator= ( DaqContext &&  )

default

operator=() [2/2]

DaqContext& daq::DaqContext::operator= ( DaqContext const &  )

default

Member Data Documentation

await_interval

std::chrono::milliseconds daq::DaqContext::await_interval = std::chrono::seconds(10)

Interval (and thus duration) of the requests sent to primary sources to await end of recording.

Default is 10 seconds.

Definition at line 94 of file daqContext.hpp.

creation_time

std::chrono::system_clock::time_point daq::DaqContext::creation_time

Time when DAQ was created.

This should correspond to the exact time used for generating the file_id.

Definition at line 108 of file daqContext.hpp.

dp_name_prefix

std::string daq::DaqContext::dp_name_prefix

Data product file name prefix.

Definition at line 75 of file daqContext.hpp.

file_id

std::string daq::DaqContext::file_id

Data Product FileId as specified by OLAS ICD.

Definition at line 65 of file daqContext.hpp.

id

std::string daq::DaqContext::id

DAQ identfier, possibly provided by user.

If user does not provide an id for the DAQ when starting it is identical to file_id.

Definition at line 60 of file daqContext.hpp.

keywords

std::vector<daq::fits::KeywordVariant> daq::DaqContext::keywords

Keyword list provided by OCM to Data Product.

Keywords comes from:

• StartDaq() request
• UpdateKeywords() request
• OCM internal keywords.

Definition at line 87 of file daqContext.hpp.

meta_sources

std::vector<Source> daq::DaqContext::meta_sources

Definition at line 77 of file daqContext.hpp.

prim_sources

std::vector<Source> daq::DaqContext::prim_sources

Definition at line 76 of file daqContext.hpp.

process_name

std::string daq::DaqContext::process_name

User defined process name.

Definition at line 70 of file daqContext.hpp.

results

DpParts daq::DaqContext::results

Results from Data Acquisition (FITS files and keywords).

Note

The sources are sorted by order of creation, not order they should appear in DpSpec!

Definition at line 102 of file daqContext.hpp.

specification

std::optional<json::StartDaqV2Spec> daq::DaqContext::specification

Optional specification, if DAQ was started using StartDaqV2.

Some fields are duplicated or provided in different format, like dp_name_prefix, prim_sources and meta_sources.

Definition at line 116 of file daqContext.hpp.

---

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

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