Class PolarisHelpers

A class of helper functions used in Polaris

Inheritance

System.Object

PolarisHelpers

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: Phoenix.Polaris

Assembly: Phoenix.Plugin.Polaris.dll

Syntax

public static class PolarisHelpers

Methods

ConnectionStatusExceptionParser(IRecommendationClientFactory, Exception, out Boolean)

Helper function for parsing exception messages related to connecting to a title. This should eventually be replaced with Polaris Exceptions (no longer have a need to parse).

Declaration

public static string ConnectionStatusExceptionParser(IRecommendationClientFactory factory, Exception ex, out bool disconnected)

Parameters

Type	Name	Description
IRecommendationClientFactory	factory	The factory associated with this exception.
System.Exception	ex	The exception to parse.
System.Boolean	disconnected	A bool indicating whether the exception means the connection is disconnected.

Returns

Type	Description
System.String	A string of the connection status if the exception if for failing to connect.

DataTablesAreEqual(DataTable, DataTable)

Checks if two data tables are equal.

Declaration

public static bool DataTablesAreEqual(DataTable tableA, DataTable tableB)

Parameters

Type	Name	Description
System.Data.DataTable	tableA	The first table.
System.Data.DataTable	tableB	The second table.

Returns

Type	Description
System.Boolean	Whether the tables are equal.

StringToRotation3(String, String)

Helper function to convert a string to a Rotation 3.

Declaration

public static Rotation3 StringToRotation3(string stringRotation, string ownerName = null)

Parameters

Type	Name	Description
System.String	stringRotation	The Rotation3 as a string.
System.String	ownerName	A name to help debug where string came from if conversion fails.

Returns

Type	Description
Rotation3	Returns the converted string as a Rotation3.

StringToVector3(String, String)

Helper function to convert a string to a vector.

Declaration

public static Vector3 StringToVector3(string stringVector, string ownerName = null)

Parameters

Type	Name	Description
System.String	stringVector	The Vector3 as a string.
System.String	ownerName	A name to help debug where string came from if conversion fails.

Returns

Type	Description
System.Numerics.Vector3	Return the converter string as a Vector3.

VisualizationInteractionTelemetry(VisualizationViewModel, String, String)

Helper function for creating a telemetry event for when there is an interaction with a visualization.

Declaration

public static void VisualizationInteractionTelemetry(VisualizationViewModel visual, string visInteraction, string visInteractionProperty)

Parameters

Type	Name	Description
VisualizationViewModel	visual	The visual being interacted with.
System.String	visInteraction	The name of the interaction/changing property name.
System.String	visInteractionProperty	The new value of the changed property.