Vertex Class

A vertex maintains pointers to both a set of incoming and outgoing edges. The outgoing edges are those edges for which the vertex is the tail. The incoming edges are those edges for which the vertex is the head. Diagrammatically, ---inEdges---> vertex ---outEdges--->

Inheritance Hierarchy

SystemObject
  DictionaryElement
    VelocityGraphElement
      VelocityGraphVertex

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

Syntax

C++

Copy

public class Vertex : Element, IVertex, 
	IElement, IDictionary<string, Object>, ICollection<KeyValuePair<string, Object>>, 
	IEnumerable<KeyValuePair<string, Object>>, IEnumerable, 
	IDictionary, ICollection, IEqualityComparer<Vertex>

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

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

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

The Vertex type exposes the following members.

Constructors

	Name	Description
	Vertex	Normally you should use GetVertex(Int32, Boolean, Boolean) but if you need a reference to a Vertex that has no yet been created, this constructor may be used (but know what you are doing!)

Top

Properties

	Name	Description
	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.)
	VertexId	Gets the unique id of a vertex
	VertexType	Gets the vertex type of this Vertex

Top

Methods

	Name	Description
	AddEdge(String, IVertex)	Add an edge from this Vertex to inVertex of edge type looked up from label, if edge type does not yet exist it is created.
	AddEdge(EdgeType, Vertex)	Add an edge from this Vertex to inVertex of edge type.
	AddEdge(Object, String, IVertex)	Add an edge from this Vertex to inVertex of edge type looked up from label, if edge type does not yet exist it is created.
	Equals(Object)	Determines whether the specified Vertex is equal to the current one. (Overrides ObjectEquals(Object).)
	Equals(Vertex, Vertex)	Determines whether the specified objects are equal.
	GetEdges(Direction, String)	Return the edges incident to the vertex according to the provided direction and edge labels.
	GetEdges(EdgeType, Direction)	Selects all edges from or to this vertex and for the given edge type.
	GetHashCode	Use id as hash code (Overrides ElementGetHashCode.)
	GetHashCode(Vertex)	Returns a hash code for the specified object.
	GetNumberOfEdges(EdgeType, Direction)	Gets the number of edges from or to this vertex and for the given edge type.
	GetNumberOfEdges(EdgeType, Vertex, Direction)	Gets the number of edges from or to this vertex for the given edge type and the given other Vertex.
	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 vertex. (Overrides DictionaryElement.GetPropertyKeys.)
	GetVertices	Return the vertices adjacent to the vertex according to the provided direction and edge labels. This method does not remove duplicate vertices (i.e. those vertices that are connected by more than one edge).
	Query	Uses DefaultVertexQuery
	RelatedVertices
	Remove	Removes this Vertex from the Graph (Overrides DictionaryElement.Remove.)
	RemoveProperty	Un-assigns a key/value property from the vertex. The object value of the removed property is returned. (Overrides DictionaryElement.RemoveProperty(String).)
	SetProperty(String, Object)	Assign a key/value property to the vertex. If a value already exists for this key, then the previous key/value is overwritten. (Overrides DictionaryElement.SetProperty(String, Object).)
	SetProperty(PropertyType, IComparable)	Assign a key/value property to the vertex. If a value already exists for this key, then the previous key/value is overwritten.
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	Traverse(Direction, ISetEdgeType)	Selects all neighbor Vertices from or to this vertex and for the given edge types.
	Traverse(EdgeType, Direction)	Selects all neighbor Vertices from or to this vertex and for the given edge type.
	Traverse(Int32, Boolean, Direction, Vertex, ISetEdgeType, ISetVertexType, ISetVertexType, ISetVertex, ISetVertex, ISetEdge, ISetEdge, ISetPropertyType, ISetPropertyType, ISetPropertyType, ISetPropertyType, FuncVertex, Boolean, FuncEdge, Boolean, FuncListEdge, Boolean)	Traverses graph from this Vertex to a target Vertex using Breadth-first search like in Dijkstra's algorithm

Top

Reference

VelocityGraph Namespace