Edge Class

An Edge links two vertices. Along with its key/value properties, an edge has both a directionality and a label. The directionality determines which vertex is the tail vertex (out vertex) and which vertex is the head vertex (in vertex). The edge label determines the type of relationship that exists between the two vertices. Diagrammatically, outVertex ---label---> inVertex.

Inheritance Hierarchy

SystemObject
  DictionaryElement
    VelocityGraphElement
      VelocityGraphEdge

Namespace: VelocityGraph
Assembly: VelocityGraph (in VelocityGraph.dll) Version: 8.2.1.0 (8.2.1)

Syntax

C++

Copy

public class Edge : Element, IEdge, IElement, 
	IDictionary<string, Object>, ICollection<KeyValuePair<string, Object>>, 
	IEnumerable<KeyValuePair<string, Object>>, IEnumerable, 
	IDictionary, ICollection, IEqualityComparer<Edge>

Public Class Edge
	Inherits Element
	Implements IEdge, IElement, IDictionary(Of String, Object), 
	ICollection(Of KeyValuePair(Of String, Object)), IEnumerable(Of KeyValuePair(Of String, Object)), 
	IEnumerable, IDictionary, ICollection, IEqualityComparer(Of Edge)

public ref class Edge : public Element, 
	IEdge, IElement, IDictionary<String^, Object^>, 
	ICollection<KeyValuePair<String^, Object^>>, IEnumerable<KeyValuePair<String^, Object^>>, 
	IEnumerable, IDictionary, ICollection, IEqualityComparer<Edge^>

type Edge =  
    class
        inherit Element
        interface IEdge
        interface IElement
        interface IDictionary<string, Object>
        interface ICollection<KeyValuePair<string, Object>>
        interface IEnumerable<KeyValuePair<string, Object>>
        interface IEnumerable
        interface IDictionary
        interface ICollection
        interface IEqualityComparer<Edge>
    end

The Edge type exposes the following members.

Properties

	Name	Description
	EdgeId	Gets the edge id
	EdgeType	Gets the edge type
	Head	Gets the head vertex
	Id	An identifier that is unique to its inheriting class. All vertices of a graph must have unique identifiers. All edges of a graph must have unique identifiers. (Overrides DictionaryElement.Id.)
	Tail	Gets the tail vertex

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Edge is equal to the current one. (Overrides ObjectEquals(Object).)
	Equals(Edge, Edge)	Determines whether the specified objects are equal.
	GetEdgePeer	Gets the other end for the given edge.
	GetHashCode	Use id as hash code (Overrides ElementGetHashCode.)
	GetHashCode(Edge)	Returns a hash code for the specified object.
	GetProperty(String)	Return the object value associated with the provided string key. If no value exists for that key, return null. (Overrides DictionaryElement.GetProperty(String).)
	GetProperty(PropertyType)	Gets the Value for the given Property id
	GetPropertyKeys	Return all the keys associated with the element. (Overrides DictionaryElement.GetPropertyKeys.)
	Remove	Remove the edge from the graph. (Overrides DictionaryElement.Remove.)
	RemoveProperty	Un-assigns a key/value property from the edge. The object value of the removed property is returned. (Overrides DictionaryElement.RemoveProperty(String).)
	SetProperty(String, Object)	Assign a key/value property to the edge. If a value already exists for this key, then the previous key/value is overwritten. (Overrides DictionaryElement.SetProperty(String, Object).)
	SetProperty(PropertyType, IComparable)	Sets the value for a property
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Top

Reference

VelocityGraph Namespace