AJA Debug Macros

The macros are used to generate messages and assertions. More...

Macros
#define	AJA_ASSERT(_expression_)
#define	AJA_REPORT(_index_, _severity_, _format_, ...)
#define	AJA_PRINT(_format_, ...)
#define	AJA_sASSERT(_expr_)
#define	AJA_sREPORT(_index_, _severity_, _expr_)
#define	AJA_sEMERGENCY(_index_, _expr_)
#define	AJA_sALERT(_index_, _expr_)
#define	AJA_sERROR(_index_, _expr_)
#define	AJA_sWARNING(_index_, _expr_)
#define	AJA_sNOTICE(_index_, _expr_)
#define	AJA_sINFO(_index_, _expr_)
#define	AJA_sDEBUG(_index_, _expr_)

Detailed Description

The macros are used to generate messages and assertions.

Macro Definition Documentation

AJA_ASSERT

#define AJA_ASSERT

(

_expression_

)

Assert if expression is false.

This macro provides the file name and line number of the reporting module.

Parameters

[in]

<em>expression</em>

Boolean expression that should be false only in an exceptional condition.

Definition at line 113 of file debug.h.

AJA_PRINT

#define AJA_PRINT	(		_format_,
			...
	)

Definition at line 114 of file debug.h.

AJA_REPORT

#define AJA_REPORT	(		_index_,
			_severity_,
			_format_,
			...
	)

Report debug messages to active destinations.

This macro provides the file name and line number of the reporting module.

Parameters

[in]	<em>index</em>	Send message to this destination index.
[in]	<em>severity</em>	Severity (AJADebugSeverity) of the message to report.
[in]	<em>format</em>	Format parameters passed to vsprintf. The first is the format itself.

Definition at line 117 of file debug.h.

AJA_sALERT

#define AJA_sALERT	(		_index_,
			_expr_
	)

Reports a AJA_DebugSeverity_Alert message to active destinations using the given std::ostream expression.

This macro provides the file name and line number of the reporting module.

Parameters

[in]	<em>index</em>	Specifies the message classification as an AJADebugUnit.
[in]	<em>expr</em>	The message to report, as a std::ostream expression.

Definition at line 165 of file debug.h.

AJA_sASSERT

#define AJA_sASSERT

(

_expr_

)

Value:

                                                do  {   std::ostringstream  __ss__;  __ss__ << #_expr_;                 \
												AJADebug::AssertWithMessage(__FILE__, __LINE__, __ss__.str());  \
                                            } while (false)

Definition at line 126 of file debug.h.

AJA_sDEBUG

#define AJA_sDEBUG	(		_index_,
			_expr_
	)

Reports a AJA_DebugSeverity_Debug message to active destinations using the given std::ostream expression.

This macro provides the file name and line number of the reporting module.

Parameters

[in]	<em>index</em>	Specifies the message classification as an AJADebugUnit.
[in]	<em>expr</em>	The message to report, as a std::ostream expression.

Definition at line 220 of file debug.h.

AJA_sEMERGENCY

#define AJA_sEMERGENCY	(		_index_,
			_expr_
	)

Reports a AJA_DebugSeverity_Emergency message to active destinations using the given std::ostream expression.

This macro provides the file name and line number of the reporting module.

Parameters

[in]	<em>index</em>	Specifies the message classification as an AJADebugUnit.
[in]	<em>expr</em>	The message to report, as a std::ostream expression.

Definition at line 154 of file debug.h.

AJA_sERROR

#define AJA_sERROR	(		_index_,
			_expr_
	)

Reports a AJA_DebugSeverity_Error message to active destinations using the given std::ostream expression.

This macro provides the file name and line number of the reporting module.

Parameters

[in]	<em>index</em>	Specifies the message classification as an AJADebugUnit.
[in]	<em>expr</em>	The message to report, as a std::ostream expression.

Definition at line 176 of file debug.h.

AJA_sINFO

#define AJA_sINFO	(		_index_,
			_expr_
	)

Reports a AJA_DebugSeverity_Info message to active destinations using the given std::ostream expression.

This macro provides the file name and line number of the reporting module.

Parameters

[in]	<em>index</em>	Specifies the message classification as an AJADebugUnit.
[in]	<em>expr</em>	The message to report, as a std::ostream expression.

Definition at line 209 of file debug.h.

AJA_sNOTICE

#define AJA_sNOTICE	(		_index_,
			_expr_
	)

Reports a AJA_DebugSeverity_Notice message to active destinations using the given std::ostream expression.

This macro provides the file name and line number of the reporting module.

Parameters

[in]	<em>index</em>	Specifies the message classification as an AJADebugUnit.
[in]	<em>expr</em>	The message to report, as a std::ostream expression.

Definition at line 198 of file debug.h.

AJA_sREPORT

#define AJA_sREPORT	(		_index_,
			_severity_,
			_expr_
	)

Report a message to active destinations using the given std::ostream expression.

This macro provides the file name and line number of the reporting module.

Parameters

[in]	<em>index</em>	Specifies the message classification as an AJADebugUnit.
[in]	<em>severity</em>	Severity (AJADebugSeverity) of the message to report.
[in]	<em>expr</em>	The message to report, as a std::ostream expression (e.g. "Foo" << std::hex << 3500).

Definition at line 141 of file debug.h.

AJA_sWARNING

#define AJA_sWARNING	(		_index_,
			_expr_
	)

Reports a AJA_DebugSeverity_Warning message to active destinations using the given std::ostream expression.

This macro provides the file name and line number of the reporting module.

Parameters

[in]	<em>index</em>	Specifies the message classification as an AJADebugUnit.
[in]	<em>expr</em>	The message to report, as a std::ostream expression.

Definition at line 187 of file debug.h.