DotNet.Ships.Class.CalculationResult

EliteDangerousAlmanac / Ships / CalculationResult

Class: CalculationResult

Defined in: dotnet/src/EliteDangerousAlmanac/Ships/LoadoutCalculations.cs:118

Builds a CalculationResult<T>.

Methods

Of()

static Of<T>(value): CalculationResult<T>

Defined in: dotnet/src/EliteDangerousAlmanac/Ships/LoadoutCalculations.cs:128

Wraps a value that is already known.

Parameters

value

T

The known value.

Returns

CalculationResult<T>

A complete result that names no issue.

Exceptions

ArgumentNullException

value is null.

Unavailable()

static Unavailable<T>(issues): CalculationResult<T>

Defined in: dotnet/src/EliteDangerousAlmanac/Ships/LoadoutCalculations.cs:138

Wraps the inputs that stopped the calculation.

Parameters

issues

IReadOnlyList<CalculationIssue>

The missing or unavailable inputs. There must be at least one.

Returns

CalculationResult<T>

An incomplete result.

Exceptions

ArgumentNullException

issues is null.

ArgumentException

issues is empty.

Unavailable()

static Unavailable<T>(issue): CalculationResult<T>

Defined in: dotnet/src/EliteDangerousAlmanac/Ships/LoadoutCalculations.cs:156

Wraps the one input that stopped the calculation.

Parameters

issue

CalculationIssue

The missing or unavailable input.

Returns

CalculationResult<T>

An incomplete result.

Exceptions

ArgumentNullException

issue is null.