IVertex Interface

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--->.

Namespace: Frontenac.Blueprints
Assembly: VelocityGraph (in VelocityGraph.dll) Version: 10.1.0.0 (10.1)

Syntax

C++

Copy

public interface IVertex : IElement, 
	IDictionary<string, Object>, ICollection<KeyValuePair<string, Object>>, 
	IEnumerable<KeyValuePair<string, Object>>, IEnumerable, 
	IDictionary, ICollection

Public Interface IVertex
	Inherits IElement, IDictionary(Of String, Object), 
	ICollection(Of KeyValuePair(Of String, Object)), IEnumerable(Of KeyValuePair(Of String, Object)), 
	IEnumerable, IDictionary, ICollection

public interface class IVertex : IElement, 
	IDictionary<String^, Object^>, ICollection<KeyValuePair<String^, Object^>>, 
	IEnumerable<KeyValuePair<String^, Object^>>, IEnumerable, 
	IDictionary, ICollection

type IVertex =  
    interface
        interface IElement
        interface IDictionary<string, Object>
        interface ICollection<KeyValuePair<string, Object>>
        interface IEnumerable<KeyValuePair<string, Object>>
        interface IEnumerable
        interface IDictionary
        interface ICollection
    end

The IVertex type exposes the following members.

Methods

	Name	Description
	AddEdge	Add a new outgoing edge from this vertex to the parameter vertex with provided edge label.
	GetEdges	Return the edges incident to the vertex according to the provided direction and edge labels.
	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	Generate a query object that can be used to fine tune which edges/vertices are retrieved that are incident/adjacent to this vertex.

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

Frontenac.Blueprints Namespace