trc() method from fcf::NTest::Logger class

fcf::NTest::Logger::Writer trc(unsigned int a_messageCategory = fcf::NTest::LMC_USER_GROUP)

Available from version: 1.0.1

Returns an fcf::NTest::Logger::Writer object for trace log messages. This logging level is used to extract tracing data.

The message will only be written to the output if the current logger threshold is set to fcf::NTest::LL_TRC or upper (fcf::NTest::LL_ALL).

This logging level is useful for displaying tracing information.

Arguments

unsigned int a_messageCategory = fcf::NTest::LMC_USER_GROUP

- [SINCE 1.1.14] integer category identifier.

Result

fcf::NTest::Logger::Writer

- An RAII-based stream wrapper used to buffer log messages before sending them to the logger.

Example: Basic Trace Logging

#define FCF_TEST_IMPLEMENTATION #include <fcfTest/test.hpp> int main(int a_arg, char* a_argv[]) { // We set the logging level, // since this level is upper than the default level (LL_DBG). fcf::NTest::logger().level(fcf::NTest::LL_DBG); fcf::NTest::logger().trc() << "The application is running" << std::endl; return 0; }

Output:

The application is running

Example: Output to terminal with switching to logging mode

If we just run this test, then we will not see any message. However, if we run the test by transferring the login mode to "Trace", we will see our message.

#define FCF_TEST_IMPLEMENTATION #include <fcfTest/test.hpp> // Tested structure struct User { int frontPos; void go() { ++frontPos; } void back() { --frontPos; } }; // Our main test FCF_TEST_DEFINE("Engine", "User", "Motion"){ User user = {0}; // By default, the log output will not be executed // It is necessary to set the level of logging, trace or higher. fcf::NTest::logger().trc() << " frontPos before calling the go method: " << user.frontPos << std::endl; user.go(); fcf::NTest::logger().trc() << " frontPos after calling the go method: " << user.frontPos << std::endl; user.back(); fcf::NTest::logger().trc() << " frontPos after calling the back method: " << user.frontPos << std::endl; FCF_TEST(user.frontPos == 0, user.frontPos); } int main(int a_argc, char* a_argv[]) { bool error; // We run all tests declared in the application fcf::NTest::cmdRun(a_argc, a_argv, fcf::NTest::CRM_RUN, &error); return error ? 1 : 0; }

Running (Start by default. Level logging is log):

LAUNCH $: ./example

Output:

Performing the test: "Engine" -> "User" -> "Motion" ... All tests were completed. Number of tests: 1

Running (We start with the logging mode debug):

LAUNCH $: ./example --test-log-level trc

Output:

Performing the test: "Engine" -> "User" -> "Motion" ... frontPos before calling the go method: 0 frontPos after calling the go method: 1 frontPos after calling the back method: 0 All tests were completed. Number of tests: 1