OgreHapticsException.h

Go to the documentation of this file.

/*
This source file is part of OgreHaptics
 (a library for wrapping haptics devices for use with the open-source
 graphics engine OGRE, http://www.ogre3d.org)

Copyright (c) 2006 - 2008 Jorrit de Vries
Also see acknowledgements in Readme.html

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License
as published by the Free Software Foundation; either version 2.1
of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the
Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
*/
// -- Based on Ogre::Exception, original copyright follows --
// 
// This source file is part of OGRE
//    (Object-oriented Graphics Rendering Engine)
// For the latest info, see http://www.ogre3d.org/
//
// Copyright (c) 2000-2006 Torus Knot Software Ltd
// Also see acknowledgements in Readme.html
//
// This program is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free Software
// Foundation; either version 2 of the License, or (at your option) any later
// version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License along with
// this program; if not, write to the Free Software Foundation, Inc., 59 Temple
// Place - Suite 330, Boston, MA 02111-1307, USA, or go to
// http://www.gnu.org/copyleft/lesser.txt.
//
// You may alternatively use this source under the terms of a specific version of
// the OGRE Unrestricted License provided you have obtained such a license from
// Torus Knot Software Ltd.
#ifndef _OgreHapticsException_H__
#define _OgreHapticsException_H__

#include "OgreHapticsPrerequisites.h"

namespace OgreHaptics {

    class _OgreHapticsExport Exception : public Ogre::Exception
    {
    public:
        enum ExceptionCodes
        {
            ERR_DUPLICATE_ITEM = 0x1101,
            ERR_HAPTICSAPI_ERROR,
            ERR_INTERNAL_ERROR,
            ERR_INVALID_ARGUMENTS,
            ERR_INVALID_OPERATION,
            ERR_ITEM_NOT_FOUND
        };
        Exception(int number, const String& description, const String& source);
        Exception(int number, const String& description, const String& source,
            const char* type, const char* file, long line);
            
        ~Exception() throw() {}

        virtual const String& getFullDescription(void) const;
    };

    class _OgreHapticsExport DuplicateItemException: public Exception
    {
    public:
        DuplicateItemException(int number, const String& description, const String& source, const char* file, long line)
            : Exception(number, description, source, "DuplicateItemException", file, line) {}
    };

    class _OgreHapticsExport HapticsAPIException : public Exception
    {
    public:
        HapticsAPIException(int number, const String& description, const String& source, const char* file, long line)
            : Exception(number, description, source, "HapticsAPIException", file, line) {}
    };

    class _OgreHapticsExport InternalErrorException : public Exception
    {
    public:
        InternalErrorException(int number, const String& description, const String& source, const char* file, long line)
            : Exception(number, description, source, "InternalErrorException", file, line) {}
    };

    class _OgreHapticsExport InvalidArgumentsException : public Exception
    {
    public:
        InvalidArgumentsException(int number, const String& description, const String& source, const char* file, long line)
            : Exception(number, description, source, "InvalidArgumentsException", file, line) {}
    };

    class _OgreHapticsExport InvalidOperationException : public Exception
    {
    public:
        InvalidOperationException(int number, const String& description, const String& source, const char* file, long line)
            : Exception(number, description, source, "InvalidOperationException", file, line) {}
    };

    class _OgreHapticsExport ItemNotFoundException : public Exception
    {
    public:
        ItemNotFoundException(int number, const String& description, const String& source, const char* file, long line)
            : Exception(number, description, source, "ItemNotFoundException", file, line) {}
    };

    class _OgreHapticsExport ExceptionFactory
    {
    public:
        static DuplicateItemException create(
            Ogre::ExceptionCodeType<Exception::ERR_DUPLICATE_ITEM> code,
            const String& desc,
            const String& src, const char* file, long line)
        {
            return DuplicateItemException(code.number, desc, src, file, line);
        };
        static HapticsAPIException create(
            Ogre::ExceptionCodeType<Exception::ERR_HAPTICSAPI_ERROR> code,
            const String& desc,
            const String& src, const char* file, long line)
        {
            return HapticsAPIException(code.number, desc, src, file, line);
        };
        static InternalErrorException create(
            Ogre::ExceptionCodeType<Exception::ERR_INTERNAL_ERROR> code,
            const String& desc,
            const String& src, const char* file, long line)
        {
            return InternalErrorException(code.number, desc, src, file, line);
        };
        static InvalidArgumentsException create(
            Ogre::ExceptionCodeType<Exception::ERR_INVALID_ARGUMENTS> code,
            const String& desc,
            const String& src, const char* file, long line)
        {
            return InvalidArgumentsException(code.number, desc, src, file, line);
        };
        static InvalidOperationException create(
            Ogre::ExceptionCodeType<Exception::ERR_INVALID_OPERATION> code,
            const String& desc,
            const String& src, const char* file, long line)
        {
            return InvalidOperationException(code.number, desc, src, file, line);
        };
        static ItemNotFoundException create(
            Ogre::ExceptionCodeType<Exception::ERR_ITEM_NOT_FOUND> code,
            const String& desc,
            const String& src, const char* file, long line)
        {
            return ItemNotFoundException(code.number, desc, src, file, line);
        };
    private:
        ExceptionFactory() {};
    };
}

#define OGREHAPTICS_EXCEPT(num, desc, src) throw OgreHaptics::ExceptionFactory::create( \
    Ogre::ExceptionCodeType<num>(), desc, src, __FILE__, __LINE__ );

#endif

---

Last modified Tue Jan 6 22:31:25 2009