CsvLogger.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.
******************************************************************************/
/*
CSV Logger header file
 
Author: Alex Reynolds
*/
#ifndef CSV_LOGGER_H
#define CSV_LOGGER_H
 
#include <fstream>
 
#include "logging/SimLogger.h"
 
namespace modelspace {
 
    /// @brief   Class for logging to CSV
    /// 
    /// The CSV logger is a class that inherits from the base logger
    /// class and manually configures it to write to CSV.
    class CsvLogger : public clockwerk::SimLogger {
    public:
        /// Constructor for CSV logger -- wraps around logger constructor
        CsvLogger(clockwerk::Executive &exec, const std::string &filename="output.csv", unsigned int buffer_size=1);
        ~CsvLogger() {close();}
 
        /// @brief   Function to set the delimeter
        /// @param   delim   The delimeter to separate file values
        int delimeter(const std::string &delim);
 
        /// @brief   Function to set CSV logger filename
        /// @param   The filename to set. If no extension applies, auto-set to .csv
        /// @return  Error code corresponding to success/failure
        int filename(std::string name);
 
        /// @brief   Function to close down the file -- logs remaining buffered data
        ///          and closes
        int close();
 
        /// @brief Function to set the precision of CSV logging
        /// @param precision The precision to set logging to as # of decimal places
        /// @return Error code corresponding to success/failure
        int setPrecision(int precision);
    protected:
        /// @brief   Function to create a CSV file for logging
        int _createSetupFile();
 
        /// @brief   Function to write buffered data to CSV file
        int _writeToFile();
 
        /// Stream variable to write file to
        std::ofstream _fout;
 
        /// String to indicate delimeter -- set to comma by default
        std::string _delimeter;
 
        /// The precision of logging. Default is 20 places
        int _precision = 20;
    };
 
}
 
#endif