|
IReporting
|
Defines an interface for reporting processes.
Namespace: GSF.TimeSeries.Reports
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.181-beta
Syntaxpublic interface IReportingProcess : IProvideStatus, IPersistSettings
The IReportingProcess type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ArchiveFilePath | Gets or sets the path to the archive file to which the statistics required for reporting are archived. |
| Company | Gets or sets the name of the company to be displayed on reports. |
| EnableReportEmail | Gets or sets flag to enable e-mailing of reports. |
| FromAddress | Gets or sets the "from" address to use when e-mailing reports. |
| IdleReportLifetime | Gets or sets the minimum lifetime of a report since the last time it was accessed, in days. |
| Name |
Gets the name of the object providing status information.
(Inherited from IProvideStatus) |
| PersistSettings |
Determines whether the object settings are to be persisted to the config file.
(Inherited from IPersistSettings) |
| ReportLocation | Gets or sets the directory to which reports will be written. |
| ReportType | Gets report type (i.e., name) for this reporting process. |
| SettingsCategory |
Gets or sets the category name under which the object settings are persisted in the config file.
(Inherited from IPersistSettings) |
| SmtpServer | Gets or sets SMTP server to use when e-mailing reports. |
| Status |
Gets the current status details about object providing status information.
(Inherited from IProvideStatus) |
| Title | Gets or sets the title to be displayed on reports. |
| ToAddresses | Gets or sets the comma separated "to" addresses to use when e-mailing reports. |
Methods| Name | Description | |
|---|---|---|
 | CleanReportLocation | Deletes reports from the ReportLocation that have been idle for the length of the IdleReportLifetime. |
| GenerateReport | Queues up a report to be generated on a separate thread. |
| GetArguments | Gets the command line arguments for the reporting process. |
| GetArguments(DateTime, Boolean) | Gets the command line arguments for the reporting process for a given report date. |
| GetPendingReportsList | Returns the list of reports which are in the queue but are yet to be generated. |
| GetReportsList | Returns the list of reports that are available from the report location. |
| LoadSettings |
Loads saved settings from the config file.
(Inherited from IPersistSettings) |
| SaveSettings |
Saves settings to the config file.
(Inherited from IPersistSettings) |
| SetArguments | Applies any received command line arguments for the reporting process. |
See Also