cmd_options.dox File Reference

This file documents preprocessor macros that are usually defined on the command-line to the compiler. More...

Macros
#define	Q_SPY
	The preprocessor switch to activate the QS software tracing instrumentation in QP/C++ Framework and QP/C++ Application code.
#define	QS_NFLOAT_T
	The preprocessor switch to suppress definitions of float32_t and float64_t.
#define	Q_UTEST
	The preprocessor switch to activate the QUTest testing instrumentation in QP/C++ Framework and QP/C++ Application code.

Detailed Description

This file documents preprocessor macros that are usually defined on the command-line to the compiler.

Definition in file cmd_options.dox.

Macro Definition Documentation

Q_SPY

#define Q_SPY

The preprocessor switch to activate the QS software tracing instrumentation in QP/C++ Framework and QP/C++ Application code.

Details
When defined, Q_SPY activates the QS software tracing instrumentation. When Q_SPY is not defined, the QS instrumentation in the code does not generate any code.

Note

The Q_SPY is typically defined only in the Spy build configuration and is not defined in other build configurations.

Definition at line 15 of file cmd_options.dox.

QS_NFLOAT_T

#define QS_NFLOAT_T

The preprocessor switch to suppress definitions of float32_t and float64_t.

Details
When defined, QS_NFLOAT_T suppresses the definitions of float32_t and float64_t.

Definition at line 24 of file cmd_options.dox.

Q_UTEST

#define Q_UTEST

The preprocessor switch to activate the QUTest testing instrumentation in QP/C++ Framework and QP/C++ Application code.

Details
When defined, Q_UTEST activates the QUTest testing instrumentation, which also requires QS software tracing (see Q_SPY).

Also, the Q_UTEST macro can have a value that decides whether the QP/C++ Framework "stub" is included or not. The following values are supported:

#define Q_UTEST   // the @QPX Framework testing "stub" is included
 
#define Q_UTEST 0 // the @QPX Framework testing "stub" is NOT included

Note

The Q_UTEST is typically defined only in the test fixtures.

Definition at line 42 of file cmd_options.dox.