ifw-daq 3.1.0
IFW Data Acquisition modules
Loading...
Searching...
No Matches
Public Member Functions | List of all members
daq::DictKeywordFormatter Class Reference

Format (and validate) keyword according to loaded dictionary. More...

#include <dictKeywordFormatter.hpp>

+ Inheritance diagram for daq::DictKeywordFormatter:

Public Member Functions

 DictKeywordFormatter ()=default
 
void Load (std::vector< std::string > const &dictionaries)
 Load dictionaries or throw exception if not found.
 
auto GetDictionaries () const noexcept -> std::vector< std::string > const &
 
auto GetDictionariesNames () const -> std::string
 
auto Format (fits::KeywordVariant const &keyword) const -> fits::LiteralKeyword override
 Look up keyword from loaded dictionaries and format using Format(fits::KeywordVariant const&, core::dit::did::Record cont&).
 
- Public Member Functions inherited from daq::fits::KeywordFormatter
virtual ~KeywordFormatter () noexcept
 
virtual auto Format (KeywordVariant const &keyword) const -> LiteralKeyword=0
 Formats keyword.
 

Detailed Description

Format (and validate) keyword according to loaded dictionary.

Unknown keywords are rejected.

Definition at line 20 of file dictKeywordFormatter.hpp.

Constructor & Destructor Documentation

◆ DictKeywordFormatter()

daq::DictKeywordFormatter::DictKeywordFormatter ( )
default

Member Function Documentation

◆ Format()

auto daq::DictKeywordFormatter::Format ( fits::KeywordVariant const &  keyword) const -> fits::LiteralKeyword
overridevirtual

Look up keyword from loaded dictionaries and format using Format(fits::KeywordVariant const&, core::dit::did::Record cont&).

Parameters
keywordkeyword to format.
Exceptions
UnknownKeywordif keyword is not in any of the loaded dictionaries.
InvalidKeywordif keyword fails validation.

Implements daq::fits::KeywordFormatter.

Definition at line 277 of file dictKeywordFormatter.cpp.

◆ GetDictionaries()

auto daq::DictKeywordFormatter::GetDictionaries ( ) const -> std::vector<std::string> const&
noexcept
Returns
List of loaded dictionaries.

Definition at line 286 of file dictKeywordFormatter.cpp.

◆ GetDictionariesNames()

auto daq::DictKeywordFormatter::GetDictionariesNames ( ) const -> std::string
Returns
List of loaded dictionaries as comma separated string.

Definition at line 289 of file dictKeywordFormatter.cpp.

◆ Load()

void daq::DictKeywordFormatter::Load ( std::vector< std::string > const &  dictionaries)

Load dictionaries or throw exception if not found.

Parameters
dictionariesList of dictionaries to load.

Definition at line 263 of file dictKeywordFormatter.cpp.


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