ReportingProcessBase Class

Represents the base functionality for reporting processes.

Inheritance Hierarchy

SystemObject
  GSF.TimeSeries.ReportsReportingProcessBase
    GSF.TimeSeries.ReportsCompletenessReportingProcess
    GSF.TimeSeries.ReportsCorrectnessReportingProcess

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

Syntax

C++

JavaScript

Copy

public abstract class ReportingProcessBase : IReportingProcess, 
	IProvideStatus, IPersistSettings

Public MustInherit Class ReportingProcessBase
	Implements IReportingProcess, IProvideStatus, IPersistSettings

public ref class ReportingProcessBase abstract : IReportingProcess, 
	IProvideStatus, IPersistSettings

[<AbstractClassAttribute>]
type ReportingProcessBase = 
    class
        interface IReportingProcess
        interface IProvideStatus
        interface IPersistSettings
    end

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

Type.createClass(
	'GSF.TimeSeries.Reports.ReportingProcessBase',
	null,
	GSF.TimeSeries.Reports.IReportingProcess,
	GSF.IProvideStatus,
	GSF.Configuration.IPersistSettings);

View Source

The ReportingProcessBase type exposes the following members.

Constructors

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

Top

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.
	PersistSettings	Determines whether the object settings are to be persisted to the config file.
	ReportLocation	Gets or sets the directory to which reports will be written.
	ReportType	Gets report type, i.e., basically the report name associated with this reporting process.
	SettingsCategory	Gets or sets the category name under which the object settings are persisted in the config file.
	SmtpPassword	Gets or sets the password used to authenticate to the SMTP server.
	SmtpSecurePassword	Gets or sets the password used to authenticate to the SMTP server as a secure string.
	SmtpServer	Gets or sets SMTP server to use when e-mailing reports.
	SmtpUsername	Gets or sets the username used to authenticate to the SMTP server.
	Status	Gets the current status details about reporting process.
	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.

Top

Methods

	Name	Description
	CleanReportLocation	Deletes reports from the ReportLocation that have been idle for the length of the IdleReportLifetime.
	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.
	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.
	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.
	GetReportsList	Returns the list of reports that are available from the report location.
	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.
	LoadSettings	Loads saved settings from the config file.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	SaveSettings	Saves settings to the config file.
	SetArguments	Applies any received command line arguments for the reporting process.
	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