Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

gamegeniecode.hh

Go to the documentation of this file.
00001 /*
00002  * Game Genie Encoder/Decoder
00003  * Copyright (C) 2004-2005 emuWorks
00004  * http://games.technoplaza.net/
00005  *
00006  * This file is part of Game Genie Encoder/Decoder.
00007  *
00008  * Game Genie Encoder/Decoder is free software; you can redistribute it and/or
00009  * modify it under the terms of the GNU General Public License as published by
00010  * the Free Software Foundation; either version 2 of the License, or
00011  * (at your option) any later version.
00012  *
00013  * Game Genie Encoder/Decoder is distributed in the hope that it will be useful,
00014  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016  * GNU General Public License for more details.
00017  *
00018  * You should have received a copy of the GNU General Public License
00019  * along with Game Genie Encoder/Decoder; if not, write to the Free Software
00020  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00021  */
00022  
00023 // $Id: gamegeniecode.hh,v 1.5 2005/07/30 04:31:38 technoplaza Exp $
00024 
00025 #ifndef _GAMEGENIECODE_HH
00026 #define _GAMEGENIECODE_HH
00027 
00028 #include <QString>
00029 
00030 namespace emuWorks {
00031     /**
00032      * Interface for a Game Genie code.
00033      */
00034     class GameGenieCode {
00035     public:
00036         /**
00037          * Virtual destructor for a GameGenieCode.
00038          */
00039         virtual ~GameGenieCode() {}
00040     
00041         /**
00042          * Gets the game genie code.
00043          *
00044          * @return The game genie code.
00045          */
00046         QString getCode() { return code; }
00047         
00048         /**
00049          * Sets the game genie code.
00050          *
00051          * @param code The new game genie code.
00052          */
00053         void setCode(QString &code) { this->code = code.toUpper(); }
00054         
00055         /**
00056          * Gets the game genie alphabet.
00057          *
00058          * @return The genie alphabet array.
00059          */
00060         virtual const char *getAlphabet() = 0;
00061         
00062         /**
00063          * Gets the number of letters in the game genie alphabet.
00064          *
00065          * @return The alphabet letter count.
00066          */
00067         virtual int getAlphabetCount() { return 16; } 
00068         
00069         /**
00070          * Gets the corresponding hex value for a particular game genie letter.
00071          *
00072          * @param letter The game genie letter.
00073          *
00074          * @return The hex value of the letter or -1 if the letter is invalid.
00075          */
00076         virtual int toHex(char letter);
00077     protected:
00078         QString code;
00079     };
00080 }
00081 
00082 #endif
00083 

Generated on Sat Jul 30 15:01:51 2005 for Game Genie Encoder/Decoder by  doxygen 1.4.4