C# Class Smrf.NodeXL.Core.EdgeCollection

Represents a collection of edges.

This is a collection of objects that implement the IEdge interface. You can add edges to the collection, remove them, access an edge, and enumerate all edges.

Inheritance: NodeXLBase, IEdgeCollection

Show file Open project: 2014-sed-team3/term-project Class Usage Examples

Protected Properties

Property	Type	Description
m_iEdges	System.Int32
m_oLinkedList	LinkedList
m_oParentGraph	IGraph

Public Methods

Method	Description
Add ( IVertex vertex1, IVertex vertex2 ) : IEdge
Add ( IVertex vertex1, IVertex vertex2, System.Boolean isDirected ) : IEdge
Add ( IEdge edge ) : void
AssertValid ( ) : void
Clear ( ) : void
Contains ( IEdge edge ) : System.Boolean
Contains ( Int32 id ) : System.Boolean
Contains ( String name ) : System.Boolean
CopyTo ( IEdge array, Int32 index ) : void
EdgeCollection ( IGraph graph ) : System	Initializes a new instance of the EdgeCollection class.
Find ( Int32 id, IEdge &edge ) : System.Boolean
Find ( String name, IEdge &edge ) : System.Boolean
GetConnectingEdges ( IVertex vertex1, IVertex vertex2 ) : ICollection
GetEnumerator ( ) : IEnumerator
Remove ( IEdge edge ) : System.Boolean
Remove ( Int32 id ) : System.Boolean
Remove ( String name ) : System.Boolean
RemoveDuplicates ( ) : void
ToString ( ) : String

Protected Methods

Method	Description
AddToGroup ( IEdge oEdge, Vertex oVertex ) : void
CheckDirectednessBeforeAddingEdge ( System.Boolean bEdgeIsDirected, String sArgumentName ) : void
CheckVertex ( IVertex oVertex, String sMethodName, String sArgumentName ) : void
EdgeToVertices ( IEdge oEdge, String sMethodName, String sArgumentName, Vertex &oVertex1, Vertex &oVertex2 ) : void
Find ( System.Boolean bByID, Int32 iID, String sName, IEdge &oEdge ) : System.Boolean
GetDegree ( Vertex oVertex ) : Int32
GetIncomingOrOutgoingEdges ( Vertex oVertex, System.Boolean bIncludeIncoming, System.Boolean bIncludeOutgoing ) : ICollection
GetPredecessorOrSuccessorVertices ( Vertex oVertex, System.Boolean bIncludePredecessor, System.Boolean bIncludeSuccessor ) : ICollection
IVertexToVertex ( IVertex oVertex, String sMethodOrPropertyName ) : Vertex
OnEdgeAdded ( IEdge oEdge ) : void
OnEdgeRemoved ( IEdge oEdge, System.Boolean bFireEdgeRemoved ) : void
RemoveAllFromGroup ( Vertex oVertex ) : void
RemoveFromGroup ( IEdge oEdge, Vertex oVertex ) : System.Boolean

Private Methods

Method	Description
System ( ) : System.Collections.IEnumerator

Method Details

Add() public method

public Add ( IVertex vertex1, IVertex vertex2 ) : IEdge
vertex1	IVertex
vertex2	IVertex
return	IEdge

Add() public method

public Add ( IVertex vertex1, IVertex vertex2, System.Boolean isDirected ) : IEdge
vertex1	IVertex
vertex2	IVertex
isDirected	System.Boolean
return	IEdge

Add() public method

public Add ( IEdge edge ) : void
edge	IEdge
return	void

AddToGroup() protected method

protected AddToGroup ( IEdge oEdge, Vertex oVertex ) : void
oEdge	IEdge
oVertex	Vertex
return	void

AssertValid() public method

public AssertValid ( ) : void
return	void

CheckDirectednessBeforeAddingEdge() protected method

protected CheckDirectednessBeforeAddingEdge ( System.Boolean bEdgeIsDirected, String sArgumentName ) : void
bEdgeIsDirected	System.Boolean
sArgumentName	String
return	void

CheckVertex() protected method

protected CheckVertex ( IVertex oVertex, String sMethodName, String sArgumentName ) : void
oVertex	IVertex
sMethodName	String
sArgumentName	String
return	void

Clear() public method

public Clear ( ) : void
return	void

Contains() public method

public Contains ( IEdge edge ) : System.Boolean
edge	IEdge
return	System.Boolean

Contains() public method

public Contains ( Int32 id ) : System.Boolean
id	System.Int32
return	System.Boolean

Contains() public method

public Contains ( String name ) : System.Boolean
name	String
return	System.Boolean

CopyTo() public method

public CopyTo ( IEdge array, Int32 index ) : void
array	IEdge
index	System.Int32
return	void

EdgeCollection() public method

Initializes a new instance of the EdgeCollection class.

public EdgeCollection ( IGraph graph ) : System
graph	IGraph	/// to which the new collection belongs. Can't be /// null. ///
return	System

EdgeToVertices() protected method

protected EdgeToVertices ( IEdge oEdge, String sMethodName, String sArgumentName, Vertex &oVertex1, Vertex &oVertex2 ) : void
oEdge	IEdge
sMethodName	String
sArgumentName	String
oVertex1	Vertex
oVertex2	Vertex
return	void

Find() protected method

protected Find ( System.Boolean bByID, Int32 iID, String sName, IEdge &oEdge ) : System.Boolean
bByID	System.Boolean
iID	System.Int32
sName	String
oEdge	IEdge
return	System.Boolean

Find() public method

public Find ( Int32 id, IEdge &edge ) : System.Boolean
id	System.Int32
edge	IEdge
return	System.Boolean

Find() public method

public Find ( String name, IEdge &edge ) : System.Boolean
name	String
edge	IEdge
return	System.Boolean

GetConnectingEdges() public method

public GetConnectingEdges ( IVertex vertex1, IVertex vertex2 ) : ICollection
vertex1	IVertex
vertex2	IVertex
return	ICollection

GetDegree() protected method

protected GetDegree ( Vertex oVertex ) : Int32
oVertex	Vertex
return	System.Int32

GetEnumerator() public method

public GetEnumerator ( ) : IEnumerator
return	IEnumerator

GetIncomingOrOutgoingEdges() protected method

protected GetIncomingOrOutgoingEdges ( Vertex oVertex, System.Boolean bIncludeIncoming, System.Boolean bIncludeOutgoing ) : ICollection
oVertex	Vertex
bIncludeIncoming	System.Boolean
bIncludeOutgoing	System.Boolean
return	ICollection

GetPredecessorOrSuccessorVertices() protected method

protected GetPredecessorOrSuccessorVertices ( Vertex oVertex, System.Boolean bIncludePredecessor, System.Boolean bIncludeSuccessor ) : ICollection
oVertex	Vertex
bIncludePredecessor	System.Boolean
bIncludeSuccessor	System.Boolean
return	ICollection

IVertexToVertex() protected method

protected IVertexToVertex ( IVertex oVertex, String sMethodOrPropertyName ) : Vertex
oVertex	IVertex
sMethodOrPropertyName	String
return	Vertex

OnEdgeAdded() protected method

protected OnEdgeAdded ( IEdge oEdge ) : void
oEdge	IEdge
return	void

OnEdgeRemoved() protected method

protected OnEdgeRemoved ( IEdge oEdge, System.Boolean bFireEdgeRemoved ) : void
oEdge	IEdge
bFireEdgeRemoved	System.Boolean
return	void

Remove() public method

public Remove ( IEdge edge ) : System.Boolean
edge	IEdge
return	System.Boolean

Remove() public method

public Remove ( Int32 id ) : System.Boolean
id	System.Int32
return	System.Boolean

Remove() public method

public Remove ( String name ) : System.Boolean
name	String
return	System.Boolean

RemoveAllFromGroup() protected method

protected RemoveAllFromGroup ( Vertex oVertex ) : void
oVertex	Vertex
return	void

RemoveDuplicates() public method

public RemoveDuplicates ( ) : void
return	void

RemoveFromGroup() protected method

protected RemoveFromGroup ( IEdge oEdge, Vertex oVertex ) : System.Boolean
oEdge	IEdge
oVertex	Vertex
return	System.Boolean

ToString() public method

public ToString ( ) : String
return	String

Property Details

m_iEdges protected property

protected Int32,System m_iEdges
return	System.Int32

m_oLinkedList protected property

protected LinkedList m_oLinkedList
return	LinkedList

m_oParentGraph protected property

protected IGraph m_oParentGraph
return	IGraph