aw/valentina_old
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation for exceptions.

Browse Source 
--HG--
branch : feature
This commit is contained in:
dismine 2013-11-20 13:27:21 +02:00
parent 8d1146c1af
commit 092417e6d8
7 changed files with 128 additions and 128 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
exception/vexception.h
View File

@ -33,49 +33,49 @@
#include <QException> #include <QException>
/** /**
* @brief The VException class * @brief The VException class parent for all exception. Could be use for abstract exception
*/ */
class VException : public QException class VException : public QException
{ {
public: public:
/** /**
* @brief VException * @brief VException constructor exception
* @param what * @param what string with error
*/ */
VException(const QString &what); VException(const QString &what);
/** /**
* @brief VException * @brief VException copy constructor
* @param e * @param e exception
*/ */
VException(const VException &e):what(e.What()){} VException(const VException &e):what(e.What()){}
virtual ~VException() Q_DECL_NOEXCEPT_EXPR(true){} virtual ~VException() Q_DECL_NOEXCEPT_EXPR(true){}
/** /**
* @brief raise * @brief raise method raise for exception
*/ */
inline void raise() const { throw *this; } inline void raise() const { throw *this; }
/** /**
* @brief clone * @brief clone clone exception
* @return * @return new exception
*/ */
inline VException *clone() const { return new VException(*this); } inline VException *clone() const { return new VException(*this); }
/** /**
* @brief ErrorMessage * @brief ErrorMessage return main error message
* @return * @return error message
*/ */
virtual QString ErrorMessage() const; virtual QString ErrorMessage() const;
/** /**
* @brief DetailedInformation * @brief DetailedInformation return detailed information about error
* @return * @return detailed information
*/ */
virtual QString DetailedInformation() const { return QString(); } virtual QString DetailedInformation() const { return QString(); }
/** /**
* @brief What * @brief What return string with error
* @return * @return string with error
*/ */
inline QString What() const {return what;} inline QString What() const {return what;}
protected: protected:
/** /**
* @brief what * @brief what string with error
*/ */
QString what; QString what;
}; };

34
exception/vexceptionbadid.h
View File

@ -32,54 +32,54 @@
#include "vexception.h" #include "vexception.h"
/** /**
* @brief The VExceptionBadId class * @brief The VExceptionBadId class for exception bad id
*/ */
class VExceptionBadId : public VException class VExceptionBadId : public VException
{ {
public: public:
/** /**
* @brief VExceptionBadId * @brief VExceptionBadId exception bad id
* @param what * @param what string with error
* @param id * @param id id
*/ */
VExceptionBadId(const QString &what, const qint64 &id) VExceptionBadId(const QString &what, const qint64 &id)
:VException(what), id(id), key(QString()){} :VException(what), id(id), key(QString()){}
/** /**
* @brief VExceptionBadId * @brief VExceptionBadId exception bad id
* @param what * @param what string with error
* @param key * @param key string key
*/ */
VExceptionBadId(const QString &what, const QString &key) VExceptionBadId(const QString &what, const QString &key)
:VException(what), id(0), key(key){} :VException(what), id(0), key(key){}
/** /**
* @brief VExceptionBadId * @brief VExceptionBadId copy constructor
* @param e * @param e exception
*/ */
VExceptionBadId(const VExceptionBadId &e) VExceptionBadId(const VExceptionBadId &e)
:VException(e), id(e.BadId()), key(e.BadKey()){} :VException(e), id(e.BadId()), key(e.BadKey()){}
virtual ~VExceptionBadId() Q_DECL_NOEXCEPT_EXPR(true){} virtual ~VExceptionBadId() Q_DECL_NOEXCEPT_EXPR(true){}
/** /**
* @brief ErrorMessage * @brief ErrorMessage return main error message
* @return * @return main error message
*/ */
virtual QString ErrorMessage() const; virtual QString ErrorMessage() const;
/** /**
* @brief BadId * @brief BadId return bad id
* @return * @return id
*/ */
inline qint64 BadId() const {return id; } inline qint64 BadId() const {return id; }
/** /**
* @brief BadKey * @brief BadKey return bad key
* @return * @return key
*/ */
inline QString BadKey() const {return key; } inline QString BadKey() const {return key; }
protected: protected:
/** /**
* @brief id * @brief id id
*/ */
qint64 id; qint64 id;
/** /**
* @brief key * @brief key key
*/ */
QString key; QString key;
}; };

22
exception/vexceptionconversionerror.h
View File

@ -32,37 +32,37 @@
#include "vexception.h" #include "vexception.h"
/** /**
* @brief The VExceptionConversionError class * @brief The VExceptionConversionError class for exception of conversion error
*/ */
class VExceptionConversionError : public VException class VExceptionConversionError : public VException
{ {
public: public:
/** /**
* @brief VExceptionConversionError * @brief VExceptionConversionError exception conversion error
* @param what * @param what string with error
* @param str * @param str string, where happend error
*/ */
VExceptionConversionError(const QString &what, const QString &str); VExceptionConversionError(const QString &what, const QString &str);
/** /**
* @brief VExceptionConversionError * @brief VExceptionConversionError copy constructor
* @param e * @param e exception
*/ */
VExceptionConversionError(const VExceptionConversionError &e) VExceptionConversionError(const VExceptionConversionError &e)
:VException(e), str(e.String()){} :VException(e), str(e.String()){}
virtual ~VExceptionConversionError() Q_DECL_NOEXCEPT_EXPR(true) {} virtual ~VExceptionConversionError() Q_DECL_NOEXCEPT_EXPR(true) {}
/** /**
* @brief ErrorMessage * @brief ErrorMessage return main error message
* @return * @return main error message
*/ */
virtual QString ErrorMessage() const; virtual QString ErrorMessage() const;
/** /**
* @brief String * @brief String return string, where happend error
* @return * @return string
*/ */
inline QString String() const {return str;} inline QString String() const {return str;}
protected: protected:
/** /**
* @brief str * @brief str string, where happend error
*/ */
QString str; QString str;
}; };

46
exception/vexceptionemptyparameter.h
View File

@ -32,71 +32,71 @@
#include "vexception.h" #include "vexception.h"
/** /**
* @brief The VExceptionEmptyParameter class * @brief The VExceptionEmptyParameter class for exception empty parameter
*/ */
class VExceptionEmptyParameter : public VException class VExceptionEmptyParameter : public VException
{ {
public: public:
/** /**
* @brief VExceptionEmptyParameter * @brief VExceptionEmptyParameter exception empty parameter
* @param what * @param what string with error
* @param name * @param name name of attribute where error
* @param domElement * @param domElement dom element
*/ */
VExceptionEmptyParameter(const QString &what, const QString &name, const QDomElement &domElement); VExceptionEmptyParameter(const QString &what, const QString &name, const QDomElement &domElement);
/** /**
* @brief VExceptionEmptyParameter * @brief VExceptionEmptyParameter copy constructor
* @param e * @param e exception
*/ */
VExceptionEmptyParameter(const VExceptionEmptyParameter &e) VExceptionEmptyParameter(const VExceptionEmptyParameter &e)
:VException(e), name(e.Name()), tagText(e.TagText()), tagName(e.TagName()), :VException(e), name(e.Name()), tagText(e.TagText()), tagName(e.TagName()),
lineNumber(e.LineNumber()){} lineNumber(e.LineNumber()){}
virtual ~VExceptionEmptyParameter() Q_DECL_NOEXCEPT_EXPR(true) {} virtual ~VExceptionEmptyParameter() Q_DECL_NOEXCEPT_EXPR(true) {}
/** /**
* @brief ErrorMessage * @brief ErrorMessage return main error message
* @return * @return main error message
*/ */
virtual QString ErrorMessage() const; virtual QString ErrorMessage() const;
/** /**
* @brief DetailedInformation * @brief DetailedInformation return detailed information about error
* @return * @return detailed information
*/ */
virtual QString DetailedInformation() const; virtual QString DetailedInformation() const;
/** /**
* @brief Name * @brief Name return name of attribute where error
* @return * @return name
*/ */
inline QString Name() const {return name;} inline QString Name() const {return name;}
/** /**
* @brief TagText * @brief TagText return tag text
* @return * @return tag text
*/ */
inline QString TagText() const {return tagText;} inline QString TagText() const {return tagText;}
/** /**
* @brief TagName * @brief TagName return tag name
* @return * @return tag name
*/ */
inline QString TagName() const {return tagName;} inline QString TagName() const {return tagName;}
/** /**
* @brief LineNumber * @brief LineNumber return line number of tag
* @return * @return line number
*/ */
inline qint32 LineNumber() const {return lineNumber;} inline qint32 LineNumber() const {return lineNumber;}
protected: protected:
/** /**
* @brief name * @brief name name attribute
*/ */
QString name; QString name;
/** /**
* @brief tagText * @brief tagText tag text
*/ */
QString tagText; QString tagText;
/** /**
* @brief tagName * @brief tagName tag name
*/ */
QString tagName; QString tagName;
/** /**
* @brief lineNumber * @brief lineNumber line number
*/ */
qint32 lineNumber; qint32 lineNumber;
}; };

48
exception/vexceptionobjecterror.h
View File

@ -32,75 +32,75 @@
#include "vexception.h" #include "vexception.h"
/** /**
* @brief The VExceptionObjectError class * @brief The VExceptionObjectError class for exception object error
*/ */
class VExceptionObjectError : public VException class VExceptionObjectError : public VException
{ {
public: public:
/** /**
* @brief VExceptionObjectError * @brief VExceptionObjectError exception object error
* @param what * @param what string with error
* @param domElement * @param domElement dom element
*/ */
VExceptionObjectError(const QString &what, const QDomElement &domElement); VExceptionObjectError(const QString &what, const QDomElement &domElement);
/** /**
* @brief VExceptionObjectError * @brief VExceptionObjectError copy constructor
* @param e * @param e exception
*/ */
VExceptionObjectError(const VExceptionObjectError &e) VExceptionObjectError(const VExceptionObjectError &e)
:VException(e), tagText(e.TagText()), tagName(e.TagName()), lineNumber(e.LineNumber()), :VException(e), tagText(e.TagText()), tagName(e.TagName()), lineNumber(e.LineNumber()),
moreInfo(e.MoreInformation()){} moreInfo(e.MoreInformation()){}
virtual ~VExceptionObjectError() Q_DECL_NOEXCEPT_EXPR(true) {} virtual ~VExceptionObjectError() Q_DECL_NOEXCEPT_EXPR(true) {}
/** /**
* @brief ErrorMessage * @brief ErrorMessage return main error message
* @return * @return main error message
*/ */
virtual QString ErrorMessage() const; virtual QString ErrorMessage() const;
/** /**
* @brief DetailedInformation * @brief DetailedInformation return detailed information about error
* @return * @return detailed information
*/ */
virtual QString DetailedInformation() const; virtual QString DetailedInformation() const;
/** /**
* @brief TagText * @brief TagText return tag text
* @return * @return tag text
*/ */
inline QString TagText() const {return tagText;} inline QString TagText() const {return tagText;}
/** /**
* @brief TagName * @brief TagName return tag name
* @return * @return tag name
*/ */
inline QString TagName() const {return tagName;} inline QString TagName() const {return tagName;}
/** /**
* @brief LineNumber * @brief LineNumber return line number in file
* @return * @return line number
*/ */
inline qint32 LineNumber() const {return lineNumber;} inline qint32 LineNumber() const {return lineNumber;}
/** /**
* @brief AddMoreInformation * @brief AddMoreInformation add more information for error
* @param info * @param info information
*/ */
void AddMoreInformation(const QString &info); void AddMoreInformation(const QString &info);
/** /**
* @brief MoreInformation * @brief MoreInformation return more information for error
* @return * @return information
*/ */
inline QString MoreInformation() const {return moreInfo;} inline QString MoreInformation() const {return moreInfo;}
protected: protected:
/** /**
* @brief tagText * @brief tagText tag text
*/ */
QString tagText; QString tagText;
/** /**
* @brief tagName * @brief tagName tag name
*/ */
QString tagName; QString tagName;
/** /**
* @brief lineNumber * @brief lineNumber line number
*/ */
qint32 lineNumber; qint32 lineNumber;
/** /**
* @brief moreInfo * @brief moreInfo more information about error
*/ */
QString moreInfo; QString moreInfo;
}; };

38
exception/vexceptionuniqueid.h
View File

@ -32,60 +32,60 @@
#include "vexception.h" #include "vexception.h"
/** /**
* @brief The VExceptionUniqueId class * @brief The VExceptionUniqueId class for exception unique id
*/ */
class VExceptionUniqueId : public VException class VExceptionUniqueId : public VException
{ {
public: public:
/** /**
* @brief VExceptionUniqueId * @brief VExceptionUniqueId exception unique id
* @param what * @param what string with error
* @param domElement * @param domElement dom element
*/ */
VExceptionUniqueId(const QString &what, const QDomElement &domElement); VExceptionUniqueId(const QString &what, const QDomElement &domElement);
/** /**
* @brief VExceptionUniqueId * @brief VExceptionUniqueId copy constructor
* @param e * @param e exception
*/ */
VExceptionUniqueId(const VExceptionUniqueId &e) VExceptionUniqueId(const VExceptionUniqueId &e)
:VException(e), tagText(e.TagText()), tagName(e.TagName()), lineNumber(e.LineNumber()){} :VException(e), tagText(e.TagText()), tagName(e.TagName()), lineNumber(e.LineNumber()){}
virtual ~VExceptionUniqueId() Q_DECL_NOEXCEPT_EXPR(true){} virtual ~VExceptionUniqueId() Q_DECL_NOEXCEPT_EXPR(true){}
/** /**
* @brief ErrorMessage * @brief ErrorMessage return main error message
* @return * @return main error message
*/ */
virtual QString ErrorMessage() const; virtual QString ErrorMessage() const;
/** /**
* @brief DetailedInformation * @brief DetailedInformation return detailed information about error
* @return * @return detailed information
*/ */
virtual QString DetailedInformation() const; virtual QString DetailedInformation() const;
/** /**
* @brief TagText * @brief TagText return tag text
* @return * @return tag text
*/ */
inline QString TagText() const {return tagText;} inline QString TagText() const {return tagText;}
/** /**
* @brief TagName * @brief TagName return tag name
* @return * @return tag name
*/ */
inline QString TagName() const {return tagName;} inline QString TagName() const {return tagName;}
/** /**
* @brief LineNumber * @brief LineNumber return line number in file
* @return * @return line number
*/ */
inline qint32 LineNumber() const {return lineNumber;} inline qint32 LineNumber() const {return lineNumber;}
protected: protected:
/** /**
* @brief tagText * @brief tagText tag text
*/ */
QString tagText; QString tagText;
/** /**
* @brief tagName * @brief tagName tag name
*/ */
QString tagName; QString tagName;
/** /**
* @brief lineNumber * @brief lineNumber line number
*/ */
qint32 lineNumber; qint32 lineNumber;
}; };

38
exception/vexceptionwrongparameterid.h
View File

@ -32,60 +32,60 @@
#include "vexception.h" #include "vexception.h"
/** /**
* @brief The VExceptionWrongParameterId class * @brief The VExceptionWrongParameterId class for exception wrong parameter id
*/ */
class VExceptionWrongParameterId : public VException class VExceptionWrongParameterId : public VException
{ {
public: public:
/** /**
* @brief VExceptionWrongParameterId * @brief VExceptionWrongParameterId exception wrong parameter id
* @param what * @param what string with error
* @param domElement * @param domElement som element
*/ */
VExceptionWrongParameterId(const QString &what, const QDomElement &domElement); VExceptionWrongParameterId(const QString &what, const QDomElement &domElement);
/** /**
* @brief VExceptionWrongParameterId * @brief VExceptionWrongParameterId copy constructor
* @param e * @param e exception
*/ */
VExceptionWrongParameterId(const VExceptionWrongParameterId &e) VExceptionWrongParameterId(const VExceptionWrongParameterId &e)
:VException(e), tagText(e.TagText()), tagName(e.TagName()), lineNumber(e.LineNumber()){} :VException(e), tagText(e.TagText()), tagName(e.TagName()), lineNumber(e.LineNumber()){}
virtual ~VExceptionWrongParameterId() Q_DECL_NOEXCEPT_EXPR(true){} virtual ~VExceptionWrongParameterId() Q_DECL_NOEXCEPT_EXPR(true){}
/** /**
* @brief ErrorMessage * @brief ErrorMessage return main error message
* @return * @return main error message
*/ */
virtual QString ErrorMessage() const; virtual QString ErrorMessage() const;
/** /**
* @brief DetailedInformation * @brief DetailedInformation return detailed information about error
* @return * @return detailed information
*/ */
virtual QString DetailedInformation() const; virtual QString DetailedInformation() const;
/** /**
* @brief TagText * @brief TagText return tag text
* @return * @return tag text
*/ */
inline QString TagText() const {return tagText;} inline QString TagText() const {return tagText;}
/** /**
* @brief TagName * @brief TagName return tag name
* @return * @return tag name
*/ */
inline QString TagName() const {return tagName;} inline QString TagName() const {return tagName;}
/** /**
* @brief LineNumber * @brief LineNumber return line number in file
* @return * @return line number
*/ */
inline qint32 LineNumber() const {return lineNumber;} inline qint32 LineNumber() const {return lineNumber;}
protected: protected:
/** /**
* @brief tagText * @brief tagText tag text
*/ */
QString tagText; QString tagText;
/** /**
* @brief tagName * @brief tagName tag name
*/ */
QString tagName; QString tagName;
/** /**
* @brief lineNumber * @brief lineNumber line number
*/ */
qint32 lineNumber; qint32 lineNumber;
}; };