C# Class Smrf.NodeXL.ExcelTemplate.GraphMetricsAggregator

Aggregates the overall metrics from a folder full of NodeXL workbooks into a new Excel workbook.
Call AggregateGraphMetricsAsync to aggregate the overall metrics. Call CancelAsync to stop the aggregation. Handle the AggregationProgressChanged and events to monitor the progress and completion of the aggregation.
Inheritance: Object
ファイルを表示 Open project: 2014-sed-team3/term-project Class Usage Examples

Protected Properties

Property Type Description
m_oBackgroundWorker System.ComponentModel.BackgroundWorker

Public Methods

Method Description
AggregateGraphMetricsAsync ( String sourceFolderPath, Microsoft workbook ) : void
CancelAsync ( ) : void
GraphMetricsAggregator ( ) : System

Initializes a new instance of the GraphMetricsAggregator class.

Protected Methods

Method Description
AggregateGraphMetricsInternal ( AggregateGraphMetricsAsyncArgs oAggregateGraphMetricsAsyncArgs, BackgroundWorker oBackgroundWorker, DoWorkEventArgs oDoWorkEventArgs ) : void
BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
BackgroundWorker_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
BackgroundWorker_RunWorkerCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
GetWorkbookSettings ( Microsoft oWorkbook ) : String
TryGetGraphMetricsForOneNodeXLWorkbook ( String sNodeXLWorkbookFilePath, OverallMetricsInfo &oOverallMetricsInfo ) : System.Boolean
WriteOverallMetricsToNewWorkbook ( Microsoft oApplicationForNewWorkbook, IList oOverallMetricsInfos ) : void

Private Methods

Method Description
AssertValid ( ) : void

Method Details

AggregateGraphMetricsAsync() public method

public AggregateGraphMetricsAsync ( String sourceFolderPath, Microsoft workbook ) : void
sourceFolderPath String
workbook Microsoft
return void

AggregateGraphMetricsInternal() protected method

protected AggregateGraphMetricsInternal ( AggregateGraphMetricsAsyncArgs oAggregateGraphMetricsAsyncArgs, BackgroundWorker oBackgroundWorker, DoWorkEventArgs oDoWorkEventArgs ) : void
oAggregateGraphMetricsAsyncArgs AggregateGraphMetricsAsyncArgs
oBackgroundWorker System.ComponentModel.BackgroundWorker
oDoWorkEventArgs System.ComponentModel.DoWorkEventArgs
return void

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

CancelAsync() public method

public CancelAsync ( ) : void
return void

GetWorkbookSettings() protected method

protected GetWorkbookSettings ( Microsoft oWorkbook ) : String
oWorkbook Microsoft
return String

GraphMetricsAggregator() public method

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

TryGetGraphMetricsForOneNodeXLWorkbook() protected method

protected TryGetGraphMetricsForOneNodeXLWorkbook ( String sNodeXLWorkbookFilePath, OverallMetricsInfo &oOverallMetricsInfo ) : System.Boolean
sNodeXLWorkbookFilePath String
oOverallMetricsInfo OverallMetricsInfo
return System.Boolean

WriteOverallMetricsToNewWorkbook() protected method

protected WriteOverallMetricsToNewWorkbook ( Microsoft oApplicationForNewWorkbook, IList oOverallMetricsInfos ) : void
oApplicationForNewWorkbook Microsoft
oOverallMetricsInfos IList
return void

Property Details

m_oBackgroundWorker protected_oe property

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