ReportIterator.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/SoftwareService.h>
#include <NDEVR/WidgetIterator.h>
#include <NDEVR/TranslatedString.h>
#include <NDEVR/BaseValues.h>
#include <NDEVR/UUID.h>
#include <NDEVR/String.h>
#include <NDEVR/JSONNode.h>
#include <QSize>
#include <QRect>
class QWidget;
class QMenu;
namespace NDEVR
{
    class JSONNode;
    class QTModelManager;
    class File;
    class Model;
    /**--------------------------------------------------------------------------------------------------
    \brief A simple Template for a report
    **/
    struct NDEVR_API ReportTemplate
    {
        String id;
        String base_64;
        File file;
        ReportTemplate(const String& id, File resource);
        ReportTemplate(const String& id, const String& base_64);
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Creates a JSON data structure that can be used for generating a report in MSWord.
    **/
    struct NDEVR_API ReportJSONMaker
    {
        QTModelManager* manager;
        JSONNode root;
        ReportJSONMaker(QTModelManager* manager);
        JSONNode& templateRoot();
        void addProjectUnits();
        void setTemplate(const ReportTemplate& report_template, JSONNode& node);
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Handles creating a report page from some given data. A report page is a QWidget object that 
        is formatted for printing to a printer or PDF page.
    **/
    class NDEVR_API ReportHandler : public SoftwareService
    {
    public:
        ReportHandler(const TranslatedString& name, const TranslatedString& description, const String& icon)
            : m_name(name)
            , m_description(description)
            , m_icon(icon)
        {}
        virtual ~ReportHandler() {};
        const TranslatedString& name() const { return m_name; }
        const TranslatedString& description() const { return m_description; }
        const String& icon() const { return m_icon; }
        //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>&, QTModelManager*) const { return Buffer<UUID>(); };
 
        virtual QMenu* popupOptions() const { return nullptr; }
        //Returns true if report can handle this ID
        virtual bool canHandle(UUID, QTModelManager*) const { return false; };
 
        //Can be nullptr if cannot generate report
        virtual QWidget* getReport(const UUID&, QTModelManager*, const QRect&) const { return nullptr; };
 
        //Allowed to be no-op. Given root parent node, create nodes that contain information for report
        virtual void createReportJSON(const UUID&, JSONNode&, ReportJSONMaker&) const {};
 
        virtual UUID id() const { return UUID::CreateUUID(m_name.translationID()); }
        virtual bool defaultEnabled() const { return m_default_enabled; }
    protected:
        TranslatedString m_name;
        TranslatedString m_description;
        String m_icon;
        bool m_default_enabled = true;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Iterates through a series of reports for drawing, sending to a PDF or printing.
    **/
    class NDEVR_API ReportIterator : public WidgetIterator
    {
    public:
        ReportIterator(QTModelManager* manager);
        ReportIterator(const Buffer<const ReportHandler*>& reports, QTModelManager* manager);
        ReportIterator(const Buffer<const ReportHandler*>& reports, const Buffer<UUID>& objects_to_report, QTModelManager* manager);
        QWidget* getReport(uint04 report_index) const override;
        void setObjectsToReport(const Buffer<UUID>& objects_to_report);
        void updateAvailableReports();
        JSONNode createJSONNode() const;
        void saveReportMetaData(const File& file) const;
        void setReportHandlers(const Buffer<const ReportHandler*>& handlers);
        virtual bool canHandle(UUID model_id, QTModelManager*);
        const Buffer<const ReportHandler*>& reportHandlers() { return m_report_handlers; };
    protected:
        void sortIDs();
    protected:
        Buffer<UUID> m_objects_to_report;
        Buffer<std::pair<const ReportHandler*, UUID>> m_report_objects;
        QTModelManager* m_manager;
        Buffer<const ReportHandler*> m_report_handlers;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Storage class for all ReportHandlers.
    **/
    class NDEVR_API ReportManager : public SoftwareServiceManager
    {
    public:
        static void RegisterReportHandler(const ReportHandler* handler);
        static const Buffer<const ReportHandler*>& ReportHandlers() { return s_report_handlers; };
    protected:
        static Buffer<const ReportHandler*> s_report_handlers;
    };
}