ALIB_DBG Class Reference

Class Description

---

This class contains static shortcuts to to methods of class Report. All invocations of the static methods get "pruned" (removed) from release compilations due to the method annotation "[Conditional( "DEBUG" )]"

Public Static Methods
static void	ASSERT (bool cond, [CallerLineNumber] int cln=0,[CallerFilePath] String csf="",[CallerMemberName] String cmn="")
static void	ASSERT_ERROR (bool cond, String msg, Object optMsg2=null, Object optMsg3=null, Object optMsg4=null, [CallerLineNumber] int cln=0,[CallerFilePath] String csf="",[CallerMemberName] String cmn="")
static void	ASSERT_WARNING (bool cond, String msg, Object optMsg2=null, Object optMsg3=null, Object optMsg4=null, [CallerLineNumber] int cln=0,[CallerFilePath] String csf="",[CallerMemberName] String cmn="")
static void	ERROR (String msg, Object optMsg2=null, Object optMsg3=null, Object optMsg4=null, [CallerLineNumber] int cln=0,[CallerFilePath] String csf="",[CallerMemberName] String cmn="")
static void	REPORT (int type, String msg, Object optMsg2=null, Object optMsg3=null, Object optMsg4=null, [CallerLineNumber] int cln=0,[CallerFilePath] String csf="",[CallerMemberName] String cmn="")
static void	WARNING (String msg, Object optMsg2=null, Object optMsg3=null, Object optMsg4=null, [CallerLineNumber] int cln=0,[CallerFilePath] String csf="",[CallerMemberName] String cmn="")

Member Function Documentation

ASSERT()

static void ASSERT ( bool  cond, [CallerLineNumber] int  cln = 0, [CallerFilePath] String  csf = "", [CallerMemberName] String  cmn = ""  )

inlinestatic

---

If given condition is false, method Report.DoReport gets invoked with the standard message "Internal Error". This method is pruned from release code.

Parameters

cond	The condition that has to be met to prevent ReportWriter call.
cln	(Optional) Caller info, compiler generated. Please omit.
csf	(Optional) Caller info, compiler generated. Please omit.
cmn	(Optional) Caller info, compiler generated. Please omit.

ASSERT_ERROR()

static void ASSERT_ERROR ( bool  cond, String  msg, Object  optMsg2 = null, Object  optMsg3 = null, Object  optMsg4 = null, [CallerLineNumber] int  cln = 0, [CallerFilePath] String  csf = "", [CallerMemberName] String  cmn = ""  )

inlinestatic

---

If given condition is false, method Report.DoReport gets invoked with the given message. This method is pruned from release code.

Parameters

cond	The condition that has to be met to prevent ReportWriter call.
msg	The msg to be passed to the ReportWriter.
optMsg2	An optional additional report object.
optMsg3	An optional additional report object.
optMsg4	An optional additional report object.
cln	(Optional) Caller info, compiler generated. Please omit.
csf	(Optional) Caller info, compiler generated. Please omit.
cmn	(Optional) Caller info, compiler generated. Please omit.

ASSERT_WARNING()

static void ASSERT_WARNING ( bool  cond, String  msg, Object  optMsg2 = null, Object  optMsg3 = null, Object  optMsg4 = null, [CallerLineNumber] int  cln = 0, [CallerFilePath] String  csf = "", [CallerMemberName] String  cmn = ""  )

inlinestatic

---

If given condition is false, method Report.DoReport gets invoked with the given message. This method is pruned from release code.

Parameters

cond	The condition that has to be met to prevent ReportWriter call.
msg	The msg to be passed to the ReportWriter.
optMsg2	An optional additional report object.
optMsg3	An optional additional report object.
optMsg4	An optional additional report object.
cln	(Optional) Caller info, compiler generated. Please omit.
csf	(Optional) Caller info, compiler generated. Please omit.
cmn	(Optional) Caller info, compiler generated. Please omit.

ERROR()

static void ERROR ( String  msg, Object  optMsg2 = null, Object  optMsg3 = null, Object  optMsg4 = null, [CallerLineNumber] int  cln = 0, [CallerFilePath] String  csf = "", [CallerMemberName] String  cmn = ""  )

inlinestatic

---

Invokes Report.DoReport. This method is pruned from release code.

Parameters

msg	The msg to be passed to the ReportWriter.
optMsg2	An optional additional report object.
optMsg3	An optional additional report object.
optMsg4	An optional additional report object.
cln	(Optional) Caller info, compiler generated. Please omit.
csf	(Optional) Caller info, compiler generated. Please omit.
cmn	(Optional) Caller info, compiler generated. Please omit.

REPORT()

static void REPORT ( int  type, String  msg, Object  optMsg2 = null, Object  optMsg3 = null, Object  optMsg4 = null, [CallerLineNumber] int  cln = 0, [CallerFilePath] String  csf = "", [CallerMemberName] String  cmn = ""  )

inlinestatic

---

Invokes Report.DoReport. This method is pruned from release code.

Parameters

type	The msg type.
msg	The msg to be passed to the ReportWriter.
optMsg2	An optional additional report object.
optMsg3	An optional additional report object.
optMsg4	An optional additional report object.
cln	(Optional) Caller info, compiler generated. Please omit.
csf	(Optional) Caller info, compiler generated. Please omit.
cmn	(Optional) Caller info, compiler generated. Please omit.

WARNING()

static void WARNING ( String  msg, Object  optMsg2 = null, Object  optMsg3 = null, Object  optMsg4 = null, [CallerLineNumber] int  cln = 0, [CallerFilePath] String  csf = "", [CallerMemberName] String  cmn = ""  )

inlinestatic

---

Invokes Report.DoReport. This method is pruned from release code.

Parameters

msg	The msg to be passed to the ReportWriter.
optMsg2	An optional additional report object.
optMsg3	An optional additional report object.
optMsg4	An optional additional report object.
cln	(Optional) Caller info, compiler generated. Please omit.
csf	(Optional) Caller info, compiler generated. Please omit.
cmn	(Optional) Caller info, compiler generated. Please omit.

---

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

• ALIB_DBG.cs