Class LayoutState<TVertex, TEdge>

Layout iteration status.

Inheritance
System.Object
LayoutState<TVertex, TEdge>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: GraphShape.Algorithms.Layout
Assembly: GraphShape.dll
Syntax
public class LayoutState<TVertex, TEdge>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.

Constructors

| Improve this Doc View Source

LayoutState(IDictionary<TVertex, Point>, IDictionary<TVertex, Point>, IDictionary<TEdge, Point[]>, TimeSpan, Int32, String)

Initializes a new instance of the LayoutState<TVertex, TEdge> class.

Declaration
public LayoutState(IDictionary<TVertex, Point> positions, IDictionary<TVertex, Point> overlapRemovedPositions, IDictionary<TEdge, Point[]> routeInfos, TimeSpan computationTime, int iteration, string message)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<TVertex, Point> positions

Vertices positions.
System.Collections.Generic.IDictionary<TVertex, Point> overlapRemovedPositions

Vertices position after overlap removal.
System.Collections.Generic.IDictionary<TEdge, Point[]> routeInfos

Edge routes information.
System.TimeSpan computationTime

Iteration computation time.
System.Int32 iteration

Iteration number.
System.String message

Iteration message.
Exceptions
Type Condition
System.ArgumentNullException

positions is null.
System.ArgumentNullException

message is null.
System.ArgumentOutOfRangeException

iteration is negative.

Properties

| Improve this Doc View Source

ComputationTime

Gets how much time did it take to compute the position of the vertices (till the end of this iteration).

Declaration
public TimeSpan ComputationTime { get; protected set; }
Property Value
Type Description
System.TimeSpan
| Improve this Doc View Source

Iteration

Gets the index of the iteration.

Declaration
public int Iteration { get; protected set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Message

Gets the status message of this layout state.

Declaration
public string Message { get; protected set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

OverlapRemovedPositions

Gets the positions of every vertex after overlap removal in this state of the layout process.

Declaration
public IDictionary<TVertex, Point> OverlapRemovedPositions { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<TVertex, Point>
| Improve this Doc View Source

Positions

Gets the positions of every vertex in this state of the layout process.

Declaration
public IDictionary<TVertex, Point> Positions { get; protected set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<TVertex, Point>
| Improve this Doc View Source

RouteInfos

Gets the edge routes in this state of the layout process.

Declaration
public IDictionary<TEdge, Point[]> RouteInfos { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<TEdge, Point[]>

Extension Methods