decoder.hh

Go to the documentation of this file.
00001 /*
00002  * Game Genie Encoder/Decoder
00003  * Copyright (C) 2004-2006,2008 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: decoder.hh,v 1.7 2008/12/18 03:23:30 jdratlif Exp $
00024 
00025 #ifndef GGENCODER_DECODER_HH_
00026 #define GGENCODER_DECODER_HH_
00027 
00028 namespace ggencoder {
00029     class GameGenieCode;
00030     class GBGGRawCode;
00031     class GenesisRawCode;
00032     class NESRawCode;
00033     class SNESRawCode;
00034     
00035     /**
00036      * Class to decode game genie codes into raw/PAR codes.
00037      */
00038     class Decoder {
00039     private:
00040         /**
00041          * Private constructor to prevent instantiation.
00042          */
00043         Decoder();
00044         
00045     public:
00046         /**
00047          * Decodes Game Boy or Game Gear game genie code into a GBGGRawCode.
00048          *
00049          * @param code The game genie code.
00050          *
00051          * @return The decoded GBGGRawCode.
00052          */
00053         static GBGGRawCode decodeGBGG(const GameGenieCode &code);
00054         
00055         /**
00056          * Decodes Genesis game genie code into a GenesisRawCode.
00057          *
00058          * @param code The game genie code.
00059          *
00060          * @return The decoded GenesisRawCode.
00061          */
00062         static GenesisRawCode decodeGenesis(const GameGenieCode &code);
00063     
00064         /**
00065          * Decodes NES game genie code into an NESRawCode.
00066          *
00067          * @param code The game genie code.
00068          *
00069          * @return The decoded NESRawCode.
00070          */
00071         static NESRawCode decodeNES(const GameGenieCode &code);
00072         
00073         /**
00074          * Decodes SNES game genie code into an SNESRawCode.
00075          *
00076          * @param code The game genie code.
00077          *
00078          * @return The decoded SNESRawCode.
00079          */
00080         static SNESRawCode decodeSNES(const GameGenieCode &code);
00081     };
00082     
00083     inline Decoder::Decoder() {}
00084 }
00085 
00086 #endif
00087 

Generated on Thu Dec 18 01:01:24 2008 for Game Genie Encoder/Decoder by  doxygen 1.5.4