The configuration used to control the behavior of report generating implementations. More...

Inheritance diagram for Apac.Configuration.ReportGeneratorConfig:

Public Member Functions
	ReportGeneratorConfig (string tempSpace, string publishLocation, bool doWeeklySummary, bool doWeekliesPerMeasurement, bool doMonthlySummary, bool doMonthliesPerMeasurement, bool aggregateSources, string dataStoreRef, string settingsStoreRef, string compilerRef, string name, string type, string description, bool prioritized)
	Creates a fully functional report generator configuration. More...

Public Member Functions inherited from Apac.Configuration.SupervisableConfig
	SupervisableConfig ()
	Initializes a new instance of the SupervisableConfig class. More...

	SupervisableConfig (string name, string configType, string type, string description, bool prioritized)
	Initializes a new instance of the SupervisableConfig class. More...

Public Member Functions inherited from Apac.Configuration.ConfigElement
	ConfigElement ()
	Initializes a new instance of the ConfigElement class. More...

	ConfigElement (string name, string description, bool enabled)
	Initializes a new instance of the ConfigElement class. More...

override int	GetHashCode ()
	Returns a hash code for this instance. More...

override bool	Equals (object compareTo)
	Determines whether the specified System.Object is equal to this instance. More...

System.Xml.Schema.XmlSchema	GetSchema ()
	This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the T:System.Xml.Serialization.XmlSchemaProviderAttribute to the class. More...

void	ReadXml (System.Xml.XmlReader reader)
	Generates an object from its XML representation. More...

void	WriteXml (System.Xml.XmlWriter writer)
	Converts an object into its XML representation. More...

Protected Member Functions
override void	OnWriteXml (System.Xml.XmlWriter writer)
	Called when serializing via XML. More...

override void	OnReadXml (System.Xml.XmlReader reader)
	Called when deserializing via XML. More...

Protected Member Functions inherited from Apac.Configuration.SupervisableConfig
override void	OnWriteXml (System.Xml.XmlWriter writer)
	Called when serializing via XML. More...

override void	OnReadXml (System.Xml.XmlReader reader)
	Called when deserializing via XML. More...

Properties
string	TempSpace `[get, set]`
	Gets or sets the disk location used for temporary file storage. More...

string	PublishLocation `[get, set]`
	Gets or sets the disk location used to serve the reports. More...

bool	DoWeeklySummary `[get, set]`
	Gets or sets the control for the generating weekly summary report. `true` indicates that weekly summary report will be generated or updated, `false` indicates that it will not be generated if it doesn't exist and not updated if it does exist. More...

bool	DoWeekliesPerMeasurement `[get, set]`
	Gets or sets the control for generating weekly measurement reports. `true` indicates that weekly measurement reports will be generated or updated, `false` indicates that they will not be generated if they don't exist and not updated if they do exist. More...

bool	DoMonthlySummary `[get, set]`
	Gets or sets the control for generating the monthly summary report. `true` indicates that monthly summary report will be generated or updated, `false` indicates that it will not be generated if it doesn't exist and not updated if it does exist. More...

bool	DoMonthliesPerMeasurement `[get, set]`
	Gets or sets the control for generating monthly measurement reports. `true` indicates that monthly measurement reports will be generated or updated, `false` indicates that they will not be generated if they don't exist and not updated if they do exist. More...

bool	AggregateSources `[get, set]`
	Gets or sets the control for automatically aggregating source circuits together in summary graphs. More...

string	DataStoreRef `[get, set]`
	Gets or sets the name of the configured data store component to use for retrieving the data needed to generate reports. More...

string	SettingsStoreRef `[get, set]`
	Gets or sets the name of the configured settings store component to use during operation. More...

string	CompilerRef `[get, set]`
	Gets or sets the name of the configured compiler component to use during operation. More...

Properties inherited from Apac.Configuration.SupervisableConfig
string	TypeName `[get, set]`
	Gets or sets the name of the type of the supervisable component. More...

string	TypeForConfig `[get, set]`
	Gets or sets the type for the SupervisableConfig. More...

bool	Prioritized `[get, set]`
	Gets or sets a value indicating whether the Apac.ISupervisable is prioritized. More...

ReferenceConfigCollection	References `[get]`
	Gets the references. More...

Properties inherited from Apac.Configuration.ConfigElement
virtual bool	IsValid `[get]`
	Gives a way for subclasses to determine validity. More...

string	Name `[get, set]`
	Gets or sets the name property setting. More...

string	Description `[get, set]`
	Gets or sets the description property setting. More...

bool	Enabled `[get, set]`
	Gets or sets a value indicating whether this ConfigElement is enabled. More...

log4net.ILog	Log `[get]`
	Provides a log4net.ILog instance for use by the whole class hierarchy. More...

Detailed Description

The configuration used to control the behavior of report generating implementations.

Constructor & Destructor Documentation

◆ ReportGeneratorConfig()

Apac.Configuration.ReportGeneratorConfig.ReportGeneratorConfig	(	string	tempSpace,
		string	publishLocation,
		bool	doWeeklySummary,
		bool	doWeekliesPerMeasurement,
		bool	doMonthlySummary,
		bool	doMonthliesPerMeasurement,
		bool	aggregateSources,
		string	dataStoreRef,
		string	settingsStoreRef,
		string	compilerRef,
		string	name,
		string	type,
		string	description,
		bool	prioritized
	)

inline

Creates a fully functional report generator configuration.

Parameters

tempSpace	The disk location used for temporary file storage.
publishLocation	The disk location used to serve the reports.
doWeeklySummary	`true` indicates that weekly summary report will be generated or updated, `false` indicates that it will not be generated if it doesn't exist and not updated if it does exist.
doWeekliesPerMeasurement	`true` indicates that weekly circuit reports will be generated or updated, `false` indicates that they will not be generated if they don't exist and not updated if they do exist.
doMonthlySummary	`true` indicates that monthly summary report will be generated or updated, `false` indicates that it will not be generated if it doesn't exist and not updated if it does exist.
doMonthliesPerMeasurement	`true` indicates that monthly circuit reports will be generated or updated, `false` indicates that they will not be generated if they don't exist and not updated if they do exist.
name	The name of the configured report generator.
type	The type of report generator to be used (AssemblyQualifiedName).
description	The description of this instance of the report generator.
prioritized	Indicates if the generator should run on a priority thread. While this option IS configurable, it is recommended that it always be `false` because generating reports is a true background process.

Member Function Documentation

◆ OnReadXml()

override void Apac.Configuration.ReportGeneratorConfig.OnReadXml ( System.Xml.XmlReader reader )

inlineprotectedvirtual

Called when deserializing via XML.

Parameters

reader The reader.

Reimplemented from Apac.Configuration.ConfigElement.

◆ OnWriteXml()

override void Apac.Configuration.ReportGeneratorConfig.OnWriteXml ( System.Xml.XmlWriter writer )

inlineprotectedvirtual

Called when serializing via XML.

Parameters

writer The writer.

Reimplemented from Apac.Configuration.ConfigElement.

Property Documentation

◆ AggregateSources

bool Apac.Configuration.ReportGeneratorConfig.AggregateSources

getset

Gets or sets the control for automatically aggregating source circuits together in summary graphs.

◆ CompilerRef

string Apac.Configuration.ReportGeneratorConfig.CompilerRef

getset

Gets or sets the name of the configured compiler component to use during operation.

◆ DataStoreRef

string Apac.Configuration.ReportGeneratorConfig.DataStoreRef

getset

Gets or sets the name of the configured data store component to use for retrieving the data needed to generate reports.

◆ DoMonthliesPerMeasurement

bool Apac.Configuration.ReportGeneratorConfig.DoMonthliesPerMeasurement

getset

Gets or sets the control for generating monthly measurement reports. true indicates that monthly measurement reports will be generated or updated, false indicates that they will not be generated if they don't exist and not updated if they do exist.

◆ DoMonthlySummary

bool Apac.Configuration.ReportGeneratorConfig.DoMonthlySummary

getset

Gets or sets the control for generating the monthly summary report. true indicates that monthly summary report will be generated or updated, false indicates that it will not be generated if it doesn't exist and not updated if it does exist.

◆ DoWeekliesPerMeasurement

bool Apac.Configuration.ReportGeneratorConfig.DoWeekliesPerMeasurement

getset

Gets or sets the control for generating weekly measurement reports. true indicates that weekly measurement reports will be generated or updated, false indicates that they will not be generated if they don't exist and not updated if they do exist.

◆ DoWeeklySummary

bool Apac.Configuration.ReportGeneratorConfig.DoWeeklySummary

getset

Gets or sets the control for the generating weekly summary report. true indicates that weekly summary report will be generated or updated, false indicates that it will not be generated if it doesn't exist and not updated if it does exist.

◆ PublishLocation

string Apac.Configuration.ReportGeneratorConfig.PublishLocation

getset

Gets or sets the disk location used to serve the reports.

◆ SettingsStoreRef

string Apac.Configuration.ReportGeneratorConfig.SettingsStoreRef

getset

Gets or sets the name of the configured settings store component to use during operation.

◆ TempSpace

string Apac.Configuration.ReportGeneratorConfig.TempSpace

getset

Gets or sets the disk location used for temporary file storage.

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

/var/lib/jenkins/workspace/apac/APAC/APACCore/Configuration/ReportGeneratorConfig.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ReportGeneratorConfig()

Member Function Documentation

◆ OnReadXml()

◆ OnWriteXml()

Property Documentation

◆ AggregateSources

◆ CompilerRef

◆ DataStoreRef

◆ DoMonthliesPerMeasurement

◆ DoMonthlySummary

◆ DoWeekliesPerMeasurement

◆ DoWeeklySummary

◆ PublishLocation

◆ SettingsStoreRef

◆ TempSpace