Interface IHighlightController<TVertex, TEdge, TGraph>

Represents an highlight controller. Able to set/remove highlight, check highlighting of entity.

Namespace: GraphShape.Algorithms.Highlight

Assembly: GraphShape.dll

Syntax

public interface IHighlightController<TVertex, TEdge, out TGraph>
    where TEdge : IEdge<TVertex> where TGraph : class, IBidirectionalGraph<TVertex, TEdge>

Type Parameters

Name	Description
TVertex	Vertex type.
TEdge	Edge type.
TGraph	Graph type.

Properties

| Improve this Doc View Source

Graph

Graph concerned by the highlighting.

Declaration

TGraph Graph { get; }

Property Value

Type	Description
TGraph

| Improve this Doc View Source

HighlightedEdges

Set of highlighted edges.

Declaration

IEnumerable<TEdge> HighlightedEdges { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TEdge>

| Improve this Doc View Source

HighlightedVertices

Set of highlighted vertices.

Declaration

IEnumerable<TVertex> HighlightedVertices { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TVertex>

| Improve this Doc View Source

SemiHighlightedEdges

Set of semi-highlighted edges.

Declaration

IEnumerable<TEdge> SemiHighlightedEdges { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TEdge>

| Improve this Doc View Source

SemiHighlightedVertices

Set of semi-highlighted vertices.

Declaration

IEnumerable<TVertex> SemiHighlightedVertices { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TVertex>

Methods

| Improve this Doc View Source

HighlightEdge(TEdge, Object)

Asks to highlight the given edge.

Declaration

void HighlightEdge(TEdge edge, object highlightInfo)

Parameters

Type	Name	Description
TEdge	edge	Edge to highlight.
System.Object	highlightInfo	Additional highlight information.

Exceptions

Type	Condition
System.ArgumentNullException	`edge` is null.

| Improve this Doc View Source

HighlightVertex(TVertex, Object)

Asks to highlight the given vertex.

Declaration

void HighlightVertex(TVertex vertex, object highlightInfo)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to highlight.
System.Object	highlightInfo	Additional highlight information.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.

| Improve this Doc View Source

IsHighlightedEdge(TEdge)

Checks if the given edge is highlighted.

Declaration

bool IsHighlightedEdge(TEdge edge)

Parameters

Type	Name	Description
TEdge	edge	Edge to check.

Returns

Type	Description
System.Boolean	True if the `edge` is highlighted, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`edge` is null.

| Improve this Doc View Source

IsHighlightedEdge(TEdge, out Object)

Checks if the given edge is highlighted. It semi-highlighted, provides additional highlightInfo.

Declaration

bool IsHighlightedEdge(TEdge edge, out object highlightInfo)

Parameters

Type	Name	Description
TEdge	edge	Edge to check.
System.Object	highlightInfo	Additional highlight information.

Returns

Type	Description
System.Boolean	True if the `edge` is highlighted, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`edge` is null.

| Improve this Doc View Source

IsHighlightedVertex(TVertex)

Checks if the given vertex is highlighted.

Declaration

bool IsHighlightedVertex(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to check.

Returns

Type	Description
System.Boolean	True if the `vertex` is highlighted, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.

| Improve this Doc View Source

IsHighlightedVertex(TVertex, out Object)

Checks if the given vertex is highlighted. It highlighted, provides additional highlightInfo.

Declaration

bool IsHighlightedVertex(TVertex vertex, out object highlightInfo)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to check.
System.Object	highlightInfo	Additional highlight information.

Returns

Type	Description
System.Boolean	True if the `vertex` is highlighted, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.

| Improve this Doc View Source

IsSemiHighlightedEdge(TEdge)

Checks if the given edge is semi-highlighted.

Declaration

bool IsSemiHighlightedEdge(TEdge edge)

Parameters

Type	Name	Description
TEdge	edge	Edge to check.

Returns

Type	Description
System.Boolean	True if the `edge` is semi-highlighted, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`edge` is null.

| Improve this Doc View Source

IsSemiHighlightedEdge(TEdge, out Object)

Checks if the given edge is semi-highlighted. It semi-highlighted, provides additional semiHighlightInfo.

Declaration

bool IsSemiHighlightedEdge(TEdge edge, out object semiHighlightInfo)

Parameters

Type	Name	Description
TEdge	edge	Edge to check.
System.Object	semiHighlightInfo	Additional semi-highlight information.

Returns

Type	Description
System.Boolean	True if the `edge` is semi-highlighted, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`edge` is null.

| Improve this Doc View Source

IsSemiHighlightedVertex(TVertex)

Checks if the given vertex is semi-highlighted.

Declaration

bool IsSemiHighlightedVertex(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to check.

Returns

Type	Description
System.Boolean	True if the `vertex` is semi-highlighted, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.

| Improve this Doc View Source

IsSemiHighlightedVertex(TVertex, out Object)

Checks if the given vertex is semi-highlighted. It semi-highlighted, provides additional semiHighlightInfo.

Declaration

bool IsSemiHighlightedVertex(TVertex vertex, out object semiHighlightInfo)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to check.
System.Object	semiHighlightInfo	Additional semi-highlight information.

Returns

Type	Description
System.Boolean	True if the `vertex` is semi-highlighted, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.

| Improve this Doc View Source

RemoveHighlightFromEdge(TEdge)

Removes the highlight of the given edge.

Declaration

void RemoveHighlightFromEdge(TEdge edge)

Parameters

Type	Name	Description
TEdge	edge	Edge from which removing highlight.

Exceptions

Type	Condition
System.ArgumentNullException	`edge` is null.

| Improve this Doc View Source

RemoveHighlightFromVertex(TVertex)

Removes the highlight of the given vertex.

Declaration

void RemoveHighlightFromVertex(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Vertex from which removing highlight.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.

| Improve this Doc View Source

RemoveSemiHighlightFromEdge(TEdge)

Removes the semi-highlight of the given edge.

Declaration

void RemoveSemiHighlightFromEdge(TEdge edge)

Parameters

Type	Name	Description
TEdge	edge	Edge from which removing highlight.

Exceptions

Type	Condition
System.ArgumentNullException	`edge` is null.

| Improve this Doc View Source

RemoveSemiHighlightFromVertex(TVertex)

Removes the semi-highlight of the given vertex.

Declaration

void RemoveSemiHighlightFromVertex(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Vertex from which removing semi-highlight.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.

| Improve this Doc View Source

SemiHighlightEdge(TEdge, Object)

Asks to semi-highlight the given edge.

Declaration

void SemiHighlightEdge(TEdge edge, object semiHighlightInfo)

Parameters

Type	Name	Description
TEdge	edge	Edge to semi-highlight.
System.Object	semiHighlightInfo	Additional semi-highlight information.

Exceptions

Type	Condition
System.ArgumentNullException	`edge` is null.

| Improve this Doc View Source

SemiHighlightVertex(TVertex, Object)

Asks to semi-highlight the given vertex.

Declaration

void SemiHighlightVertex(TVertex vertex, object semiHighlightInfo)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to highlight.
System.Object	semiHighlightInfo	Additional semi-highlight information.

Exceptions

Type	Condition
System.ArgumentNullException	`vertex` is null.

Extension Methods

GraphHelpers.GetDistances<TVertex, TEdge, TGraph>(TGraph)

GraphHelpers.GetDiameter<TVertex, TEdge, TGraph>(TGraph)

GraphHelpers.GetDiameter<TVertex, TEdge, TGraph>(TGraph, out Double[,])