Simple-Data-Logging/data__logging_8h_source.html

 //                                                                              //
 //  Copyright (c) 2016-2018 Leonardo Consoni <consoni_2519@hotmail.com>         //
 //                                                                              //
 //  This file is part of Simple Data Logging.                                   //
 //                                                                              //
 //  Simple Data Logging is free software: you can redistribute it and/or modify //
 //  it under the terms of the GNU Lesser General Public License as published    //
 //  by the Free Software Foundation, either version 3 of the License, or        //
 //  (at your option) any later version.                                         //
 //                                                                              //
 //  Simple Data Logging is distributed in the hope that it will be useful,      //
 //  but WITHOUT ANY WARRANTY; without even the implied warranty of              //
 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                //
 //  GNU Lesser General Public License for more details.                         //
 //                                                                              //
 //  You should have received a copy of the GNU Lesser General Public License    //
 //  along with Simple Data Logging. If not, see <http://www.gnu.org/licenses/>. //
 //                                                                              //


 #ifndef DATA_LOGGING_H
 #define DATA_LOGGING_H


 #include <stddef.h>

 #define LOG_FILE_PATH_MAX_LENGTH 256
 #define DATA_LOG_MAX_PRECISION 15

 #ifdef DEBUG
   #define DEBUG_PRINT( formatString, ... ) Log_PrintString( NULL, "%s(%d): " formatString, __func__, __LINE__, __VA_ARGS__ )
 #else
   #define DEBUG_PRINT( formatString, ... )
 #endif


 typedef struct _LogData LogData;
 typedef LogData* Log;

 Log Log_Init( const char* logPath, size_t dataPrecision );

 void Log_End( Log log );

 void Log_SetDirectory( const char* directoryPath );

 void Log_SetBaseName( const char* baseName );

 void Log_RegisterValues( Log log, size_t valuesNumber, ... );

 void Log_RegisterList( Log log, size_t valuesNumber, double* valuesList );

 void Log_PrintString( Log log, const char* formatString, ... );

 void Log_EnterNewLine( Log log, double timeStamp );


 #endif // DATA_LOGGING_H
Log_End
void Log_End(Log log)
Deallocate and destroys given data structure.

Log_SetBaseName
void Log_SetBaseName(const char *baseName)
Define a common base (folder) name and time stamp for log files.

Log_PrintString
void Log_PrintString(Log log, const char *formatString,...)
Log custom string.

Log_SetDirectory
void Log_SetDirectory(const char *directoryPath)
Overwrite default root file path where logs will be saved.

LogData
struct _LogData LogData
Single log internal data structure.
Definition: data_logging.h:44

Log_Init
Log Log_Init(const char *logPath, size_t dataPrecision)
Initialize data logging to terminal or a specific text file.

Log_RegisterValues
void Log_RegisterValues(Log log, size_t valuesNumber,...)
Log a numerical values in a variable arguments list format.

Log
LogData * Log
Opaque reference to log internal data structure.
Definition: data_logging.h:45

Log_RegisterList
void Log_RegisterList(Log log, size_t valuesNumber, double *valuesList)
Log a numerical values in a array format.

Log_EnterNewLine
void Log_EnterNewLine(Log log, double timeStamp)
Enter new log line indexed in time.