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

Namespace: VelocityGraph
Assembly: VelocityGraph (in VelocityGraph.dll) Version: 11.1.0.0 (11.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 DictionaryElementId.)
	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 DictionaryElementGetProperty(String).)
	GetProperty(PropertyType)	Gets the Value for the given Property id
	GetPropertyKeys	Return all the keys associated with the vertex. (Overrides DictionaryElementGetPropertyKeys.)
	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 DictionaryElementRemove.)
	RemoveProperty	Un-assigns a key/value property from the vertex. The object value of the removed property is returned. (Overrides DictionaryElementRemoveProperty(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 DictionaryElementSetProperty(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

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.)
	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.)
	HaveEqualEdges	Test whether the two vertices have equal edge sets (Defined by VertexHelpers.)
	HaveEqualIds	Simply tests if the element ids are equal(). (Defined by ElementHelpers.)
	HaveEqualNeighborhood	Test whether the two vertices have equal properties and edge sets. (Defined by VertexHelpers.)
	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.)
	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.)
	VertexString	(Defined by StringFactory.)

Top

Reference

VelocityGraph Namespace