BufrAccumulator.h

Go to the documentation of this file.

/*
 * (C) Copyright 2020 NOAA/NWS/NCEP/EMC
 *
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 */
 
#pragma once
 
#include <set>
 
#include "Eigen/Dense"
 
#include "BufrParser/BufrTypes.h"
 
namespace Ingester
{
    /// \brief Accumulates provided data into a dynamically expanding Eigen Array
    class BufrAccumulator
    {
     public:
        /// \param numColumns Width of collected data.
        /// \param blockSize The amount to allocate when we need to extend the Eigen Array
        explicit BufrAccumulator(Eigen::Index numColumns, Eigen::Index blockSize = 50000);
 
        /// \brief Add row of data to the internal data structure
        /// \param newRow Collection of values to add (size must match the number of columns)
        void addRow(std::vector<FloatType>& newRow);
 
        /// \brief Get an Eigen Array that contains a slice of the collected data.
        /// \param elementPos Position of mnemonic in the list of read mnemonics.
        /// \param numElementsPerSet Number of mnemonics in the list.
        /// \param indices indices to collect starting from the start position
        IngesterArray getData(Eigen::Index elementPos,
                              Eigen::Index numElementsPerSet,
                              const Channels& indices = {1});
 
        /// \brief Start over
        void reset();
 
        // Getters
        inline Eigen::Index getNumColumns() const { return numColumns_; }
 
     private:
        /// \brief Eigen Array that holds the accumulated data
        IngesterArray dataArray_;
 
        /// \brief Total number of columns (width of data structure)
        Eigen::Index numColumns_;
 
        /// \brief Number of data rows of collected data.
        Eigen::Index numDataRows_;
 
        /// \brief Amount to allocate when we need to extend the Eigen Array
        Eigen::Index blockSize_;
    };
}  // namespace Ingester