Apac.Ecop.Reporting.JsonMeasurementReportingEngine Class Reference

An engine that outputs and updates report information about measurement definitions in JSON format. This results in ah historical data set being generated over time that comprises a long-term view of the measurements defined in and tracked by the system. This JSON data can then be consumed by the a user interface component to provide analytics and visualization. More...

Inheritance diagram for Apac.Ecop.Reporting.JsonMeasurementReportingEngine:

Protected Member Functions
override void	OnInitialize (Configuration.SupervisableConfig config)
override void	OnAppendToWeeklyReports (DateTime date)
	Signals that weekly reports need to be updated. More...
override void	OnAppendToMonthlyReports (DateTime date)
	Signals that monthly reports need to be updated. More...
override void	OnGenerateWeeklyReports (DateTime date)
	Signals a complete re/generate of the weekly reports for the month containing the given date. More...
override void	OnGenerateMonthlyReports (DateTime date)
	Signals a complete re/generate of the monthly reports for the month containing the given date. More...
Protected Member Functions inherited from Apac.Reporting.ThreadedReportingEngine
override void	OnInitialize (Apac.Configuration.SupervisableConfig config)
	Called when the supervisable component is intitialized. More...
override void	OnResolveReferences ()
	Called when the supervisable component needs to resolve its runtime references to other components. More...
override void	OnCheckReferencesStates ()
	Called when the supervisable component needs to check the state of its runtime reference components. More...
override void	OnStart ()
	Called to start the supervisable component. More...
override void	OnStop ()
	Called to stop the supervisable component. More...
virtual void	Dispose (bool disposing)
Protected Member Functions inherited from Apac.Supervisable
abstract void	OnInitialize (Apac.Configuration.SupervisableConfig config)
	Called when the supervisable component is intitialized. More...
virtual void	OnStarting ()
	Called when the supervisable component is about to start. This differs from handling OnStart in that this method is called on the supervisor's thread, whereas Start is called on a new thread. Subclasses may override this to do work that is considered initialization work that should be done before all component threads are started. More...
virtual void	OnStateChanging (SupervisableState currentState, SupervisableState newState)
	Call chain for state changing notification. More...
virtual void	OnStateChanged (SupervisableState previousState, SupervisableState newState)
	Call chain for state changed notification. More...
virtual void	OnException (Exception ex)
	Call chain for exception notification. More...
void	SetState (SupervisableState newState)
	Changes the state of the controller to the new state. More...
virtual void	OnStateChangeStarting ()
virtual void	OnStateChangeRunning ()
virtual void	OnStateChangeStopping ()
virtual void	OnStateChangeStopped ()
virtual void	OnStateChangeInitializing ()
virtual void	OnStateChangeInitialized ()
virtual void	OnStateChangeErrored ()
virtual void	OnStateChangeImpaired ()
void	HandleException (string message, Exception e)
	Deals with the details of handling exceptions captured by the controller. More...
void	ResetException ()
	Allows subclasses to reset the last exception to an empty state. More...
void	HandleImpairment (string message, Exception e)
	Deals with the details of handling non-critical problems captured by the controller. More...

Additional Inherited Members
Public Member Functions inherited from Apac.Reporting.ThreadedReportingEngine
	ThreadedReportingEngine ()
	Initializes a new instance of the ThreadedReportingEngine<ValueType> class. More...
	ThreadedReportingEngine (IMeasurementStore dataStore, ISettingsStore settingStore, IDataCompiler compiler)
	Initializes a new instance of the ThreadedReportingEngine<ValueType> class. More...
void	GenerateWeeklyReports (DateTime date)
	Should completely re/generate the weekly reports for the week containing the given date. More...
void	GenerateMonthlyReports (DateTime date)
	Should completely re/generate the monthly reports for the month containing the given date. More...
void	AppendToWeeklyReports (DateTime date)
	Should append data for the given date to the weekly report. More...
void	AppendToMonthlyReports (DateTime date)
	Should append data for the given date to the monthly report. More...
void	Dispose ()
Public Member Functions inherited from Apac.Supervisable
void	Initialize (Apac.Configuration.SupervisableConfig config, Supervisors.ISupervisor supervisor)
	Initializes the controller from configuration. More...
void	ResolveReferences ()
	Resolves any references this component might hold to other supervisable components. More...
void	CheckReferencesStates ()
	Checks the states of referenced components to be sure they are satisfactory for this component's operation. More...
void	Starting ()
	Signals that the component will be starting on its own thread. This implementation uses this opportunity to CheckReferencesStates, change state to Starting, and signal subclasses with OnStarting. More...
void	Start ()
	Starts the component. More...
void	Stop ()
	Stops the component. More...
Public Member Functions inherited from Apac.ISupervisable
void	Initialize (Apac.Configuration.SupervisableConfig config, Supervisors.ISupervisor exec)
	Initializes the component with the given SupervisableConfig (or derivative) and ISupervisor. More...
Protected Attributes inherited from Apac.Reporting.ThreadedReportingEngine
volatile Configuration.ReportGeneratorConfig	_config = null
Properties inherited from Apac.Reporting.ThreadedReportingEngine
IMeasurementStore	Store [get]
	Provide subclasses with access to the store. More...
ISettingsStore	SettingStore [get]
	Provide subclasses with access to the settings. More...
Properties inherited from Apac.Supervisable
string	Name [get]
	Gets the name of the controller, as specified by configuration. Note that if the name is not specified, then an index will be used. More...
string	Description [get]
	Gets the description of the controller, as specified by configuration. More...
bool	Prioritized [get]
	Indicates if the supervisable component should be executed on a higher thread priority. More...
DateTime	LastHeartbeat [get]
	The time of the last heartbeat. More...
Supervisors.ISupervisor	ExecutiveSupervisor [get]
	Walks the tree to find the top level supervisor. More...
bool	IsRunning [get]
	Gets a value indicating whether this instance is running. More...
SupervisableState	CurrentState [get]
	Gets the current overall state of the controller. More...
SupervisableState	PreviousState [get]
	Gets the previous overall state of the controller. More...
Exception	LastException [get]
	Gets the last exception encountered within the controller. More...
DateTime	StartTime [get]
	Gets the time this supervisable component was started. More...
DateTime	StopTime [get]
	Gets the time this supervisable component was stopped. More...
TimeSpan	UpTime [get]
	Gets the amount of time this supervisable component has been running, or did run before it was stopped (if IsRunning is false). More...
Supervisors.ISupervisor	Supervisor [get]
	Gets the supervisor. More...
SupervisableConfig	Config [get]
	The configuration object used by the supervisable component. More...
log4net.ILog	Log [get]
	Lazy-initialized logger for subclass usage. More...
Properties inherited from Apac.ISupervisable
string	Name [get]
	The name of the component, for unique identification purposes. More...
string	Description [get]
	The description of the component, for human consumption. More...
bool	Prioritized [get]
	Indicates if the component should be high priority. More...
Supervisors.ISupervisor	ExecutiveSupervisor [get]
	Walks the tree to find the top level supervisor. More...
bool	IsRunning [get]
	Indicates that the component is running. More...
DateTime	LastHeartbeat [get]
DateTime	StartTime [get]
	Gets the time this supervisable component was started. More...
DateTime	StopTime [get]
	Gets the time this supervisable component was stopped. More...
TimeSpan	UpTime [get]
	Gets the amount of time this supervisable component has been running, or did run before it was stopped (if IsRunning is false). More...
SupervisableState	CurrentState [get]
	Gets the current SupervisableState of this component. More...
SupervisableState	PreviousState [get]
	Gets the previous SupervisableState of this component. More...
Exception	LastException [get]
	Gets the last exception to have occurred and been trapped by this component. More...
Events inherited from Apac.Supervisable
SupervisableStateChangingHandler	SupervisableStateChanging
	Notifies listeners that the state is about to change. More...
SupervisableStateChangedHandler	SupervisableStateChanged
	Notifies listeners that the state has changed. More...
SupervisableErroredHandler	SupervisableErrored
	Notifies listeners that an error occured within the controller. More...
SupervisableHeartbeatHandler	SupervisableHeartbeat
	Notifies listeners that the component is still active. More...
Events inherited from Apac.ISupervisable
SupervisableStateChangingHandler	SupervisableStateChanging
	Notifies listeners that the state is about to change. More...
SupervisableStateChangedHandler	SupervisableStateChanged
	Notifies listeners that the state has changed. More...
SupervisableErroredHandler	SupervisableErrored
	Notifies listeners that an error occured within the controller. More...
SupervisableHeartbeatHandler	SupervisableHeartbeat
	Notifies listeners that the component is still active. More...

Detailed Description

An engine that outputs and updates report information about measurement definitions in JSON format. This results in ah historical data set being generated over time that comprises a long-term view of the measurements defined in and tracked by the system. This JSON data can then be consumed by the a user interface component to provide analytics and visualization.

This report generator should be much easier to create and maintain than the old XML circuit report generator that created static images because we don't have to continually reload the existing data and properly reorganize it for graphics generation.

Member Function Documentation

OnAppendToMonthlyReports()

override void Apac.Ecop.Reporting.JsonMeasurementReportingEngine.OnAppendToMonthlyReports ( DateTime  date )

inlineprotectedvirtual

Signals that monthly reports need to be updated.

Parameters

date	The date for which the report is to be generated.

Implements Apac.Reporting.ThreadedReportingEngine.

OnAppendToWeeklyReports()

override void Apac.Ecop.Reporting.JsonMeasurementReportingEngine.OnAppendToWeeklyReports ( DateTime  date )

inlineprotectedvirtual

Signals that weekly reports need to be updated.

Parameters

date	The date for which the report is to be generated.

Implements Apac.Reporting.ThreadedReportingEngine.

OnGenerateMonthlyReports()

override void Apac.Ecop.Reporting.JsonMeasurementReportingEngine.OnGenerateMonthlyReports ( DateTime  date )

inlineprotectedvirtual

Signals a complete re/generate of the monthly reports for the month containing the given date.

Parameters

date	The date for which the report should be re/generated.

Implements Apac.Reporting.ThreadedReportingEngine.

OnGenerateWeeklyReports()

override void Apac.Ecop.Reporting.JsonMeasurementReportingEngine.OnGenerateWeeklyReports ( DateTime  date )

inlineprotectedvirtual

Signals a complete re/generate of the weekly reports for the month containing the given date.

Parameters

date	The date for which the report should be re/generated.

Implements Apac.Reporting.ThreadedReportingEngine.

---

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

• /var/lib/jenkins/workspace/apac/APAC/Ecop/Reporting/JsonMeasurementReportingEngine.cs