C# Class Smrf.NodeXL.ExcelTemplate.GraphMetricCalculationManager

Calculates one or more sets of graph metrics and returns the results as an array of GraphMetricColumn objects.
Call to calculate the graph metrics. Call CancelAsync to stop the calculations. Handle the GraphMetricCalculationProgressChanged and events to monitor the progress and completion of the calculations.
Inheritance: Object
Mostrar archivo Open project: 2014-sed-team3/term-project Class Usage Examples

Protected Properties

Property Type Description
m_oBackgroundWorker System.ComponentModel.BackgroundWorker

Public Methods

Method Description
CalculateGraphMetricsAsync ( IGraph graph, Microsoft workbook ) : void
CalculateGraphMetricsAsync ( IGraph graph, Microsoft workbook, IGraphMetricCalculator2 graphMetricCalculators ) : void
CancelAsync ( ) : void
GraphMetricCalculationManager ( ) : System

Initializes a new instance of the class.

Protected Methods

Method Description
BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
BackgroundWorker_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
BackgroundWorker_RunWorkerCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
CalculateGraphMetricsAsyncInternal ( CalculateGraphMetricsAsyncArgs oCalculateGraphMetricsAsyncArgs, BackgroundWorker oBackgroundWorker, DoWorkEventArgs oDoWorkEventArgs ) : void
ReadWorkbook ( Microsoft oWorkbook, IGraphMetricCalculator2 oGraphMetricCalculators ) : IGraph

Private Methods

Method Description
AssertValid ( ) : void

Method Details

BackgroundWorker_DoWork() protected method

protected BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
sender object
e System.ComponentModel.DoWorkEventArgs
return void

BackgroundWorker_ProgressChanged() protected method

protected BackgroundWorker_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
sender object
e System.ComponentModel.ProgressChangedEventArgs
return void

BackgroundWorker_RunWorkerCompleted() protected method

protected BackgroundWorker_RunWorkerCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
sender object
e System.ComponentModel.RunWorkerCompletedEventArgs
return void

CalculateGraphMetricsAsync() public method

public CalculateGraphMetricsAsync ( IGraph graph, Microsoft workbook ) : void
graph IGraph
workbook Microsoft
return void

CalculateGraphMetricsAsync() public method

public CalculateGraphMetricsAsync ( IGraph graph, Microsoft workbook, IGraphMetricCalculator2 graphMetricCalculators ) : void
graph IGraph
workbook Microsoft
graphMetricCalculators IGraphMetricCalculator2
return void

CalculateGraphMetricsAsyncInternal() protected method

protected CalculateGraphMetricsAsyncInternal ( CalculateGraphMetricsAsyncArgs oCalculateGraphMetricsAsyncArgs, BackgroundWorker oBackgroundWorker, DoWorkEventArgs oDoWorkEventArgs ) : void
oCalculateGraphMetricsAsyncArgs CalculateGraphMetricsAsyncArgs
oBackgroundWorker System.ComponentModel.BackgroundWorker
oDoWorkEventArgs System.ComponentModel.DoWorkEventArgs
return void

CancelAsync() public method

public CancelAsync ( ) : void
return void

GraphMetricCalculationManager() public method

Initializes a new instance of the class.
public GraphMetricCalculationManager ( ) : System
return System

ReadWorkbook() protected method

protected ReadWorkbook ( Microsoft oWorkbook, IGraphMetricCalculator2 oGraphMetricCalculators ) : IGraph
oWorkbook Microsoft
oGraphMetricCalculators IGraphMetricCalculator2
return IGraph

Property Details

m_oBackgroundWorker protected_oe property

protected BackgroundWorker,System.ComponentModel m_oBackgroundWorker
return System.ComponentModel.BackgroundWorker