Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

library_compiler_directives.h File Reference

Include file with the compiler directives for the RoboSoc library. More...

Include dependency graph for library_compiler_directives.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Defines

#define RS_TRIG_IN_DEG
 If defined then trigonometric functions will return angles in degrees.

#define RS_TRIG_IN_RAD
 If defined then trigonometric functions will return angles in radians.

#define RS_USE_ASSERT
 If defined then assertions will be check by the RS_ASSERT( cond, msg ) macro.

#define RS_LOG_ASSERT
 If defined then the action taken when an assertion fails is to send a message to the LogStream area ASSERT.

#define RS_THROW_ASSERT
 If defined and RS_LOG_ASSERT is not defined then the action when an assertion fails is to throw and AssertionFailed( cond, msg ) exception.

#define RS_USE_INVARIANT
 If defined then invariants will be check by the RS_INVARIANT( cond ) and RS_CHECK_INVARIANT macros.

#define RS_USE_REQUIRE
 If defined then preconditions will be check by the RS_REQUIRE( cond ) macro.

#define RS_USE_ENSURE
 If defined then postconditions will be check by the RS_ENSURE( cond ) macro.

#define RS_LOG_EXCEPTION
 If defined and RS_USE_EXCEPTION is not defined then exceptions that are thrown will instead be logged to the log stream.

#define RS_USE_ERROR
 If defined then RS_WARNING( str ), RS_ERROR( str ), and RS_FATAL( str ) statements will be reported.

#define RS_LOG_ERROR
 If defined then errors that are reported will be sent to the log stream.

#define RS_USE_DEBUG
 If defined then RS_DEBUG( str ) statements will be reported.

#define RS_LOG_DEBUG
 If defined then debug information will be sent to the log stream instead of to the rs_debug function.

#define RS_USE_LOG
 If defined then RS_LOG( area, str ) statements will be sent to the log stream.


Detailed Description

Include file with the compiler directives for the RoboSoc library.

Unit:
Library
Revision
1.4
Author
frehe
Date
2001/09/03 19:38:03

Definition in file library_compiler_directives.h.


Define Documentation

#define RS_USE_ASSERT
 

If defined then assertions will be check by the RS_ASSERT( cond, msg ) macro.

If the assertion fails then an action will be taken depending on the other compiler directives. The default is to call the external function rs_assert(const std::string& cond, const std::string& msg, const std::string& file, int line), which must be defined by the user if used.

Definition at line 87 of file library_compiler_directives.h.

#define RS_USE_INVARIANT
 

If defined then invariants will be check by the RS_INVARIANT( cond ) and RS_CHECK_INVARIANT macros.

They are implemented using RS_ASSERT, so the result if the test fails depends on its definition.

Definition at line 107 of file library_compiler_directives.h.

#define RS_USE_REQUIRE
 

If defined then preconditions will be check by the RS_REQUIRE( cond ) macro.

It is implemented using RS_ASSERT, so the result if the test fails depends on its definition.

Definition at line 113 of file library_compiler_directives.h.

#define RS_USE_ENSURE
 

If defined then postconditions will be check by the RS_ENSURE( cond ) macro.

It is implemented using RS_ASSERT, so the result if the test fails depends on its definition.

Definition at line 119 of file library_compiler_directives.h.

#define RS_USE_ERROR
 

If defined then RS_WARNING( str ), RS_ERROR( str ), and RS_FATAL( str ) statements will be reported.

The standard way of reporting the error information is through a external functions called rs_warning, rs_error, and rs_fatal, all with the signatur void rs_error(const std::string& str, const std::string& file, int line). Each functions has to be defined by the user if it is used. If not defined then no code is generated at all for RS_WARNING, RS_ERROR, or RS_FATAL statements.

Definition at line 137 of file library_compiler_directives.h.

#define RS_LOG_ERROR
 

If defined then errors that are reported will be sent to the log stream.

If RS_LOG_ERROR is defined but RS_USE_LOG is not defined then all errors will be disregarded.

Definition at line 142 of file library_compiler_directives.h.

#define RS_USE_DEBUG
 

If defined then RS_DEBUG( str ) statements will be reported.

The standard way of reporting the debug information is through a external function called void rs_debug(const std::string& str, const std::string& file, int line), which the user has to define if it is used. If not defined then no code is generated at all for RS_DEBUG statements.

Definition at line 151 of file library_compiler_directives.h.

#define RS_LOG_DEBUG
 

If defined then debug information will be sent to the log stream instead of to the rs_debug function.

If RS_LOG_DEBUG is defined but RS_USE_LOG is not defined then all debug information will be disregarded.

Definition at line 157 of file library_compiler_directives.h.

#define RS_USE_LOG
 

If defined then RS_LOG( area, str ) statements will be sent to the log stream.

If not defined then no code is generated at all for RS_LOG statements.

Definition at line 163 of file library_compiler_directives.h.


Generated on Mon Aug 29 08:07:24 2011 for RoboSoc by doxygen1.3-rc3