jalhyd
Version:
JaLHyd, a Javascript Library for Hydraulics
54 lines • 2.21 kB
TypeScript
import { Nub } from "../internal_modules";
import { Result } from "../internal_modules";
import { Espece } from "../internal_modules";
import { FishPass } from "../internal_modules";
import { VerificateurParams } from "../internal_modules";
export declare class Verificateur extends Nub {
/** Instances of Espece re-created before each calculation */
protected _species: Espece[];
/** Index of the reseult element to verify, when the pass to verify is variating */
protected _variatingIndex: number;
constructor(dbg?: boolean);
get species(): Espece[];
get prms(): VerificateurParams;
/** Contains either string keys from FishSpecies enum, or UIDs of Espece Session Nubs */
get speciesList(): string[];
set speciesList(l: string[]);
/** finds the Nub to verify by its UID */
get nubToVerify(): FishPass;
/** defines the Nub to verify by setting property "nubToVerify" to the UID of the given Nub */
set nubToVerify(n: FishPass);
/**
* Adds a new empty ResultElement to the current Result object, so that
* computation result is stored into it, via set currentResult(); does
* the same for all Espece Nubs
*/
initNewResultElement(): void;
/**
* Sets this._result to a new empty Result, before starting a new CalcSerie();
* does the same for all Espece Nubs
*/
reinitResult(): void;
CalcSerie(rInit?: number): Result;
Calc(): Result;
/**
* Returns 1 if everything is OK, 0 as soon as a species check fails
*/
Equation(): Result;
/**
* Creates an instance of Espece for each element of this.speciesList, and places
* it in this.species so that their results are kept and their logs are accessible
* after calculation has ended
*/
protected initSpecies(): void;
/**
* Retrieves an Espece from a given string, which should be either
* the UID of an Espece Session Nub, or the label of an element
* of FishSpecies enum
* @param s
*/
protected getEspeceFromString(s: string): Espece;
protected setParametersCalculability(): void;
protected findCalculatedParameter(): any;
}
//# sourceMappingURL=verificateur.d.ts.map