Codeboxes.Monitor.ImpactLevel Class Reference

This class is used at log, alert factories and console trace by the Monitor to determine the impact of the added message/information. It is just a value, simply combined with a description. Nothing special. Oh wait, there is more. Five default static readonly instances of this class are ready to be used. More...

Public Member Functions
	ImpactLevel (int value=0, string description="info", [AllowNull] string abbreviation=null)
	Constructs a new ImpactLevel and sets the given values to the according member reverences.

Static Public Attributes
static ImpactLevel	INFO = new ImpactLevel(0, "info")
	just for information; everything is fine; nothing is broken; trivial
static ImpactLevel	DEBUG = new ImpactLevel(1, "debug")
	for debugging; it depends on you, if that means it should be debugged or is used during debugging;
static ImpactLevel	WARN = new ImpactLevel(2, "warning", "warn")
	the message is a warning; you should have a look at that one; but don't panic, nothing is broken;
static ImpactLevel	ERROR = new ImpactLevel(3, "error")
	something went wrong; unexpected behaviour; client/app is (maybe) still running; you should fix that;
static ImpactLevel	FATAL = new ImpactLevel(4, "fatal")
	panic! client/app has stopped due to a fatal error; fix it as asap as possible;

Properties
int	Value [get]
	the value of the impact (used to differentiate the according messages/information)
string	Description [get]
	the description of the impact (used in UIs)
string	Abbreviation [get]
	the optional abbreviation of the description (used in UIs)

Detailed Description

This class is used at log, alert factories and console trace by the Monitor to determine the impact of the added message/information. It is just a value, simply combined with a description. Nothing special. Oh wait, there is more. Five default static readonly instances of this class are ready to be used.

Constructor & Destructor Documentation

ImpactLevel()

Codeboxes.Monitor.ImpactLevel.ImpactLevel ( int value = 0, string description = "info", [AllowNull] string abbreviation = null )

inline

Constructs a new ImpactLevel and sets the given values to the according member reverences.

Parameters

value	the value of the impact (used to differentiate the according messages/information)
description	the description of the impact (used in UIs)
abbreviation	the abbreviation of the description (used in UIs)

Member Data Documentation

DEBUG

ImpactLevel Codeboxes.Monitor.ImpactLevel.DEBUG = new ImpactLevel(1, "debug")

static

for debugging; it depends on you, if that means it should be debugged or is used during debugging;

ERROR

ImpactLevel Codeboxes.Monitor.ImpactLevel.ERROR = new ImpactLevel(3, "error")

static

something went wrong; unexpected behaviour; client/app is (maybe) still running; you should fix that;

FATAL

ImpactLevel Codeboxes.Monitor.ImpactLevel.FATAL = new ImpactLevel(4, "fatal")

static

panic! client/app has stopped due to a fatal error; fix it as asap as possible;

INFO

ImpactLevel Codeboxes.Monitor.ImpactLevel.INFO = new ImpactLevel(0, "info")

static

just for information; everything is fine; nothing is broken; trivial

WARN

ImpactLevel Codeboxes.Monitor.ImpactLevel.WARN = new ImpactLevel(2, "warning", "warn")

static

the message is a warning; you should have a look at that one; but don't panic, nothing is broken;

Property Documentation

Abbreviation

string Codeboxes.Monitor.ImpactLevel.Abbreviation

get

the optional abbreviation of the description (used in UIs)

Description

string Codeboxes.Monitor.ImpactLevel.Description

get

the description of the impact (used in UIs)

Value

int Codeboxes.Monitor.ImpactLevel.Value

get

the value of the impact (used to differentiate the according messages/information)

---

The documentation for this class was generated from the following file:

• Monitor/ImpactLevel.cs