tsLogger.h

Go to the documentation of this file.

#pragma once
#ifndef _TSLOGGER_H
#define _TSLOGGER_H
#include <cstdio>
#include <string>
#include <iostream>
#include <vector>
#include <variant>
#include <algorithm>
#include <ctime>
 
#define defaultFilePath     "C:\\data"
#define defaultFileName     "tsDataLog"
#define defaultDataName     "datapoint"
#define fileNameLength      400
#define defLogBufferSize    1000
#define defHeaderBufSize    1000
#define defDataBufSize      100
 
typedef enum _tsLogFileType
{
    _TSLOGGER_CSV           = 0,
    _TSLOGGER_BINARY        = 1
}tsLogFileType;
 
using smartDataPtr = std::variant   <int*, unsigned int*, \
                                    long*, unsigned long*, \
                                    long long*, unsigned long long*, \
                                    float*, double*, \
                                    char*, unsigned char*, \
                                    bool* >;
 
struct tsDataPointer {
    std::string dataName; // data name
    smartDataPtr dataPtr; // variant pointer to data    
};
 
class tsLogger {
    // File properties
    time_t              logUnixTime;
    char                fileName[fileNameLength];
    tsLogFileType       fileType;
    FILE*               logFilePtr;
 
 
    // Buffers
    size_t                      logBufferSize;
    char*                       logBuffer;
    std::string                 preamble; // stores info like number of preamble+header lines, time of file creation
    std::string                 tsHeader;
    std::vector<tsDataPointer>  dataVector;
 
    // Logger object parameters
    unsigned            numHeaderLines;
    size_t              dataVecLen;
    bool                canAddPreamble, canAddDataHeader, isLogggingStart;
 
    // Private member functions
 
    int initLogger();
 
    // Public member functions
public:
    // tsLogger Constructors
 
    tsLogger();
 
    tsLogger(tsLogFileType logFileType);
 
    tsLogger(const char* logFileName);
 
    tsLogger(const char* logFileName, tsLogFileType logFileType);
 
    tsLogger(const char* logFileName, tsLogFileType logFileType, size_t logBufferMaxSize);
 
    // Functions to read logger state
 
    void getFilePath(char* pathDestination, size_t pathDestinationLength);
 
    size_t getNumDataPoints();
 
    // Functions/templates to modify logger state
 
    template <typename T> unsigned trackDataPoint(T* dataPointer, const std::string& dataName)
    {
        tsDataPointer newData;
        if (canAddDataHeader != true) {
            return -1; // data cannot be added after the data header has been written to file.
        }
        if (isLogggingStart != false) {
            return -2; // data can't be added after logging has started.
        }
        if (dataPointer != nullptr) {
            if (dataName.empty()) {
                newData.dataName = defaultDataName + std::to_string(this->dataVecLen);
            }
            else {
                newData.dataName = dataName;
                // sanity check name so there is no trouble when eventually inserting names in the CSV header
                std::replace(newData.dataName.begin(), newData.dataName.end(), '\n', ' '); // replace all new line characters with spaces
                std::replace(newData.dataName.begin(), newData.dataName.end(), ',' , ' '); // replace all comma characters with spaces
                std::replace(newData.dataName.begin(), newData.dataName.end(), '\r', ' '); // replace all carriage return characters with spaces
                std::replace(newData.dataName.begin(), newData.dataName.end(), '\0', ' '); // replace all EOF characters with spaces
            }
            newData.dataPtr = dataPointer;
 
            this->dataVector.push_back(newData);
            this->dataVecLen = this->dataVector.size();
        }
        return this->dataVecLen;
    }
 
    void appendToPreamble(std::string appendString);
 
    void addPreamble();
 
    void addDataHeader();
    
    // Functions to log data
 
    void startLogger();
 
    void logData();
 
    // tsLogger Destructor
    ~tsLogger();
};
 
#endif // !_TSLOGGER_H