C# Class Smrf.NodeXL.Algorithms.OneSnapGraphMetricCalculatorBase

Calculates one per-vertex graph metric using the SNAP graph library.
This is a base class for several classes that use the SNAP graph library to calculate one per-vertex graph metric in the enumeration. "Per-vertex" means that a metric is computed for each vertex in the graph, as opposed to "per-graph," for which there is a single metric value for the entire graph.

If a vertex is isolated, its metric value is zero.

Inheritance: OneDoubleGraphMetricCalculatorBase
Show file Open project: 2014-sed-team3/term-project

Protected Properties

Property Type Description
m_eSnapGraphMetric SnapGraphMetrics
m_sExpectedHeaderLineInOutputFile String
m_sGraphMetricDescription String

Public Methods

Method Description
AssertValid ( ) : void
TryCalculateGraphMetrics ( IGraph graph, BackgroundWorker backgroundWorker, Double>.Dictionary &graphMetrics ) : System.Boolean

Protected Methods

Method Description
OneSnapGraphMetricCalculatorBase ( SnapGraphMetrics snapGraphMetric, String graphMetricDescription, String expectedHeaderLineInOutputFile ) : System

Initializes a new instance of the class.

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

OneSnapGraphMetricCalculatorBase() protected method

Initializes a new instance of the class.
protected OneSnapGraphMetricCalculatorBase ( SnapGraphMetrics snapGraphMetric, String graphMetricDescription, String expectedHeaderLineInOutputFile ) : System
snapGraphMetric SnapGraphMetrics /// The graph metric to calculate. Must be just one value in the enumeration. ///
graphMetricDescription String /// A description suitable for use within the sentence "Calculating /// [GraphMetricDescription]." ///
expectedHeaderLineInOutputFile String /// The expected header line in the output file created by SNAP. This is /// used for diagnostic purposes. ///
return System

TryCalculateGraphMetrics() public method

public TryCalculateGraphMetrics ( IGraph graph, BackgroundWorker backgroundWorker, Double>.Dictionary &graphMetrics ) : System.Boolean
graph IGraph
backgroundWorker System.ComponentModel.BackgroundWorker
graphMetrics Double>.Dictionary
return System.Boolean

Property Details

m_eSnapGraphMetric protected property

protected SnapGraphMetrics m_eSnapGraphMetric
return SnapGraphMetrics

m_sExpectedHeaderLineInOutputFile protected property

protected String m_sExpectedHeaderLineInOutputFile
return String

m_sGraphMetricDescription protected property

protected String m_sGraphMetricDescription
return String