Class ProgressMonitor

An event container class specialized for flash update workers.

Inheritance

System.Object

ProgressMonitor

DevNullMonitor

Namespace: PTIRelianceLib

Assembly: PTIRelianceLib.dll

Syntax

public class ProgressMonitor : object, IProgressMonitor

Methods

ReportFailure(String, Object[])

Called when a worker class encounters an unrecoverable error. The details of the error will be packed into a formatted message.

Declaration

public virtual void ReportFailure(string format, params object[] args)

Parameters

Type	Name	Description
System.String	format	Format string
System.Object[]	args	Args to printf

ReportMessage(String, Object[])

Called for general worker messages that may indicate specific points in a process have been reached. Errors and warnings will not be sent through this method.

Declaration

public virtual void ReportMessage(string format, params object[] args)

Parameters

Type	Name	Description
System.String	format	Format string
System.Object[]	args	Args to printf

ReportProgress(Double)

Called when an iota of progress has been made. For instance, during flash updating there are a set number of packets to transmit so each successful packet transmission will call this method.

Declaration

public virtual void ReportProgress(double progress)

Parameters

Type	Name	Description
System.Double	progress	progress range is (0.0, 1.0)

Events

OnFlashMessage

Raised when a message is generated by the controller for the listener

Declaration

public event EventHandler<FlashEventMessageArgs> OnFlashMessage

Event Type

Type	Description
EventHandler<FlashEventMessageArgs>	Contains information about non-critical messages

OnFlashProgressUpdated

Raised when a unit of progress has been made. Called a cummulative total where units' sum equals 100.

Declaration

public event EventHandler<FlashProgressEventArgs> OnFlashProgressUpdated

Event Type

Type	Description
EventHandler<FlashProgressEventArgs>	Contains information about current flash update progress