dunedaq::dfmodules::DataStore Class Reference

comment More...

#include <DataStore.hpp>

Inheritance diagram for dunedaq::dfmodules::DataStore:

Collaboration diagram for dunedaq::dfmodules::DataStore:

Public Member Functions
	DataStore (const std::string &name)
	DataStore Constructor.
virtual void	write (const daqdataformats::TriggerRecord &tr)=0
	Writes the TriggerRecord into the DataStore.
virtual void	write (const daqdataformats::TimeSlice &ts)=0
	Writes the TimeSlice into the DataStore.
virtual void	prepare_for_run (daqdataformats::run_number_t run_number, bool run_is_for_test_purposes)=0
	Informs the DataStore that writes or reads of data blocks associated with the specified run number will soon be requested. This allows DataStore instances to make any preparations that will be beneficial in advance of the first data blocks being written or read.
virtual void	finish_with_run (daqdataformats::run_number_t run_number)=0
	Informs the DataStore that writes or reads of data blocks associated with the specified run number have finished, for now. This allows DataStore instances to do any cleanup or shutdown operations that are useful once the writes or reads for a given run number have finished.
Public Member Functions inherited from dunedaq::utilities::NamedObject
	NamedObject (const std::string &name)
	NamedObject Constructor.
	NamedObject (NamedObject const &)=delete
	NamedObject is not copy-constructible.
	NamedObject (NamedObject &&)=default
	NamedObject is move-constructible.
NamedObject &	operator= (NamedObject const &)=delete
	NamedObject is not copy-assignable.
NamedObject &	operator= (NamedObject &&)=default
	NamedObject is move-assignable.
virtual	~NamedObject ()=default
	Default virtual destructor.
const std::string &	get_name () const final
	Get the name of this NamedObejct.
Public Member Functions inherited from dunedaq::utilities::Named
	Named ()=default
	Named Constructor.
	Named (Named const &)=delete
	Named is not copy-constructible.
	Named (Named &&)=default
	Named is move-constructible.
Named &	operator= (Named const &)=delete
	Named is not copy-assignable.
Named &	operator= (Named &&)=default
	Named is move-assignable.
virtual	~Named ()=default
	Default virtual destructor.
Public Member Functions inherited from dunedaq::opmonlib::MonitorableObject
	MonitorableObject (const MonitorableObject &)=delete
MonitorableObject &	operator= (const MonitorableObject &)=delete
	MonitorableObject (MonitorableObject &&)=delete
MonitorableObject &	operator= (MonitorableObject &&)=delete
virtual	~MonitorableObject ()=default
auto	get_opmon_id () const noexcept
auto	get_opmon_level () const noexcept

Private Member Functions
	DataStore (const DataStore &)=delete
DataStore &	operator= (const DataStore &)=delete
	DataStore (DataStore &&)=delete
DataStore &	operator= (DataStore &&)=delete

Additional Inherited Members
Public Types inherited from dunedaq::opmonlib::MonitorableObject
using	NodePtr = std::weak_ptr<MonitorableObject>
using	NewNodePtr = std::shared_ptr<MonitorableObject>
using	ElementId = std::string
Static Public Member Functions inherited from dunedaq::opmonlib::MonitorableObject
static bool	publishable_metric (OpMonLevel entry, OpMonLevel system) noexcept
Protected Member Functions inherited from dunedaq::opmonlib::MonitorableObject
	MonitorableObject ()=default
void	register_node (ElementId name, NewNodePtr)
void	publish (google::protobuf::Message &&, CustomOrigin &&co={}, OpMonLevel l=to_level(EntryOpMonLevel::kDefault)) const noexcept
virtual void	generate_opmon_data ()

Detailed Description

comment

Definition at line 108 of file DataStore.hpp.

Constructor & Destructor Documentation

DataStore() [1/3]

dunedaq::dfmodules::DataStore::DataStore ( const std::string & name )

inlineexplicit

DataStore Constructor.

Parameters

name	Name of the DataStore instance

Definition at line 115 of file DataStore.hpp.

    : utilities::NamedObject(name), MonitorableObject()
  {
  }

DataStore() [2/3]

dunedaq::dfmodules::DataStore::DataStore ( const DataStore & )

privatedelete

DataStore() [3/3]

dunedaq::dfmodules::DataStore::DataStore ( DataStore && )

privatedelete

Member Function Documentation

finish_with_run()

virtual void dunedaq::dfmodules::DataStore::finish_with_run ( daqdataformats::run_number_t run_number )

pure virtual

Informs the DataStore that writes or reads of data blocks associated with the specified run number have finished, for now. This allows DataStore instances to do any cleanup or shutdown operations that are useful once the writes or reads for a given run number have finished.

operator=() [1/2]

DataStore & dunedaq::dfmodules::DataStore::operator= ( const DataStore & )

privatedelete

operator=() [2/2]

DataStore & dunedaq::dfmodules::DataStore::operator= ( DataStore && )

privatedelete

prepare_for_run()

virtual void dunedaq::dfmodules::DataStore::prepare_for_run ( daqdataformats::run_number_t run_number, bool run_is_for_test_purposes )

pure virtual

Informs the DataStore that writes or reads of data blocks associated with the specified run number will soon be requested. This allows DataStore instances to make any preparations that will be beneficial in advance of the first data blocks being written or read.

write() [1/2]

virtual void dunedaq::dfmodules::DataStore::write ( const daqdataformats::TimeSlice & ts )

pure virtual

Writes the TimeSlice into the DataStore.

Parameters

ts	TimeSlice to write.

write() [2/2]

virtual void dunedaq::dfmodules::DataStore::write ( const daqdataformats::TriggerRecord & tr )

pure virtual

Writes the TriggerRecord into the DataStore.

Parameters

tr	TriggerRecord to write.

---

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

• /github/workspace/dunedaq/sourcecode/dfmodules/include/dfmodules/DataStore.hpp