Hdf5Logger.h

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
/*
HDF5 Logger header file
 
Author: Alex Reynolds
*/
#ifndef HDF5_LOGGER_H
#define HDF5_LOGGER_H
 
#include <vector>
 
#include "highfive/highfive.hpp"
#include "logging/SimLogger.h"
 
namespace modelspace {
 
    /// @brief   Class for logging to HDF5
    /// 
    /// The CSV logger is a class that inherits from the base logger
    /// class and manually configures it to write to CSV.
    class Hdf5Logger : public clockwerk::SimLogger {
    public:
        /// Constructor for CSV logger -- wraps around logger constructor
        Hdf5Logger(clockwerk::Executive &exec, const std::string &filename="output.h5", unsigned int buffer_size=1);
        ~Hdf5Logger();
 
        /// @brief   Function to close down the file -- logs remaining buffered data
        ///          and closes
        int close();
    protected:
        /// @brief   Function to create an HDF5 file for logging
        int _createSetupFile();
 
        /// @brief   Function to write buffered data to HDF5 file
        int _writeToFile();
 
        /// High Five variables for writing HDF5 to file
        HighFive::File* _file;
        HighFive::DataSpace* _dataspace;
        HighFive::DataSetCreateProps _props;
        std::vector<HighFive::DataSet> _datasets;
 
        /// Index to track where we're writing to our dataset
        unsigned long long _l_start_idx;
        unsigned long long _l_end_idx;
    };
 
}
 
#endif