CompletenessReportingProcess Class

Represents the process that generates completeness reports for the time-series service.

Inheritance Hierarchy

SystemObject
GSF.TimeSeries.ReportsReportingProcessBase
GSF.TimeSeries.ReportsCompletenessReportingProcess

Namespace: GSF.TimeSeries.Reports
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.230-beta

Syntax

C++

JavaScript

Copy

public class CompletenessReportingProcess : ReportingProcessBase

Public Class CompletenessReportingProcess
	Inherits ReportingProcessBase

public ref class CompletenessReportingProcess : public ReportingProcessBase

type CompletenessReportingProcess = 
    class
        inherit ReportingProcessBase
    end

GSF.TimeSeries.Reports.CompletenessReportingProcess = function();

Type.createClass(
	'GSF.TimeSeries.Reports.CompletenessReportingProcess',
	GSF.TimeSeries.Reports.ReportingProcessBase);

View Source

The CompletenessReportingProcess type exposes the following members.

Constructors

	Name	Description
	CompletenessReportingProcess	Creates a new instance of the CompletenessReportingProcess class.

Top

Properties

	Name	Description
	ArchiveFilePath	Gets or sets the path to the archive file to which the statistics required for reporting are archived. (Inherited from ReportingProcessBase)
	Company	Gets or sets the name of the company to be displayed on reports. (Inherited from ReportingProcessBase)
	EnableReportEmail	Gets or sets flag to enable e-mailing of reports. (Inherited from ReportingProcessBase)
	FromAddress	Gets or sets the "from" address to use when e-mailing reports. (Inherited from ReportingProcessBase)
	GenerateCsvReport	Gets or sets the option to generate a csv report along with pdf report.
	IdleReportLifetime	Gets or sets the minimum lifetime of a report since the last time it was accessed, in days. (Inherited from ReportingProcessBase)
	Level3Alias	Gets or sets the alias for the level 3 category.
	Level3Threshold	Gets or sets the minimum percentage of measurements received from devices in level 3.
	Level4Alias	Gets or sets the alias for the level 4 category.
	Level4Threshold	Gets or sets the minimum percentage of measurements received from devices in level 4.
	PersistSettings	Determines whether the object settings are to be persisted to the config file. (Inherited from ReportingProcessBase)
	ReportLocation	Gets or sets the directory to which reports will be written. (Inherited from ReportingProcessBase)
	ReportType	Gets report type, i.e., basically the report name associated with this reporting process. (Inherited from ReportingProcessBase)
	SettingsCategory	Gets or sets the category name under which the object settings are persisted in the config file. (Inherited from ReportingProcessBase)
	SmtpPassword	Gets or sets the password used to authenticate to the SMTP server. (Inherited from ReportingProcessBase)
	SmtpSecurePassword	Gets or sets the password used to authenticate to the SMTP server as a secure string. (Inherited from ReportingProcessBase)
	SmtpServer	Gets or sets SMTP server to use when e-mailing reports. (Inherited from ReportingProcessBase)
	SmtpUsername	Gets or sets the username used to authenticate to the SMTP server. (Inherited from ReportingProcessBase)
	Status	Gets the current status details about reporting process. (Overrides ReportingProcessBaseStatus)
	Title	Gets or sets the title to be displayed on reports. (Inherited from ReportingProcessBase)
	ToAddresses	Gets or sets the comma separated "to" addresses to use when e-mailing reports. (Inherited from ReportingProcessBase)

Top

Methods

	Name	Description
	CleanReportLocation	Deletes reports from the ReportLocation that have been idle for the length of the IdleReportLifetime. (Inherited from ReportingProcessBase)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GenerateReport	Queues up a report to be generated on a separate thread. (Inherited from ReportingProcessBase)
	GetArguments	Gets the command line arguments for the reporting process. (Overrides ReportingProcessBaseGetArguments)
	GetArguments(DateTime, Boolean)	Gets the command line arguments for the reporting process for a given report date. (Inherited from ReportingProcessBase)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetPendingReportsList	Returns the list of reports which are in the queue but are yet to be generated. (Inherited from ReportingProcessBase)
	GetReportsList	Returns the list of reports that are available from the report location. (Inherited from ReportingProcessBase)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IsReportFileName	Determines whether the given path is a path to a report, based on the file name. (Overrides ReportingProcessBaseIsReportFileName(String))
	LoadSettings	Loads saved settings from the config file. (Overrides ReportingProcessBaseLoadSettings)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	SaveSettings	Saves settings to the config file. (Overrides ReportingProcessBaseSaveSettings)
	SetArguments	Applies any received command line arguments for the reporting process. (Overrides ReportingProcessBaseSetArguments(Arguments))
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Reference

GSF.TimeSeries.Reports Namespace