DeploymentReport.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#if NDEVR_DEPLOYMENT
#include <NDEVR/ReportIterator.h>
#include <NDEVR/QTDesignObject.h>
#include <NDEVR/Deployment.h>
#include <NDEVR/ApplicationOptions.h>
#include <QMenu>
namespace Ui
{
    class DeploymentReportUI;
}
namespace NDEVR
{
    class TopDownDeploymentChart;
    class SideViewDeploymentChart;
    class StationModel;
    class Calibration;
    class Project;
    class DeploymentReport;
    class QCustomComboBox;
    /**--------------------------------------------------------------------------------------------------
    \brief Describes the various types of Deployment report formats optimized for horizontal vs vertical
        deployments.
    **/
    enum class DeploymentReportType
    {
          e_best_fit
        , e_vertical
        , e_horizontal
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Special options for a deployment Report
    **/
    class DeploymentReportOptions : public QMenu
    {
    public:
        DeploymentReportOptions(DeploymentReportType type, QWidget* parent = nullptr);
        DeploymentReportType reportType() const;
    protected:
        QCustomComboBox* m_type_combo;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A ReportHander that manages creating a multi-chart Deployment report.
    **/
    class NDEVR_CHARTS_API DeploymentReportHandler : public ReportHandler
    {
    public:
        DeploymentReportHandler();
        //Given a list of model objects, returns report IDs it requests to handle. Note report ID's can be Model IDs, or unique to this object.
        //Returned IDs will be stored, then used with canHandle, getReport, and createReportJSON
        virtual Buffer<UUID> defaultReportIDs(const Buffer<UUID>& objects_to_report, QTModelManager* manager) const override;
 
        //Returns true if report can handle this ID
        virtual bool canHandle(UUID id, QTModelManager* manager) const override;
 
        //Can be nullptr if cannot generate report
        virtual QWidget* getReport(const UUID& id, QTModelManager* manager, const QRect& requested_geometry) const override;
 
        DeploymentReportType reportType() const;
        bool autoIncludePlanned() const;
        //Allowed to be no-op
        virtual void createReportJSON(const UUID& id, JSONNode& parent, ReportJSONMaker& maker) const override;
        virtual QMenu* popupOptions() const override;
    protected:
        mutable DeploymentReportOptions* m_report_options;
        mutable DeploymentReport* m_report = nullptr;
        static ApplicationOption<DeploymentReportType> s_report_type;
        static ApplicationOption<bool> s_auto_include_planned;
    };
 
    class DeploymentReport : public QWidget
    {
    public:
        DeploymentReport(QWidget* parent = nullptr);
        ~DeploymentReport();
        void setReportType(DeploymentReportType report_type);
        void setAutoIncludePlanned(bool include_planned);
        void setDeployment(const DynamicPointer<QTDesignObject>& deployment);
        void setDeployments(const Buffer<Deployment>& deployments);
        void setStation(const StationModel& station);
        void setCalibration(const Calibration& station);
        void setProject(const Project& project);
        void clearStation();
        void clearCalibration();
        void resizeEvent(QResizeEvent* event);
    protected:
        void updateName();
        void updateUI();
    protected:
        String m_station_name;
        String m_deployment_name;
        String m_row_name;
        Time m_survey_time;
        TopDownDeploymentChart* m_top_down_chart;
        SideViewDeploymentChart* m_front_chart;
        SideViewDeploymentChart* m_side_chart;
        Ui::DeploymentReportUI* ui;
        Vertex<3, fltp08> m_average_hole_bottom;
        Vertex<3, fltp08> m_planned_hole_bottom;
        Vertex<3, fltp08> m_collar_location;
        fltp08 m_average_length;
        fltp08 m_planned_length;
        DeploymentReportType m_report_type = DeploymentReportType::e_best_fit;
        bool m_auto_include_planned = false;
    };
}
#endif