HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Files · plugins/amda/include/AmdaResultParserHelper.h

Parser refactoring (1)...

Parser refactoring (1) Creates a helper that will be used to read the properties and values of an AMDA file, to generate the dataset. The helper is intended to replace the current implementation of the parser, to be more generic and thus manage the spectrograms more easily

Alexandre Leroux - - Load All Authors

File last commit:

r944:e1494a5194f1


                r944:e1494a5194f1

Download file

             AmdaResultParserHelper.h
        
                    46 lines
            
             | 1.6 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / plugins / amda / include / AmdaResultParserHelper.h
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #ifndef SCIQLOP_AMDARESULTPARSERHELPER_H

      #define SCIQLOP_AMDARESULTPARSERHELPER_H

      #include <QtCore/QLoggingCategory>

      #include <QtCore/QString>

      #include <memory>

      class IDataSeries;

      Q_DECLARE_LOGGING_CATEGORY(LOG_AmdaResultParserHelper)

      /**

       * Helper used to interpret the data of an AMDA result file and generate the corresponding data

       * series.

       *

       * It proposes methods allowing to read line by line an AMDA file and to extract the properties

       * (from the header) and the values corresponding to the data series

       *

       * @sa DataSeries

       */

      struct IAmdaResultParserHelper {

          virtual ~IAmdaResultParserHelper() noexcept = default;

          /// Verifies that the extracted properties are well formed and possibly applies other treatments

          /// on them

          /// @return true if the properties are well formed, false otherwise

          virtual bool checkProperties() = 0;

          /// Creates the data series from the properties and values extracted from the AMDA file.

          /// @warning as the data are moved in the data series, the helper shouldn't be used after

          /// calling this method

          /// @return the data series created

          virtual std::shared_ptr<IDataSeries> createSeries() = 0;

          /// Reads a line from the AMDA file to extract a property that will be used to generate the data

          /// series

          /// @param line tahe line to interpret

          virtual void readPropertyLine(const QString &line) = 0;

          /// Reads a line from the AMDA file to extract a value that will be set in the data series

          /// @param line the line to interpret

          virtual void readResultLine(const QString &line) = 0;

      };

      #endif // SCIQLOP_AMDARESULTPARSERHELPER_H

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				#ifndef SCIQLOP_AMDARESULTPARSERHELPER_H
				#define SCIQLOP_AMDARESULTPARSERHELPER_H

				#include <QtCore/QLoggingCategory>
				#include <QtCore/QString>

				#include <memory>

				class IDataSeries;

				Q_DECLARE_LOGGING_CATEGORY(LOG_AmdaResultParserHelper)

				/**
				* Helper used to interpret the data of an AMDA result file and generate the corresponding data
				* series.
				*
				* It proposes methods allowing to read line by line an AMDA file and to extract the properties
				* (from the header) and the values corresponding to the data series
				*
				* @sa DataSeries
				*/
				struct IAmdaResultParserHelper {
				virtual ~IAmdaResultParserHelper() noexcept = default;

				/// Verifies that the extracted properties are well formed and possibly applies other treatments
				/// on them
				/// @return true if the properties are well formed, false otherwise
				virtual bool checkProperties() = 0;

				/// Creates the data series from the properties and values extracted from the AMDA file.
				/// @warning as the data are moved in the data series, the helper shouldn't be used after
				/// calling this method
				/// @return the data series created
				virtual std::shared_ptr<IDataSeries> createSeries() = 0;

				/// Reads a line from the AMDA file to extract a property that will be used to generate the data
				/// series
				/// @param line tahe line to interpret
				virtual void readPropertyLine(const QString &line) = 0;

				/// Reads a line from the AMDA file to extract a value that will be set in the data series
				/// @param line the line to interpret
				virtual void readResultLine(const QString &line) = 0;
				};

				#endif // SCIQLOP_AMDARESULTPARSERHELPER_H