NDEVR
API Documentation
NCCustomReport

A customizable NCReport subclass that applies NDEVR ReportOptions and provides metadata (name, icon, description) for report selection UI. More...

Collaboration diagram for NCCustomReport:
[legend]

Public Member Functions

 NCCustomReport ()
 Default constructor.
const String & reportDescription () const
 Returns a description of this report's contents.
const String & reportIcon () const
 Returns the icon name for this report.
const String & reportName () const
 Returns the display name of this report.
const ReportOptions & reportOptions () const
 Returns the current report options.
virtual void setReportOptions (const ReportOptions &format_source)
 Configures the report from the given options, including template source.
virtual void setToDefaults ()
 Resets all report settings to their defaults.
virtual void setupReport ()
 Called after setting options to perform report-specific initialization.

Protected Attributes

ReportOptions m_options
 The current report options.
String m_report_description
 Description of the report's contents.
String m_report_icon
 Icon name for the report.
String m_report_name
 Display name of the report.

Detailed Description

A customizable NCReport subclass that applies NDEVR ReportOptions and provides metadata (name, icon, description) for report selection UI.

Definition at line 11 of file NCCustomReport.h.

Member Function Documentation

◆ reportDescription()

const String & NCCustomReport::reportDescription ( ) const
inline

Returns a description of this report's contents.

Returns
Reference to the description string.

Definition at line 61 of file NCCustomReport.h.

References m_report_description.

◆ reportIcon()

const String & NCCustomReport::reportIcon ( ) const
inline

Returns the icon name for this report.

Returns
Reference to the report icon string.

Definition at line 55 of file NCCustomReport.h.

References m_report_icon.

◆ reportName()

const String & NCCustomReport::reportName ( ) const
inline

Returns the display name of this report.

Returns
Reference to the report name string.

Definition at line 49 of file NCCustomReport.h.

References m_report_name.

◆ reportOptions()

const ReportOptions & NCCustomReport::reportOptions ( ) const
inline

Returns the current report options.

Returns
Reference to the report options.

Definition at line 27 of file NCCustomReport.h.

References m_options.

◆ setReportOptions()

virtual void NCCustomReport::setReportOptions ( const ReportOptions & format_source)
inlinevirtual

Configures the report from the given options, including template source.

Parameters
[in]format_sourceThe report options to apply.

Definition at line 33 of file NCCustomReport.h.

References m_options, and setupReport().

The documentation for this class was generated from the following file: