Click or drag to resize

CorrectnessReportingProcess Class

Represents the process that generates correctness reports for the time-series service.
Inheritance Hierarchy
SystemObject
  GSF.TimeSeries.ReportsReportingProcessBase
    GSF.TimeSeries.ReportsCorrectnessReportingProcess

Namespace: GSF.TimeSeries.Reports
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.181-beta
Syntax
public class CorrectnessReportingProcess : ReportingProcessBase
View Source

The CorrectnessReportingProcess type exposes the following members.

Constructors
 NameDescription
Public methodCorrectnessReportingProcess Creates a new instance of the CorrectnessReportingProcess class.
Top
Properties
 NameDescription
Public propertyArchiveFilePath Gets or sets the path to the archive file to which the statistics required for reporting are archived.
(Inherited from ReportingProcessBase)
Public propertyCompany Gets or sets the name of the company to be displayed on reports.
(Inherited from ReportingProcessBase)
Public propertyEnableReportEmail Gets or sets flag to enable e-mailing of reports.
(Inherited from ReportingProcessBase)
Public propertyFromAddress Gets or sets the "from" address to use when e-mailing reports.
(Inherited from ReportingProcessBase)
Public propertyIdleReportLifetime Gets or sets the minimum lifetime of a report since the last time it was accessed, in days.
(Inherited from ReportingProcessBase)
Public propertyPersistSettings Determines whether the object settings are to be persisted to the config file.
(Inherited from ReportingProcessBase)
Public propertyReportLocation Gets or sets the directory to which reports will be written.
(Inherited from ReportingProcessBase)
Public propertyReportType Gets report type, i.e., basically the report name associated with this reporting process.
(Inherited from ReportingProcessBase)
Public propertySettingsCategory Gets or sets the category name under which the object settings are persisted in the config file.
(Inherited from ReportingProcessBase)
Public propertySmtpPassword Gets or sets the password used to authenticate to the SMTP server.
(Inherited from ReportingProcessBase)
Public propertySmtpSecurePassword Gets or sets the password used to authenticate to the SMTP server as a secure string.
(Inherited from ReportingProcessBase)
Public propertySmtpServer Gets or sets SMTP server to use when e-mailing reports.
(Inherited from ReportingProcessBase)
Public propertySmtpUsername Gets or sets the username used to authenticate to the SMTP server.
(Inherited from ReportingProcessBase)
Public propertyStatus Gets the current status details about reporting process.
(Inherited from ReportingProcessBase)
Public propertyTitle Gets or sets the title to be displayed on reports.
(Inherited from ReportingProcessBase)
Public propertyToAddresses Gets or sets the comma separated "to" addresses to use when e-mailing reports.
(Inherited from ReportingProcessBase)
Top
Methods
 NameDescription
Public methodCleanReportLocation Deletes reports from the ReportLocation that have been idle for the length of the IdleReportLifetime.
(Inherited from ReportingProcessBase)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGenerateReport Queues up a report to be generated on a separate thread.
(Inherited from ReportingProcessBase)
Public methodGetArguments Gets the command line arguments for the reporting process.
(Inherited from ReportingProcessBase)
Public methodGetArguments(DateTime, Boolean) Gets the command line arguments for the reporting process for a given report date.
(Inherited from ReportingProcessBase)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetPendingReportsList Returns the list of reports which are in the queue but are yet to be generated.
(Inherited from ReportingProcessBase)
Public methodGetReportsList Returns the list of reports that are available from the report location.
(Inherited from ReportingProcessBase)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsReportFileName Determines whether the given path is a path to a report, based on the file name.
(Inherited from ReportingProcessBase)
Public methodLoadSettings Loads saved settings from the config file.
(Inherited from ReportingProcessBase)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodSaveSettings Saves settings to the config file.
(Inherited from ReportingProcessBase)
Public methodSetArguments Applies any received command line arguments for the reporting process.
(Inherited from ReportingProcessBase)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also