dunedaq::snbmodules::MetadataAbstract Class Reference

Abstract class for metadata classes, they must be able to generate and load metadata files. More...

#include <metadata_abstract.hpp>

Inheritance diagram for dunedaq::snbmodules::MetadataAbstract:

Public Member Functions
virtual	~MetadataAbstract ()=default
virtual std::string	export_to_string ()=0
	Export metadata to string (json format)
virtual void	from_string (const std::string &s)=0
	Import metadata from string (json format)
virtual void	generate_metadata_file (std::filesystem::path dest)=0
	Generaete metadata file to dest.
virtual void	load_metadata_from_meta_file (std::filesystem::path src)=0
	Load metadata file from src.
virtual bool	operator== (MetadataAbstract const &other) const =0
	Operator ==.
virtual bool	operator< (MetadataAbstract const &other) const =0
	Operator <.

Detailed Description

Abstract class for metadata classes, they must be able to generate and load metadata files.

Definition at line 26 of file metadata_abstract.hpp.

Constructor & Destructor Documentation

~MetadataAbstract()

virtual dunedaq::snbmodules::MetadataAbstract::~MetadataAbstract ( )

virtualdefault

Member Function Documentation

export_to_string()

virtual std::string dunedaq::snbmodules::MetadataAbstract::export_to_string ( )

pure virtual

Export metadata to string (json format)

Returns

Metadata in string format

Implemented in dunedaq::snbmodules::GroupMetadata, and dunedaq::snbmodules::TransferMetadata.

from_string()

virtual void dunedaq::snbmodules::MetadataAbstract::from_string ( const std::string & s )

pure virtual

Import metadata from string (json format)

Implemented in dunedaq::snbmodules::GroupMetadata, and dunedaq::snbmodules::TransferMetadata.

generate_metadata_file()

virtual void dunedaq::snbmodules::MetadataAbstract::generate_metadata_file ( std::filesystem::path dest )

pure virtual

Generaete metadata file to dest.

Parameters

dest

Implemented in dunedaq::snbmodules::GroupMetadata, and dunedaq::snbmodules::TransferMetadata.

load_metadata_from_meta_file()

virtual void dunedaq::snbmodules::MetadataAbstract::load_metadata_from_meta_file ( std::filesystem::path src )

pure virtual

Load metadata file from src.

Parameters

src

Implemented in dunedaq::snbmodules::GroupMetadata, and dunedaq::snbmodules::TransferMetadata.

operator<()

virtual bool dunedaq::snbmodules::MetadataAbstract::operator< ( MetadataAbstract const & other ) const

pure virtual

Operator <.

Implemented in dunedaq::snbmodules::GroupMetadata, and dunedaq::snbmodules::TransferMetadata.

operator==()

virtual bool dunedaq::snbmodules::MetadataAbstract::operator== ( MetadataAbstract const & other ) const

pure virtual

Operator ==.

Implemented in dunedaq::snbmodules::GroupMetadata, and dunedaq::snbmodules::TransferMetadata.

---

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

• /github/workspace/dunedaq/sourcecode/snbmodules/include/snbmodules/metadata_abstract.hpp