Codeboxes.Monitor.ImpactTopic Class Reference

This class is used at log and alert factories by the Monitor to determine the impact topic of the added message/information. It is just a value, simply combined with a description. Nothing special. Oh wait, there is more. Four default static readonly instances of this class are ready to be used. But if you want you can create and use your own ones. More...

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

Static Public Attributes
static ImpactTopic	TRIVIAL = new ImpactTopic("trivial")
	for all trivial stuff, or if you have to use an ImpactTopic object instead of null
static ImpactTopic	COMMUNICATION = new ImpactTopic("communication", "com")
	for communication to external sources, like backend, APIs, services or other applications
static ImpactTopic	SYSTEM = new ImpactTopic("system", "sys")
	for everything that is related to generic functions e.g. stuff that keeps your application alive or in the run, or for cleaning it up, aka tear something down
static ImpactTopic	LOADING = new ImpactTopic("loading")
	for loading (assets, data, resources, modules, ...)

Properties
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 and alert factories by the Monitor to determine the impact topic of the added message/information. It is just a value, simply combined with a description. Nothing special. Oh wait, there is more. Four default static readonly instances of this class are ready to be used. But if you want you can create and use your own ones.

Constructor & Destructor Documentation

ImpactTopic()

Codeboxes.Monitor.ImpactTopic.ImpactTopic ( string description = "trivial", [AllowNull] string abbreviation = null )

inline

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

Parameters

description	the description of the impact (used in UIs)
abbreviation	the abbreviation of the description (used in UIs)

Member Data Documentation

COMMUNICATION

ImpactTopic Codeboxes.Monitor.ImpactTopic.COMMUNICATION = new ImpactTopic("communication", "com")

static

for communication to external sources, like backend, APIs, services or other applications

LOADING

ImpactTopic Codeboxes.Monitor.ImpactTopic.LOADING = new ImpactTopic("loading")

static

for loading (assets, data, resources, modules, ...)

SYSTEM

ImpactTopic Codeboxes.Monitor.ImpactTopic.SYSTEM = new ImpactTopic("system", "sys")

static

for everything that is related to generic functions e.g. stuff that keeps your application alive or in the run, or for cleaning it up, aka tear something down

TRIVIAL

ImpactTopic Codeboxes.Monitor.ImpactTopic.TRIVIAL = new ImpactTopic("trivial")

static

for all trivial stuff, or if you have to use an ImpactTopic object instead of null

Property Documentation

Abbreviation

string Codeboxes.Monitor.ImpactTopic.Abbreviation

get

the optional abbreviation of the description (used in UIs)

Description

string Codeboxes.Monitor.ImpactTopic.Description

get

the description of the impact (used in UIs)

---

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

• Monitor/ImpactTopic.cs