Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

mbed_error.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mturner5 0:b7116bd48af6 1 /* mbed Microcontroller Library
mturner5 0:b7116bd48af6 2 * Copyright (c) 2006-2013 ARM Limited
mturner5 0:b7116bd48af6 3 *
mturner5 0:b7116bd48af6 4 * Licensed under the Apache License, Version 2.0 (the "License");
mturner5 0:b7116bd48af6 5 * you may not use this file except in compliance with the License.
mturner5 0:b7116bd48af6 6 * You may obtain a copy of the License at
mturner5 0:b7116bd48af6 7 *
mturner5 0:b7116bd48af6 8 * http://www.apache.org/licenses/LICENSE-2.0
mturner5 0:b7116bd48af6 9 *
mturner5 0:b7116bd48af6 10 * Unless required by applicable law or agreed to in writing, software
mturner5 0:b7116bd48af6 11 * distributed under the License is distributed on an "AS IS" BASIS,
mturner5 0:b7116bd48af6 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mturner5 0:b7116bd48af6 13 * See the License for the specific language governing permissions and
mturner5 0:b7116bd48af6 14 * limitations under the License.
mturner5 0:b7116bd48af6 15 */
mturner5 0:b7116bd48af6 16 #ifndef MBED_ERROR_H
mturner5 0:b7116bd48af6 17 #define MBED_ERROR_H
mturner5 0:b7116bd48af6 18
mturner5 0:b7116bd48af6 19 /** To generate a fatal compile-time error, you can use the pre-processor #error directive.
mturner5 0:b7116bd48af6 20 *
mturner5 0:b7116bd48af6 21 * @code
mturner5 0:b7116bd48af6 22 * #error "That shouldn't have happened!"
mturner5 0:b7116bd48af6 23 * @endcode
mturner5 0:b7116bd48af6 24 *
mturner5 0:b7116bd48af6 25 * If the compiler evaluates this line, it will report the error and stop the compile.
mturner5 0:b7116bd48af6 26 *
mturner5 0:b7116bd48af6 27 * For example, you could use this to check some user-defined compile-time variables:
mturner5 0:b7116bd48af6 28 *
mturner5 0:b7116bd48af6 29 * @code
mturner5 0:b7116bd48af6 30 * #define NUM_PORTS 7
mturner5 0:b7116bd48af6 31 * #if (NUM_PORTS > 4)
mturner5 0:b7116bd48af6 32 * #error "NUM_PORTS must be less than 4"
mturner5 0:b7116bd48af6 33 * #endif
mturner5 0:b7116bd48af6 34 * @endcode
mturner5 0:b7116bd48af6 35 *
mturner5 0:b7116bd48af6 36 * Reporting Run-Time Errors:
mturner5 0:b7116bd48af6 37 * To generate a fatal run-time error, you can use the mbed error() function.
mturner5 0:b7116bd48af6 38 *
mturner5 0:b7116bd48af6 39 * @code
mturner5 0:b7116bd48af6 40 * error("That shouldn't have happened!");
mturner5 0:b7116bd48af6 41 * @endcode
mturner5 0:b7116bd48af6 42 *
mturner5 0:b7116bd48af6 43 * If the mbed running the program executes this function, it will print the
mturner5 0:b7116bd48af6 44 * message via the USB serial port, and then die with the blue lights of death!
mturner5 0:b7116bd48af6 45 *
mturner5 0:b7116bd48af6 46 * The message can use printf-style formatting, so you can report variables in the
mturner5 0:b7116bd48af6 47 * message too. For example, you could use this to check a run-time condition:
mturner5 0:b7116bd48af6 48 *
mturner5 0:b7116bd48af6 49 * @code
mturner5 0:b7116bd48af6 50 * if(x >= 5) {
mturner5 0:b7116bd48af6 51 * error("expected x to be less than 5, but got %d", x);
mturner5 0:b7116bd48af6 52 * }
mturner5 0:b7116bd48af6 53 * #endcode
mturner5 0:b7116bd48af6 54 */
mturner5 0:b7116bd48af6 55
mturner5 0:b7116bd48af6 56 #ifdef __cplusplus
mturner5 0:b7116bd48af6 57 extern "C" {
mturner5 0:b7116bd48af6 58 #endif
mturner5 0:b7116bd48af6 59
mturner5 0:b7116bd48af6 60 void error(const char* format, ...);
mturner5 0:b7116bd48af6 61
mturner5 0:b7116bd48af6 62 #ifdef __cplusplus
mturner5 0:b7116bd48af6 63 }
mturner5 0:b7116bd48af6 64 #endif
mturner5 0:b7116bd48af6 65
mturner5 0:b7116bd48af6 66 #endif