Exception.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: Exception
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/File.h>
#include "Exception.hpp"
 
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief An Exception that contains information about a runtime error with a particular File.
    This is typically thrown when an action with a file causes an error to occur within the NDEVR API
    **/
    class FileException : public Exception
    {
    public: 
        enum ExceptionType
        {
              e_generic
            , e_no_open
            , e_already_open
            , e_does_not_exist
            , e_file_exits
            , e_file_invalid
            , e_checksum_failed
            , e_not_supported
            , e_no_create
        };
        
    public:
        NDEVR_BASE_API explicit FileException(const File& file, ExceptionType type = e_generic);
        NDEVR_BASE_API FileException(const File& file, const TranslatedString& message, ExceptionType type = e_generic);
        const File& getFile() const { return m_file; }
        ExceptionType getType() const { return m_type; }
    private:
        void createDescription(const TranslatedString& message);
        File m_file;
        const ExceptionType m_type;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief An Exception thrown when the user cancels an operation.
    This is not a true error but designed to be used in control paths that allow users to cancel activities.
    **/
    class CancelException : public Exception
    {
    public:
        NDEVR_BASE_API CancelException(const TranslatedString& message);
    };
}