/** @packageDocumentation * Grundlegende Fehlerbehandlung * * Letzte Aenderung: 02.06.2021 * Status: gruen * * @module core/error * @author SB */ import { SpeechErrorFunc } from '../interface/speech-function.type'; import { IErrorBase } from './error-base.interface'; export { IErrorBase }; /** @export * Basisklasse fuer die Fehlerbehandlung in allen anderen Klassen */ export declare class ErrorBase implements IErrorBase { /** * statischer Klassenname fuer die Ausgabe des Fehlers */ private mErrorClassName; /** * Fehlerausgabeflag zur Bestimmung, ob ein Fehler auf der Konsole * ausgegeben wird. * Der Defaultwert ist in SPEECH_ERROR_OUTPUT festgelegt. */ private mErrorOutputFlag; /** * Rueckgabe des Fehlertextes, wenn error oder exception aufgerufen wurde * * errorCallbackFunc( aErrorText: string ) */ mErrorOutputFunc: SpeechErrorFunc; /** * Erzeugt eine Instanz von ErrorBase * * @param aClassName - statischer Klassenname fuer die Fehlerbehandlung */ constructor(aClassName: string); /** * setzen eines statischen Klassennamens fuer die Fehlerausgabe * * @protected * @param {string} aClassName - Name der Klasse */ protected _setErrorClassName(aClassName: string): void; /** * Rueckgage des eingetragenen statischen Klassennamens * * @protected * @return {string} statischer Klassenname fuer die Fehlerausgabe */ protected _getErrorClassName(): string; /** * setzen des Fehlerausgabeflags * * @protected * @param {boolean} aErrorOutputFlag - Fehlerausgabeflag */ setErrorOutput(aErrorOutputFlag: boolean): void; /** * setzt die Fehlerausgabewieder auf Defaultwert SPEECH_ERROR_OUTPUT */ setErrorOutputDefault(): void; /** * Eintragen einer Fehlerfunktion fuer den Fehler, wenn error * oder exception aufgerufen wurden. Es wird ein Fehlertext uebergeben. * * @param {SpeechErrorFunc} aErrorFunc - Funktion fuer die Fehlerbehandlung */ setErrorOutputFunc(aErrorFunc: SpeechErrorFunc): void; /** * Fehlerausgabe in Abhaengigkeit vom eingestellten ErrorOutput Flag * * @param {string} aFuncName - Name der Funktion, in der der Fehler auftrat * @param {string} aErrorText - Fehlertext fuer Ausgabe */ error(aFuncName: string, aErrorText: string): void; /** * Exceptionausgabe, ist nicht in IPlugin vorhanden, * da es nur intern verwendet wird. Versendet einen ErrorEvent * * @param {string} aFuncName - Name der Funktion, in der der Fehler auftrat * @param {Exception} aException - Exceptionobjekt */ exception(aFuncName: string, aException: any): void; /** * Pruefen auf Fehlerausgabe ueber die Konsole * * @returns {boolean} */ isErrorOutput(): boolean; /** * Einschalten der Fehlerausgabe ueber die Konsole */ setErrorOutputOn(): void; /** * Ausschalten der Fehlerausgabe ueber die Konsole */ setErrorOutputOff(): void; }