.. _program_listing_file_include_tf2_exceptions.h:

Program Listing for File exceptions.h
=====================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_tf2_exceptions.h>` (``include/tf2/exceptions.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // Copyright 2008, Willow Garage, Inc. All rights reserved.
   //
   // Redistribution and use in source and binary forms, with or without
   // modification, are permitted provided that the following conditions are met:
   //
   //    * Redistributions of source code must retain the above copyright
   //      notice, this list of conditions and the following disclaimer.
   //
   //    * Redistributions in binary form must reproduce the above copyright
   //      notice, this list of conditions and the following disclaimer in the
   //      documentation and/or other materials provided with the distribution.
   //
   //    * Neither the name of the Willow Garage nor the names of its
   //      contributors may be used to endorse or promote products derived from
   //      this software without specific prior written permission.
   //
   // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
   // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   // POSSIBILITY OF SUCH DAMAGE.
   
   #ifndef TF2__EXCEPTIONS_H_
   #define TF2__EXCEPTIONS_H_
   
   #include <stdexcept>
   #include <cstdint>
   #include <string>
   
   #include "tf2/visibility_control.h"
   
   namespace tf2
   {
   
   // TODO(clalancette): We can remove these workarounds when we remove the
   // deprecated TF2Error enums.
   #if defined(_WIN32)
   #pragma push_macro("NO_ERROR")
   #undef NO_ERROR
   #endif
   #if defined(__APPLE__) || defined(__clang__)
   // The clang compiler on Apple claims that [[deprecated]] on an enumerator value
   // is a C++17 feature, when it was really introduced in C++14.  Ignore that
   // warning when defining the structure; this whole thing will go away when we
   // remove the deprecated values.
   #pragma clang diagnostic push
   #pragma clang diagnostic ignored "-Wc++17-extensions"
   #endif
   
   enum class TF2Error : std::uint8_t
   {
     // While the TF2_ prefix here is a bit redundant, it also prevents us from
     // colliding with Windows defines (specifically, NO_ERROR).
     TF2_NO_ERROR = 0,
     TF2_LOOKUP_ERROR = 1,
     TF2_CONNECTIVITY_ERROR = 2,
     TF2_EXTRAPOLATION_ERROR = 3,
     TF2_INVALID_ARGUMENT_ERROR = 4,
     TF2_TIMEOUT_ERROR = 5,
     TF2_TRANSFORM_ERROR = 6,
     TF2_BACKWARD_EXTRAPOLATION_ERROR = 7,
     TF2_FORWARD_EXTRAPOLATION_ERROR = 8,
     TF2_NO_DATA_FOR_EXTRAPOLATION_ERROR = 9,
   
     NO_ERROR [[deprecated("Use TF2_NO_ERROR instead")]] = 0,
     LOOKUP_ERROR [[deprecated("Use TF2_LOOKUP_ERROR instead")]] = 1,
     CONNECTIVITY_ERROR [[deprecated("Use TF2_CONNECTIVITY_ERROR instead")]] = 2,
     EXTRAPOLATION_ERROR [[deprecated("Use TF2_EXTRAPOLATION_ERROR instead")]] = 3,
     INVALID_ARGUMENT_ERROR [[deprecated("Use TF2_INVALID_ARGUMENT_ERROR instead")]] = 4,
     TIMEOUT_ERROR [[deprecated("Use TF2_TIMEOUT_ERROR instead")]] = 5,
     TRANSFORM_ERROR [[deprecated("Use TF2_TRANSFORM_ERROR instead")]] = 6
   };
   
   // TODO(clalancette): We can remove these workarounds when we remove the
   // deprecated TF2Error enums.
   #if defined(__APPLE__)
   #pragma clang diagnostic pop
   #endif
   #if defined(_WIN32)
   #pragma pop_macro("NO_ERROR")
   #endif
   
   class TransformException : public std::runtime_error
   {
   public:
     TF2_PUBLIC
     explicit TransformException(const std::string errorDescription)
     : std::runtime_error(errorDescription)
     {
     }
   };
   
   
   class ConnectivityException : public TransformException
   {
   public:
     TF2_PUBLIC
     explicit ConnectivityException(const std::string errorDescription)
     : tf2::TransformException(errorDescription)
     {
     }
   };
   
   
   class LookupException : public TransformException
   {
   public:
     TF2_PUBLIC
     explicit LookupException(const std::string errorDescription)
     : tf2::TransformException(errorDescription)
     {
     }
   };
   
   class ExtrapolationException : public TransformException
   {
   public:
     TF2_PUBLIC
     explicit ExtrapolationException(const std::string errorDescription)
     : tf2::TransformException(errorDescription)
     {
     }
   };
   
   class BackwardExtrapolationException : public ExtrapolationException
   {
   public:
     TF2_PUBLIC
     explicit BackwardExtrapolationException(const std::string errorDescription)
     : ExtrapolationException(errorDescription)
     {
     }
   };
   
   class ForwardExtrapolationException : public ExtrapolationException
   {
   public:
     TF2_PUBLIC
     explicit ForwardExtrapolationException(const std::string errorDescription)
     : ExtrapolationException(errorDescription)
     {
     }
   };
   
   class NoDataForExtrapolationException : public ExtrapolationException
   {
   public:
     TF2_PUBLIC
     explicit NoDataForExtrapolationException(const std::string errorDescription)
     : ExtrapolationException(errorDescription)
     {
     }
   };
   
   class InvalidArgumentException : public TransformException
   {
   public:
     TF2_PUBLIC
     explicit InvalidArgumentException(const std::string errorDescription)
     : tf2::TransformException(errorDescription) {}
   };
   
   class TimeoutException : public TransformException
   {
   public:
     TF2_PUBLIC
     explicit TimeoutException(const std::string errorDescription)
     : tf2::TransformException(errorDescription)
     {
     }
   };
   }  // namespace tf2
   #endif  // TF2__EXCEPTIONS_H_