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
  VelocityGraph.Frontenac.BlueprintsDictionaryElement
    VelocityGraphElement
      VelocityGraphEdge

Namespace: VelocityGraph
Assembly: VelocityGraph (in VelocityGraph.dll) Version: 11.1.0.0 (11.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 DictionaryElementId.)
	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 DictionaryElementGetProperty(String).)
	GetProperty(PropertyType)	Gets the Value for the given Property id
	GetPropertyKeys	Return all the keys associated with the element. (Overrides DictionaryElementGetPropertyKeys.)
	Remove	Remove the edge from the graph. (Overrides DictionaryElementRemove.)
	RemoveProperty	Un-assigns a key/value property from the edge. The object value of the removed property is returned. (Overrides DictionaryElementRemoveProperty(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 DictionaryElementSetProperty(String, Object).)
	SetProperty(PropertyType, IComparable)	Sets the value for a property
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Top

Extension Methods

	Name	Description
	AreEqual	A standard method for determining if two elements are equal. This method should be used by any Element.equals() implementation to ensure consistent behavior. (Defined by ElementHelpers.)
	CopyProperties	Copy the properties (key and value) from one element to another. The properties are preserved on the from element. ElementPropertiesRule that share the same key on the to element are overwritten. (Defined by ElementHelpers.)
	EdgeString	(Defined by StringFactory.)
	GetProperties	Get a clone of the properties of the provided element. In other words, a HashMap is created and filled with the key/values of the element's properties. (Defined by ElementHelpers.)
	HaveEqualIds	Simply tests if the element ids are equal(). (Defined by ElementHelpers.)
	HaveEqualProperties	Determines whether two elements have the same properties. To be true, both must have the same property keys and respective values must be equals(). (Defined by ElementHelpers.)
	RelabelEdge	An edge is relabeled by creating a new edge with the same properties, but new label. Note that an edge is deleted and an edge is added. (Defined by EdgeHelpers.)
	SetProperties(IDictionaryString, Object)	Overloaded. Set the properties of the provided element using the provided dictionary. (Defined by ElementHelpers.)
	SetProperties(Object)	Overloaded. Set the properties of the provided element using the provided key value pairs. The var args of Objects must be divisible by 2. All odd elements in the array must be a string key. (Defined by ElementHelpers.)
	ValidateProperty	Determines whether the property key/value for the specified element can be legally set. This is typically used as a pre-condition check prior to setting a property. Throws ArgumentException whether the triple is legal and if not, a clear reason message is provided (Defined by ElementHelpers.)

Top

Reference

VelocityGraph Namespace