/*************************************************************************** $RCSfile: cterror.h,v $ ------------------- cvs : $Id: cterror.h,v 1.4 2003/01/10 20:02:15 aquamaniac Exp $ begin : Tue Aug 28 2001 copyright : (C) 2001 by Martin Preuss email : martin@libchipcard.de */ /*************************************************************************** * * * 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 * * * ***************************************************************************/ /* Changes */ #ifndef CTERROR_H #define CTERROR_H class CTError; #include /* these errors are directly returned by CTAPI drivers * all other drivers will map their error codes to these codes */ #define k_CTERROR_OK 0 #define k_CTERROR_INVALID_D -1 #define k_CTERROR_CT -8 #define k_CTERROR_TRANS -10 #define k_CTERROR_MEMORY -11 #define k_CTERROR_HTSI -128 #define k_CTERROR_PARAM 10 #define k_CTERROR_INVALID 11 #define k_CTERROR_NULL 12 #define k_CTERROR_NETWORK 14 #define k_CTERROR_LOCK 15 #define k_CTERROR_DRIVER 16 #define k_CTERROR_LIBLOADER 17 #define k_CTERROR_POINTER 18 #define k_CTERROR_DEBUG 19 #define k_CTERROR_FILE 20 #define k_CTERROR_IMPL 21 #define k_CTERROR_AUTH 22 #define k_CTERROR_SERVICE 23 #define k_CTERROR_API 24 #include using namespace std; /** * You can use this one to return an error code or you can throw * an object of this class. This class holds information about errors, like * * @short This class can be used to flag errors. * @author Martin Preuss * @ingroup status */ class CHIPCARD_API CTError { private: string _where; unsigned char _code; unsigned char _subcode1; unsigned char _subcode2; string _info; string _explanation; string _reportedFrom; string _textFromCode(unsigned char code, unsigned char sw1, unsigned char sw2); string _num2string(int n, const string &format="%d"); int _string2num(const string &n, const string &format="%d"); public: /** * Use this constructor if an error occurred. * @author Martin Preuss * @param where the location of the error, e.g. "CTError::isOk()" * @param info additional information about the error. * @param code error code, this can be one defined in CTTerminal, like: *
    *
  • k_CTERROR_INVALID
    • *
  • k_CTERROR_CT
    • *
  • k_CTERROR_TRANS
    • *
  • k_CTERROR_MEMORY
    • *
  • k_CTERROR_HTSI
    • *
* @param subcode1 this is the first CTAPI return code. this and subcode2 * are returned if the code shows "k_CTERROR_OK". This code holds the * major code, while subcode2 is more specific about the error. (SW1) * @param subcode2 this is the second CTAPI return code (SW2) * @param info additional information * @param explanation Here you can explan the error. If this is omitted * then this class will try to provide an explanation of its own. */ CTError(const string &where, unsigned char code, unsigned char subcode1, unsigned char subcode2, const string &info="", const string &explanation=""); CTError(const string &where, const CTError &err); /** * Use this constructor if NO error occurred. This way you can return * more complex return values. The caller may ask this object with * @ref isOk() to determine if an error occurred. * @author Martin Preuss */ CTError(); ~CTError(); /** * Tells you if this object shows an error or if all was ok. * You may give additional values for subcode1 and subcode2 which are to * be treated "OK". This is needed, when checking the result of * @ref CTCard::closeCard(), which sometimes returns SW1=0x62, thus * showing that no card is inserted. Well, this is an error on all other * methods, but when calling closeCard() this result is desired. * So for checking the result of closeCard() use this: * err.isOk(0x62); * @param ad1 subcode1 to be treated ok * @param ad2 subcode2 to be treated ok when occuring together with * ad1 * @author Martin Preuss * @return true if there was no error, false otherwise */ bool isOk(unsigned char ad1=0, unsigned char ad2=0); /** * Return the location of the error, e.g. "CTError::CTError()". * @author Martin Preuss */ const string &where() const {return _where; }; /** * Returns the error code * @author Martin Preuss */ int code() const { return _code; }; /** * Returns subcode1 * @author Martin Preuss */ int subcode1() const { return _subcode1; }; /** * Returns subcode2 * @author Martin Preuss */ int subcode2() const { return _subcode2; }; /** * Returns additional info about the error. * @author Martin Preuss */ const string &info() const { return _info; }; /** * Returns a short explanation of tis error. * @author Martin Preuss */ const string &explanation() const { return _explanation;}; /** * Returns a short error string containing all important information. * @author Martin Preuss */ string errorString(); /** * Returns the path of methods/functions which reported this error. */ const string &reportedFrom() const { return _reportedFrom;}; }; #endif