merge.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_dpm_merge
 * @copyright ESO - European Southern Observatory
 */
#ifndef DAQ_DPM_MERGE_MERGE_HPP
#define DAQ_DPM_MERGE_MERGE_HPP
#include <vector>
 
#include <log4cplus/logger.h>
 
#include "sources.hpp"
 
namespace daq::dpm::merge {
 
/**
 * Base class of merge events.
 */
class MergeEvent {
public:
};
 
/**
 * Interface to reporter (implementations exist for JSON or human readable)
 */
class StatusReporter {
public:
    /**
     * Post event
     */
    virtual void PostAlert(std::string const& id, std::string const& message) = 0;
};
 
class KeywordFormatter {
public:
    /**
     * Format keyword.
     *
     * @param keyword Keyword to format.
     */
    virtual fits::LiteralKeyword FormatKeyword(fits::KeywordVariant const& keyword) = 0;
};
 
class KeywordSorter {
public:
    /**
     * Sort keywords
     *
     * @note Sorting function must abide by FITS standard and e.g. not reorder keywords with a
     * mandatory order.
     *
     * @param[in,out] keywords Vector of keywords to format.
     */
    virtual void SortKeywords(std::vector<fits::LiteralKeyword>& keywords) = 0;
};
 
/**
 * Interface to a keyword selector.
 */
class KeywordFilter {
public:
    /**
     * Creates a keyword pattern selector
     *
     * @param patterns Selection patterns in the format: "+e INS *", "-e INS TEMP[12] *",
     *        "+v VALUEKW".
     * @returns Function that returns true for the provided keyword if it patches the pattern, and
     *          false otherwise.
     */
    virtual std::function<bool(fits::KeywordVariant const&)>
    MakePatternsFilter(std::vector<std::string> const& patterns) = 0;
};
 
class KeywordTransform {
public:
    /**
     * Replace keyword name using regular expression.
     *
     * @param regexp Regular expression pattern.
     * @param format Regular expression format replacement string.
     */
    virtual void Transform(std::string const& regexp,
                           std::string const& format,
                           fits::KeywordVector::iterator begin,
                           fits::KeywordVector::iterator end) = 0;
};
 
struct Operations {
    StatusReporter& status_reporter;
    KeywordFormatter& keyword_formatter;
    KeywordSorter& keyword_sorter;
    log4cplus::Logger const& logger;
};
 
void MergePrimaryHduKeywords(Operations ops,
                             TargetSource& target,
                             std::vector<SourceTypes> const& sources,
                             bool dry_run);
 
struct Params {
    std::string arcfile;
    std::string origfile;
};
 
/**
 * Check for data in primary HDU which would not be merged and produce alert.
 *
 * @param status_reporter The implementation used to set alert.
 * @param file The file to check.
 */
void CheckUnmergedPrimaryHduData(log4cplus::Logger const& logger,
                                 StatusReporter& status_reporter,
                                 FitsFileSource const& source);
 
/**
 * Merge @a sources into the target @a target.
 *
 * @param[in,out] target FITS file target.
 * @param sources Input sources.
 */
void Merge(Operations ops,
           Params const& params,
           TargetSource& target,
           std::vector<SourceTypes> const& sources,
           bool dry_run);
 
}  // namespace daq::dpm::merge
 
#endif  // #ifndef DAQ_DPM_MERGE_MERGE_HPP