libXpertMass Developer Documentation
  • libXpertMass
  • IsotopicDataBaseHandler
  • IsotopicDataBaseHandler Class

    class MsXpS::libXpertMass::IsotopicDataBaseHandler

    The IsotopicDataBaseHandler class features basic handling of IsotopicData. More...

    Header: #include <IsotopicDataBaseHandler.hpp>
    Inherited By:

    MsXpS::libXpertMass::IsotopicDataLibraryHandler, MsXpS::libXpertMass::IsotopicDataManualConfigHandler, and MsXpS::libXpertMass::IsotopicDataUserConfigHandler

    Public Functions

    IsotopicDataBaseHandler(const QString &file_name = QString())
    IsotopicDataBaseHandler(IsotopicDataSPtr isotopic_data_sp, const QString &file_name = QString())
    virtual ~IsotopicDataBaseHandler()
    virtual QString getFileName()
    virtual IsotopicDataSPtr getIsotopicData()
    virtual void setFileName(const QString &file_name)
    virtual void setIsotopicData(IsotopicDataSPtr isotopic_data_sp)

    Protected Variables

    QString m_fileName
    IsotopicDataSPtr msp_isotopicData

    Detailed Description

    The IsotopicDataBaseHandler class provides the skeleton for derived classes to handle IsotopicData.

    There are different isotopic data handlers:

    See also IsotopicDataLibraryHandler, IsotopicDataUserConfigHandler, and IsotopicDataManualConfigHandler.

    Member Function Documentation

    IsotopicDataBaseHandler::IsotopicDataBaseHandler(const QString &file_name = QString())

    Constructs the IsotopicDataBaseHandler with file_name.

    The msp_isotopicData is initialized by creating an empty IsotopicData instance.

    IsotopicDataBaseHandler::IsotopicDataBaseHandler(IsotopicDataSPtr isotopic_data_sp, const QString &file_name = QString())

    Constructs the IsotopicDataBaseHandler.

    isotopic_data_sp Isotopic data

    file_name File name

    [virtual noexcept] IsotopicDataBaseHandler::~IsotopicDataBaseHandler()

    Destructs the IsotopicDataBaseHandler.

    [virtual] QString IsotopicDataBaseHandler::getFileName()

    Returns the file name

    [virtual] IsotopicDataSPtr IsotopicDataBaseHandler::getIsotopicData()

    Returns the IsotopicData

    [virtual] void IsotopicDataBaseHandler::setFileName(const QString &file_name)

    Sets the file name to file_name

    [virtual] void IsotopicDataBaseHandler::setIsotopicData(IsotopicDataSPtr isotopic_data_sp)

    Sets the IsotopicData to isotopic_data_sp.

    Member Variable Documentation

    QString IsotopicDataBaseHandler::m_fileName

    This variable holds the m_fileName is the filename in which to store the IsotopicData for from with to load the IsotopicData.

    IsotopicDataSPtr IsotopicDataBaseHandler::msp_isotopicData

    This variable holds the msp_isotopicData is a pointer to IsotopicData.