Class Helpers

Namespace

BlueM.Wave

Assembly

Wave.dll

[StandardModule]
public sealed class Helpers

Inheritance

object

Helpers

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

CurrentDateFormat

Returns the current date time format as set by the operating system

public static string CurrentDateFormat { get; }

Property Value

string

CurrentListSeparator

Returns the list separator as set by the operating system (e.g. "," or ";")

public static string CurrentListSeparator { get; }

Property Value

string

CurrentNumberFormat

Returns the number format as set by the operating system

public static NumberFormatInfo CurrentNumberFormat { get; }

Property Value

NumberFormatInfo

DateFormats

Date formats

public static Dictionary<string, string> DateFormats { get; }

Property Value

Dictionary<string, string>

Dictionary of available DateFormats

Remarks

see https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

DefaultEncoding

Default Encoding (as set by the .NET implementation, in .NET Core and later versions this is UTF-8)

public static Encoding DefaultEncoding { get; }

Property Value

Encoding

DefaultNumberFormat

Default NumberFormat

public static NumberFormatInfo DefaultNumberFormat { get; }

Property Value

NumberFormatInfo

NumberFormatInfo instance with decimal separator "." and no NumberGroupSeparator

Methods

CalendarMonths()

Returns a list of calendar months from January to December

public static List<Month> CalendarMonths()

Returns

List<Month>

GetColorPalette(string)

Returns a specified color palette

public static Color[] GetColorPalette(string name = "Material")

Parameters

name string

Available color palettes are "Material", "Distinct", "Color Wheel" and "Random". Defaults to "Material".

Returns

Color[]

A color palette

ParseInterpretation(int)

Parses an integer to a TimeSeries.InterpretationEnum value. If the integer does not match any of the enum values, TimeSeries.InterpretationEnum.Undefined is returned and a warning is logged.

public static TimeSeries.InterpretationEnum ParseInterpretation(int interpretationValue)

Parameters

interpretationValue int

The integer value to be parsed

Returns

TimeSeries.InterpretationEnum

The corresponding TimeSeries.InterpretationEnum value

ParseInterpretation(string)

Parses a string to a TimeSeries.InterpretationEnum value. If the string does not match any of the enum names, TimeSeries.InterpretationEnum.Undefined is returned and a warning is logged.

public static TimeSeries.InterpretationEnum ParseInterpretation(string interpretationString)

Parameters

interpretationString string

The string to be parsed

Returns

TimeSeries.InterpretationEnum

The corresponding TimeSeries.InterpretationEnum value

StringToDouble(string, NumberFormatInfo)

Converts a string to a double

public static double StringToDouble(string str, NumberFormatInfo format = null)

Parameters

str string

string to be converted

format NumberFormatInfo

optional NumberFormatInfo object to use for the conversion. If not provided, the DefaultNumberInfo is used.

Returns

double

Double value, set to NaN if the string was not parseable. NaN and +-Infinity in the input string are recognized and converted to the correspoing Double value.