DotNet.Ships.Class.ShieldRecovery

EliteDangerousAlmanac / Ships / ShieldRecovery

Class: ShieldRecovery

Defined in: dotnet/src/EliteDangerousAlmanac/Ships/ShieldRecovery.cs:94

Shield collapse, regeneration and cell-bank aggregation, all data-free.

Remarks

The recovery timing is ported from EDCD/Coriolis at the revision data/ships/SOURCES.md records. See ATTRIBUTIONS.md for credit and licence terms.

Methods

Metrics()

static Metrics(input, systemsPips?): ShieldRecoveryMetrics

Defined in: dotnet/src/EliteDangerousAlmanac/Ships/ShieldRecovery.cs:110

Calculates shield recovery and regeneration times at one SYS-pip allocation.

Parameters

input

ShieldRecoveryInput

The shield strength, the generator rates and the distributor figures.

systemsPips

double = 4

The pips assigned to SYS, from zero through four.

Returns

ShieldRecoveryMetrics

The rates, and the seconds to half and to full strength. A phase that cannot finish answers infinity.

Exceptions

ArgumentNullException

input is null.

ArgumentOutOfRangeException

The allocation is outside zero through four, or a figure is negative or not finite.

SummariseCellBanks()

static SummariseCellBanks(banks): CellBankSummary

Defined in: dotnet/src/EliteDangerousAlmanac/Ships/ShieldRecovery.cs:141

Aggregates fitted shield cell banks while keeping each one's power state.

Parameters

banks

IReadOnlyList<CellBankInput>

The banks, in the order their slots should be reported.

Returns

CellBankSummary

The per-bank figures and the totals over the powered banks. An empty list answers an empty bank list and no totals.

Exceptions

ArgumentNullException

banks is null.