NDEVR
API Documentation
NCCustomReport.h
1#pragma once
2#include "ReportGenerator/Headers/ReportOptions.h"
3#include "Base/Headers/String.h"
4#include "include/ncreport.h"
5namespace NDEVR
6{
11 class NCCustomReport : public NCReport
12 {
13 public:
16 : NCReport()
17 {
18
19 }
20
21 virtual void setToDefaults()
22 {
23
24 }
25
28 {
29 return m_options;
30 }
31
33 virtual void setReportOptions(const ReportOptions& format_source)
34 {
35 m_options = format_source;
36 reset();
37 NCReportSource* source = new NCReportSource();
38 source->setSourceType(NCReportSource::File);
39 source->setFileName(m_options.format_source.getAs<QString>(), false);
40 setReportSource(source);
42 }
43
44 virtual void setupReport()
45 {
46 };
47
49 const String& reportName() const
50 {
51 return m_report_name;
52 }
53
55 const String& reportIcon() const
56 {
57 return m_report_icon;
58 }
59
62 {
64 }
65 protected:
70 };
71}
String m_report_icon
Icon name for the report.
virtual void setToDefaults()
Resets all report settings to their defaults.
String m_report_name
Display name of the report.
virtual void setReportOptions(const ReportOptions &format_source)
Configures the report from the given options, including template source.
const String & reportName() const
Returns the display name of this report.
virtual void setupReport()
Called after setting options to perform report-specific initialization.
const ReportOptions & reportOptions() const
Returns the current report options.
String m_report_description
Description of the report's contents.
const String & reportIcon() const
Returns the icon name for this report.
ReportOptions m_options
The current report options.
const String & reportDescription() const
Returns a description of this report's contents.
NCCustomReport()
Default constructor.
Encapsulates the options needed to generate a report, including the report template path,...
The core String class for the NDEVR API.
Definition String.h:95
The primary namespace for the NDEVR SDK.