C# Class Smrf.NodeXL.Core.Edge

Represents an edge.

An edge is a connection between two vertices in the same graph. An edge can be directed or undirected. A directed edge has a front and a back.

An edge always connects two vertices. Although an edge can be created before it is added to a graph, it can't be created without specifying the vertices it connects. An edge can be added only to the graph that contains the edge's vertices.

An Edge can be created via its constructor and then added to a graph via Graph.Edges.EdgeCollection.Add(IEdge), or created and added to a graph at the same time via Graph.Edges..

An edge is immutable, meaning that its vertices can't be removed. An edge can be removed from a graph and disposed of, but once the edge is removed, the edge is unusable. Attempting to access the edge's properties or methods will lead to unpredictable results.

Inheritance: GraphVertexEdgeBase, IEdge

Afficher le fichier Open project: 2014-sed-team3/term-project Class Usage Examples

Protected Properties

Свойство	Type	Description
m_bIsDirected	System.Boolean
m_oVertex1	IVertex
m_oVertex2	IVertex

Private Properties

Свойство	Type	Description
Edge	System

Méthodes publiques

Méthode	Description
AssertValid ( ) : void
Clone ( System.Boolean copyMetadataValues, System.Boolean copyTag ) : IEdge
Clone ( System.Boolean copyMetadataValues, System.Boolean copyTag, IVertex vertex1, IVertex vertex2, System.Boolean isDirected ) : IEdge
Edge ( IVertex vertex1, IVertex vertex2, System.Boolean isDirected ) : System	Initializes a new instance of the Edge class.
GetAdjacentVertex ( IVertex vertex ) : IVertex
IsAntiparallelTo ( IEdge otherEdge ) : System.Boolean
IsParallelTo ( IEdge otherEdge ) : System.Boolean

Méthodes protégées

Méthode	Description
CheckVertexArgument ( IVertex oVertex, String sArgumentName ) : void
EdgeToVertices ( IEdge oEdge, String sClassName, String sMethodOrPropertyName, Vertex &oVertex1, Vertex &oVertex2 ) : void
IEdgeToEdge ( IEdge oEdge, String sClassName, String sMethodOrPropertyName ) : Edge

Private Methods

Méthode	Description
Edge ( ) : System

Method Details

AssertValid() public méthode

public AssertValid ( ) : void
Résultat	void

CheckVertexArgument() protected méthode

protected CheckVertexArgument ( IVertex oVertex, String sArgumentName ) : void
oVertex	IVertex
sArgumentName	String
Résultat	void

Clone() public méthode

public Clone ( System.Boolean copyMetadataValues, System.Boolean copyTag ) : IEdge
copyMetadataValues	System.Boolean
copyTag	System.Boolean
Résultat	IEdge

Clone() public méthode

public Clone ( System.Boolean copyMetadataValues, System.Boolean copyTag, IVertex vertex1, IVertex vertex2, System.Boolean isDirected ) : IEdge
copyMetadataValues	System.Boolean
copyTag	System.Boolean
vertex1	IVertex
vertex2	IVertex
isDirected	System.Boolean
Résultat	IEdge

Edge() public méthode

Initializes a new instance of the Edge class.

public Edge ( IVertex vertex1, IVertex vertex2, System.Boolean isDirected ) : System
vertex1	IVertex	/// The edge's first vertex. The vertex must have already been added to /// the graph to which the new edge will be added. ///
vertex2	IVertex	/// The edge's second vertex. The vertex must have already been added to /// the graph to which the new edge will be added. ///
isDirected	System.Boolean	/// If true, is the edge's back vertex and /// is the edge's front vertex. If false, the /// edge is undirected. ///
Résultat	System

EdgeToVertices() protected static méthode

protected static EdgeToVertices ( IEdge oEdge, String sClassName, String sMethodOrPropertyName, Vertex &oVertex1, Vertex &oVertex2 ) : void
oEdge	IEdge
sClassName	String
sMethodOrPropertyName	String
oVertex1	Vertex
oVertex2	Vertex
Résultat	void

GetAdjacentVertex() public méthode

public GetAdjacentVertex ( IVertex vertex ) : IVertex
vertex	IVertex
Résultat	IVertex

IEdgeToEdge() protected static méthode

protected static IEdgeToEdge ( IEdge oEdge, String sClassName, String sMethodOrPropertyName ) : Edge
oEdge	IEdge
sClassName	String
sMethodOrPropertyName	String
Résultat	Edge

IsAntiparallelTo() public méthode

public IsAntiparallelTo ( IEdge otherEdge ) : System.Boolean
otherEdge	IEdge
Résultat	System.Boolean

IsParallelTo() public méthode

public IsParallelTo ( IEdge otherEdge ) : System.Boolean
otherEdge	IEdge
Résultat	System.Boolean

Property Details

m_bIsDirected protected_oe property

protected Boolean,System m_bIsDirected
Résultat	System.Boolean

m_oVertex1 protected_oe property

protected IVertex m_oVertex1
Résultat	IVertex

m_oVertex2 protected_oe property

protected IVertex m_oVertex2
Résultat	IVertex