Exceptions.hh

Go to the documentation of this file.

/*  HiRISE Exceptions

PIRL CVS ID: Exceptions.hh,v 2.4 2020/02/14 00:58:12 schaller Exp

Copyright (C) 2003-2020 Arizona Board of Regents on behalf of the Lunar and
Planetary Laboratory at the University of Arizona.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.

*/

#ifndef _UA_HIRISE_EXCEPTIONS_HEADER_
#define _UA_HIRISE_EXCEPTIONS_HEADER_

#include <exception>
#include <stdexcept>
#include <string>

namespace UA
{

namespace HiRISE
{

/*=*****************************************************************************
Exception Class
*******************************************************************************/

class Exception
:   public std::exception
{

public:

/*==============================================================================
Constants
*/
static const char* const
    ID;

/*==============================================================================
Constructors
*/

explicit Exception
(
    const std::string& message = "",
    const char* caller_id = NULL
);

//  Destructor
virtual ~Exception () throw () {}

/*==============================================================================
Accessors
*/

const char* what () const throw ();

std::string message () const throw ();

void message (const std::string& new_message);

private:

/*==============================================================================
Private Data
*/

std::string
    Message;
std::string::size_type
    User_Message_Index;

};  //  Exception class

/*=*****************************************************************************
Error Struct (Class)
*******************************************************************************/

struct Error
:   public Exception
{
explicit Error
(
    const std::string& message = "",
    const char *caller_id = NULL
)
:   Exception (std::string ("Error: ") + message, caller_id)
{}

};  //  Error struct

/*=*****************************************************************************
Invalid_Argument Struct (Class)
*******************************************************************************/

struct Invalid_Argument
:   public Error,
    public std::invalid_argument
{
explicit Invalid_Argument
(
    const std::string& message = "",
    const char *caller_id = NULL
)
:   Error (std::string ("Invalid_Argument\n") + message, caller_id),
    std::invalid_argument
    (
        std::string (Exception::ID)
        + (caller_id ? (std::string ("\n") + caller_id) : "")
    )
{}

};  //  Invalid_Argument struct

/*=*****************************************************************************
Out_of_Range Struct (Class)
*******************************************************************************/

struct Out_of_Range :
    public Error,
    public std::out_of_range
{
explicit Out_of_Range
(
    const std::string& message = "",
    const char *caller_id = NULL
)
:   Error (std::string ("Out_of_Range\n") + message, caller_id),
    std::out_of_range
    (
        std::string (Exception::ID)
        + (caller_id ? (std::string ("\n") + caller_id) : "")
    )
{}

};  //  Out_of_Range struct

}   //  HiRISE namespace

}   //  UA namespace

#endif