Andreas Suter
4de660788d
All checks were successful
Build and Deploy Documentation / build-and-deploy (push) Successful in 26s
128 lines
7.6 KiB
C++
128 lines
7.6 KiB
C++
/***************************************************************************
|
|
|
|
BMWStartupHandler.h
|
|
|
|
Author: Bastian M. Wojek
|
|
|
|
based upon:
|
|
PStartupHandler.h
|
|
by Andreas Suter
|
|
|
|
***************************************************************************/
|
|
|
|
/***************************************************************************
|
|
* Copyright (C) 2007-2026 by Andreas Suter, Bastian M. Wojek *
|
|
* *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
* This program 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 General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with this program; if not, write to the *
|
|
* Free Software Foundation, Inc., *
|
|
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
|
|
***************************************************************************/
|
|
|
|
/**
|
|
* @file BMWStartupHandler.h
|
|
* @brief Header file for the XML startup file handler for BMW tools.
|
|
*
|
|
* This file contains the BMWStartupHandler class which parses the BMW_startup.xml
|
|
* configuration file and provides default settings for the BMWtools plugin libraries.
|
|
*
|
|
* @author Bastian M. Wojek (based on PStartupHandler.h by Andreas Suter)
|
|
*/
|
|
|
|
#ifndef _BMWSTARTUPHANDLER_H_
|
|
#define _BMWSTARTUPHANDLER_H_
|
|
|
|
#include <TList.h>
|
|
#include <TQObject.h>
|
|
#include <string>
|
|
#include <vector>
|
|
#include <map>
|
|
|
|
/**
|
|
* @class BMWStartupHandler
|
|
* @brief Handles the XML musrfit startup file (BMW_startup.xml) where default settings for plugin libraries are stored.
|
|
*
|
|
* This class is a SAX2-based XML parser handler that reads and processes the BMW_startup.xml configuration file.
|
|
* The configuration file contains default settings for:
|
|
* - TRIM.SP data file path and energies (for low-energy muon implantation profiles)
|
|
* - Time and field resolutions for Fourier transforms
|
|
* - Paths to FFTW3 wisdom files (double and float precision)
|
|
* - Number of steps for one-dimensional theory functions (where needed)
|
|
* - Number of steps for two-dimensional grids when calculating spatial field distributions in vortex lattices
|
|
* - Time resolutions and lengths of Laplace transforms used in the calculation of LF-relaxation functions
|
|
* - Debug flag for verbose output of the information contained in the startup file
|
|
*/
|
|
class BMWStartupHandler : public TQObject {
|
|
public:
|
|
BMWStartupHandler();
|
|
virtual ~BMWStartupHandler();
|
|
|
|
virtual void OnStartDocument(); ///< Called when XML parsing begins
|
|
virtual void OnEndDocument(); ///< Called when XML parsing ends
|
|
virtual void OnStartElement(const char*, const TList*); ///< Called when an XML element starts
|
|
virtual void OnEndElement(const char*); ///< Called when an XML element ends
|
|
virtual void OnCharacters(const char*); ///< Called when XML character data is encountered
|
|
virtual void OnComment(const char*); ///< Called when an XML comment is encountered
|
|
virtual void OnWarning(const char*); ///< Called when the XML parser emits a warning
|
|
virtual void OnError(const char*); ///< Called when the XML parser emits an error
|
|
virtual void OnFatalError(const char*); ///< Called when the XML parser emits a fatal error
|
|
virtual void OnCdataBlock(const char*, int); ///< Called when an XML CDATA block is encountered
|
|
|
|
virtual void CheckLists(); ///< Validates and sets default values for configuration parameters
|
|
|
|
virtual const std::string GetDataPath() const { return fDataPath; } ///< returns the path to TRIM.SP files
|
|
virtual std::map<double, std::string> GetEnergies() const { return fEnergies; } ///< returns energies and file labels of available TRIM.SP files
|
|
virtual const double GetDeltat() const { return fDeltat; } ///< returns the time resolution of P(t) when using Fourier transforms
|
|
virtual const double GetDeltaB() const { return fDeltaB; } ///< returns the field resolution of p(B) when using Fourier transforms
|
|
virtual const std::string GetWisdomFile() const { return fWisdomFile; } ///< returns the path to the FFTW3 double-wisdom file
|
|
virtual const std::string GetWisdomFileFloat() const { return fWisdomFileFloat; } ///< returns the path to the FFTW3 float-wisdom file
|
|
virtual const unsigned int GetNSteps() const { return fNSteps; } ///< returns the number of steps in one-dimensional theory functions
|
|
virtual const unsigned int GetGridSteps() const { return fGridSteps; } ///< returns the number of steps in each direction when calculating two-dimensional spatial field distributions
|
|
virtual const double GetDeltatLF() const { return fDeltatLF; } ///< returns the time resolution of P(t) when using Laplace transforms for the calculation of LF-relaxation functions
|
|
virtual const unsigned int GetNStepsLF() const { return fNStepsLF; } ///< returns the length of the Laplace transforms for the calculation of LF-relaxation functions
|
|
virtual const bool GetDebug() const { return fDebug; } ///< true = debug the xml-entries
|
|
|
|
private:
|
|
/**
|
|
* @brief Enumeration of XML element keywords used for parsing.
|
|
*/
|
|
enum EKeyWords {eEmpty, eComment, eDebug, eLEM, eVortex, eLF, eDataPath, eEnergyLabel, \
|
|
eEnergy, eEnergyList, eDeltat, eDeltaB, eWisdomFile, eWisdomFileFloat, \
|
|
eNSteps, eGridSteps, eDeltatLF, eNStepsLF};
|
|
|
|
EKeyWords fKey; ///< Current XML element being parsed
|
|
|
|
bool fDebug; ///< Debug flag for verbose output
|
|
bool fLEM; ///< Low-energy muSR mode flag
|
|
bool fVortex; ///< Vortex lattice calculations flag
|
|
bool fLF; ///< Longitudinal field mode flag
|
|
std::string fDataPath; ///< Path to TRIM.SP data files directory
|
|
std::vector<std::string> fEnergyLabelList; ///< File name labels of the TRIM.SP files
|
|
std::vector<double> fEnergyList; ///< Muon implantation energies in keV of the TRIM.SP files
|
|
std::map<double, std::string> fEnergies; ///< Map of muon implantation energies (keV) to file labels
|
|
double fDeltat; ///< Time resolution in microseconds for P(t) when using Fourier transforms
|
|
double fDeltaB; ///< Field resolution in Gauss for p(B) when using Fourier transforms
|
|
std::string fWisdomFile; ///< Path to FFTW3 double-precision wisdom file
|
|
std::string fWisdomFileFloat; ///< Path to FFTW3 single-precision wisdom file
|
|
unsigned int fNSteps; ///< Number of steps in one-dimensional theory functions
|
|
unsigned int fGridSteps; ///< Number of grid points in each direction for 2D spatial field distributions
|
|
double fDeltatLF; ///< Time resolution in microseconds for P(t) in LF Laplace transforms
|
|
unsigned int fNStepsLF; ///< Length of the Laplace transforms for LF relaxation functions
|
|
|
|
ClassDef(BMWStartupHandler, 1)
|
|
};
|
|
|
|
#endif // _BMWSTARTUPHANDLER_H_
|
|
|