src/components/diagnosticsMessage.ts
Provides diagnostic information from the camera.
Properties |
Accessors |
constructor(type: string)
|
||||||
Defined in src/components/diagnosticsMessage.ts:16
|
||||||
Parameters :
|
Protected _level |
Type : DiagnosticsLevel
|
Default value : DiagnosticsLevel.INFO
|
Defined in src/components/diagnosticsMessage.ts:14
|
Protected _message |
Type : string
|
Default value : ''
|
Defined in src/components/diagnosticsMessage.ts:15
|
Protected _tip |
Type : string
|
Default value : 'No tip available'
|
Defined in src/components/diagnosticsMessage.ts:16
|
Protected _type |
Type : string
|
Defined in src/components/diagnosticsMessage.ts:13
|
message |
getmessage()
|
Defined in src/components/diagnosticsMessage.ts:25
|
Human readable message in english if type is ok, or not
Returns :
string
|
type |
gettype()
|
Defined in src/components/diagnosticsMessage.ts:34
|
Type that indentifies what type of diagnostics message it is e.g USBMODE
Returns :
string
|
level |
getlevel()
|
Defined in src/components/diagnosticsMessage.ts:43
|
What type of level is the message, INFO, WARN, ERROR
Returns :
DiagnosticsLevel
|
tip |
gettip()
|
Defined in src/components/diagnosticsMessage.ts:52
|
Human readable message how you can mitigate a problem
Returns :
string
|
data |
getdata()
|
Defined in src/components/diagnosticsMessage.ts:61
|
Data object can contain more detailed information about the diagnostics information
Returns :
any
|
export enum DiagnosticsLevel {
INFO = 'INFO',
WARN = 'WARN',
ERROR = 'ERROR',
}
/**
* Provides diagnostic information from the camera.
* @export
* @class DiagnosticsMessage
*/
export default abstract class DiagnosticsMessage {
protected _type: string;
protected _level: DiagnosticsLevel = DiagnosticsLevel.INFO;
protected _message: string = '';
protected _tip: string = 'No tip available';
constructor(type: string) {
this._type = type;
}
/**
* Human readable message in english if type is ok, or not
* @type {string}
* @memberof DiagnosticsMessage
*/
get message(): string {
return this._message;
}
/**
* Type that indentifies what type of diagnostics message it is e.g USBMODE
* @type {string}
* @memberof DiagnosticsMessage
*/
get type(): string {
return this._type;
}
/**
* What type of level is the message, INFO, WARN, ERROR
* @type {DiagnosticsLevel}
* @memberof DiagnosticsMessage
*/
get level(): DiagnosticsLevel {
return this._level;
}
/**
* Human readable message how you can mitigate a problem
* @type {string}
* @memberof DiagnosticsMessage
*/
get tip(): string {
return this._tip;
}
/**
* Data object can contain more detailed information about the diagnostics information
* @type {any}
* @memberof DiagnosticsMessage
*/
get data(): any {
return undefined;
}
}