Exception.h

// Copyright (c) 2013 by István Váradi
 
// This file is part of XPLRA, a remote-access plugin for X-Plane
 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
 
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 2. 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.
 
// 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 OWNER 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.
 
// The views and conclusions contained in the software and documentation are those
// of the authors and should not be interpreted as representing official policies,
// either expressed or implied, of the FreeBSD Project.
 
#ifndef HU_VARADIISTVAN_XPLRA_EXCEPTION_H
#define HU_VARADIISTVAN_XPLRA_EXCEPTION_H
//------------------------------------------------------------------------------
 
#include <exception>
 
#include <string>
 
//------------------------------------------------------------------------------
 
namespace hu { namespace varadiistvan { namespace xplra {
 
//------------------------------------------------------------------------------
 
class Exception : public std::exception
{
protected:
    std::string message;
 
public:
    Exception(const char* message) throw();
 
protected:
    Exception() throw();
 
public:
    virtual ~Exception() throw();
 
public:
    virtual const char* what() const throw();
};
 
//------------------------------------------------------------------------------
 
class IOException : public Exception
{
public:
    typedef unsigned long errorCode_t;
 
private:
    errorCode_t errorCode;
 
public:
    IOException(errorCode_t errorCode) throw();
 
 
    errorCode_t getErrorCode() const throw();
};
 
//------------------------------------------------------------------------------
 
class ProtocolException : public Exception
{
public:
    typedef enum {
        INVALID_COMMAND = 1,
 
        UNKNOWN_DATAREF = 2,
 
        INVALID_TYPE = 3,
 
        INVALID_LENGTH = 4,
 
        INVALID_OFFSET = 5,
 
        INVALID_COUNT = 6,
 
        INVALID_ID = 7,
 
        INVALID_DURATION = 8,
 
        OTHER = 255
    } errorCode_t;
 
private:
    errorCode_t errorCode;
 
    bool hasParameter;
 
    long parameter;
 
public:
    ProtocolException(errorCode_t errorCode,
                      bool hasParameter = false, long parameter = 0) throw();
 
    errorCode_t getErrorCode() const throw();
 
    bool getParameter(long& param) const throw();
};
 
//------------------------------------------------------------------------------
 
class NotConnectedException : public Exception
{
public:
    NotConnectedException() throw();
};
 
//------------------------------------------------------------------------------
 
class TypeMismatchException : public Exception
{
public:
    TypeMismatchException() throw();
};
 
//------------------------------------------------------------------------------
 
class InvalidIDException : public Exception
{
public:
    InvalidIDException() throw();
};
 
//------------------------------------------------------------------------------
// Inline definitions
//------------------------------------------------------------------------------
 
inline Exception::Exception(const char* message) throw() :
    message(message)
{
}
 
//------------------------------------------------------------------------------
 
inline Exception::Exception() throw()
{
}
 
//------------------------------------------------------------------------------
 
inline Exception::~Exception() throw()
{
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline IOException::errorCode_t IOException::getErrorCode() const throw()
{
    return errorCode;
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline ProtocolException::errorCode_t
ProtocolException::getErrorCode() const throw()
{
    return errorCode;
}
 
//------------------------------------------------------------------------------
 
inline bool ProtocolException::getParameter(long& param) const throw()
{
    if (hasParameter) param = parameter;
    return hasParameter;
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline NotConnectedException::NotConnectedException() throw() :
    Exception("xplra::NotConnectedException: not connected to the simulator")
{
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline TypeMismatchException::TypeMismatchException() throw() :
    Exception("xplra::TypeMismatchException")
{
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline InvalidIDException::InvalidIDException() throw() :
    Exception("xplra::InvalidIDException")
{
}
 
//------------------------------------------------------------------------------
 
} /* namespace hu::varadiistvan::xplra */ } /* namespace hu::varadiistvan */ } /* namespace hu */
 
//------------------------------------------------------------------------------
#endif // HU_VARADIISTVAN_XPLRA_EXCEPTION_H
 
// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: