Data1DViewItem.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Data/Data1DViewItem.h
//! @brief     Defines class Data1DViewItem
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_GUI_MODEL_DATA_DATA1DVIEWITEM_H
#define BORNAGAIN_GUI_MODEL_DATA_DATA1DVIEWITEM_H
 
#include "GUI/Model/BaseItem/SessionItem.h"
#include "GUI/Model/Descriptor/SelectionDescriptor.h"
 
class AmplitudeAxisItem;
class BasicAxisItem;
class ComboProperty;
class DataPropertyContainer;
class Data1DProperties;
class DataItem;
class JobItem;
class Datafield;
 
//! View model for 1D DataItem. Can represent several items
//! at once. In current implementation the first of carried
//! items determines axes' limits.
 
class BA_CORE_API_ Data1DViewItem : public SessionItem {
private:
    static constexpr auto P_TITLE{"Title"};
    static constexpr auto P_XAXIS{"x-axis"};
    static constexpr auto P_YAXIS{"y-axis"};
    static constexpr auto P_AXES_UNITS{"Axes Units"};
    static constexpr auto T_DATA_PROPERTIES{"Data property container"};
 
public:
    static constexpr auto M_TYPE{"Data1DViewItem"};
 
    Data1DViewItem();
 
    //! Number of bins in data
    int getNbins() const;
 
    //! Returns lower and upper zoom ranges of x-axis
    double getLowerX() const;
    double getUpperX() const;
 
    //! Returns lower and upper zoom ranges of y-axis
    double getLowerY() const;
    double getUpperY() const;
 
    bool isLog() const;
    QString getXaxisTitle() const;
    QString getYaxisTitle() const;
 
    const BasicAxisItem* xAxisItem() const;
    BasicAxisItem* xAxisItem();
    const AmplitudeAxisItem* yAxisItem() const;
    AmplitudeAxisItem* yAxisItem();
 
    static bool isXAxisPropertyName(const QString& name);
    static bool isYAxisPropertyName(const QString& name);
 
    void resetView();
 
    void setXaxisTitle(const QString& title);
    void setYaxisTitle(const QString& title);
    void setAxesRangeToData();
 
    ComboProperty axesUnits() const;
    void setAxesUnits(const ComboProperty& units);
    SelectionDescriptor<QString> axesUnitsDescriptor() const;
    static bool isAxesUnitsPropertyName(const QString& name);
 
    //! Returns data view to default state (no dimensional units, default axes' names)
    void resetToDefault();
 
    //! Returns point data for drawing
    QPair<QVector<double>, QVector<double>> graphData(Data1DProperties* property_item);
 
    //! Sets job item (for unit conversion) if DataItemView
    //! is dynamically created outside of JobModel
    void setJobItem(JobItem* job_item) { m_job_item = job_item; }
 
    //! Returns either parenting JobItem or
    //! job item set with DataItem1DView::setJobItem.
    JobItem* jobItem();
 
    void setLowerX(double value);
    void setUpperX(double value);
    void setLowerY(double value);
    void setUpperY(double value);
    void setLog(bool log_flag);
 
    DataPropertyContainer* propertyContainerItem();
    DataPropertyContainer* createPropertyContainerItem();
 
private:
    QPair<double, double> dataRange(const Datafield* data) const;
 
    JobItem* m_job_item;
};
 
#endif // BORNAGAIN_GUI_MODEL_DATA_DATA1DVIEWITEM_H