valentina/exception/vexceptionobjecterror.h
dismine 092417e6d8 Documentation for exceptions.
--HG--
branch : feature
2013-11-20 13:27:21 +02:00

109 lines
3.6 KiB
C++

/************************************************************************
**
** @file vexceptionobjecterror.h
** @author Roman Telezhinsky <dismine@gmail.com>
** @date November 15, 2013
**
** @brief
** @copyright
** This source code is part of the Valentine project, a pattern making
** program, whose allow create and modeling patterns of clothing.
** Copyright (C) 2013 Valentina project
** <https://bitbucket.org/dismine/valentina> All Rights Reserved.
**
** Valentina is free software: you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation, either version 3 of the License, or
** (at your option) any later version.
**
** Valentina 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 General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with Valentina. If not, see <http://www.gnu.org/licenses/>.
**
*************************************************************************/
#ifndef VEXCEPTIONOBJECTERROR_H
#define VEXCEPTIONOBJECTERROR_H
#include "vexception.h"
/**
* @brief The VExceptionObjectError class for exception object error
*/
class VExceptionObjectError : public VException
{
public:
/**
* @brief VExceptionObjectError exception object error
* @param what string with error
* @param domElement dom element
*/
VExceptionObjectError(const QString &what, const QDomElement &domElement);
/**
* @brief VExceptionObjectError copy constructor
* @param e exception
*/
VExceptionObjectError(const VExceptionObjectError &e)
:VException(e), tagText(e.TagText()), tagName(e.TagName()), lineNumber(e.LineNumber()),
moreInfo(e.MoreInformation()){}
virtual ~VExceptionObjectError() Q_DECL_NOEXCEPT_EXPR(true) {}
/**
* @brief ErrorMessage return main error message
* @return main error message
*/
virtual QString ErrorMessage() const;
/**
* @brief DetailedInformation return detailed information about error
* @return detailed information
*/
virtual QString DetailedInformation() const;
/**
* @brief TagText return tag text
* @return tag text
*/
inline QString TagText() const {return tagText;}
/**
* @brief TagName return tag name
* @return tag name
*/
inline QString TagName() const {return tagName;}
/**
* @brief LineNumber return line number in file
* @return line number
*/
inline qint32 LineNumber() const {return lineNumber;}
/**
* @brief AddMoreInformation add more information for error
* @param info information
*/
void AddMoreInformation(const QString &info);
/**
* @brief MoreInformation return more information for error
* @return information
*/
inline QString MoreInformation() const {return moreInfo;}
protected:
/**
* @brief tagText tag text
*/
QString tagText;
/**
* @brief tagName tag name
*/
QString tagName;
/**
* @brief lineNumber line number
*/
qint32 lineNumber;
/**
* @brief moreInfo more information about error
*/
QString moreInfo;
};
#endif // VEXCEPTIONOBJECTERROR_H