encoder.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: encoder.hh,v 1.5 2008/12/18 03:23:30 jdratlif Exp $
00024 
00025 #ifndef GGENCODER_ENCODER_HH_
00026 #define GGENCODER_ENCODER_HH_
00027 
00028 namespace ggencoder {
00029     class GBGGGameGenieCode;
00030     class GBGGRawCode;
00031     class GenesisGameGenieCode;
00032     class GenesisRawCode;
00033     class NESGameGenieCode;
00034     class NESRawCode;
00035     class SNESGameGenieCode;
00036     class SNESRawCode;
00037     
00038     /**
00039      * A class to encode raw/PAR codes into Game Genie codes.
00040      */
00041     class Encoder {
00042     private:
00043         /**
00044          * Constructor for an Encoder. Private to prevent instantiation.
00045          */
00046         Encoder();
00047         
00048     public:
00049         /**
00050          * Encodes a GBGGRawCode into a GameGenieCode.
00051          *
00052          * @param code The GBGGRawCode.
00053          *
00054          * @return The encoded GameGenieCode.
00055          */
00056         static GBGGGameGenieCode encode(const GBGGRawCode &code);
00057         
00058         /**
00059          * Encodes a GenesisRawCode into a GameGenieCode.
00060          *
00061          * @param code The GenesisRawCode.
00062          *
00063          * @return The encoded GameGenieCode.
00064          */
00065         static GenesisGameGenieCode encode(const GenesisRawCode &code);
00066         
00067         /**
00068          * Encodes an NESRawCode into a GameGenieCode.
00069          *
00070          * @param code The NESRawCode.
00071          *
00072          * @return The encoded GameGenieCode.
00073          */
00074         static NESGameGenieCode encode(const NESRawCode &code);
00075 
00076         /**
00077          * Encodes an SNESRawCode into a GameGenieCode.
00078          *
00079          * @param code The SNESRawCode.
00080          *
00081          * @return The encoded GameGenieCode.
00082          */
00083         static SNESGameGenieCode encode(const SNESRawCode &code);
00084     };
00085     
00086     inline Encoder::Encoder() {}
00087 }
00088 
00089 #endif
00090 

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