Robot Simulator of the Robotics Group for Self-Organization of Control: storeable.h Source File

# storeable.h

Go to the documentation of this file.

    00001 /***************************************************************************
    00002  *   Copyright (C) 2005-2011 LpzRobots development team                    *
    00003  *    Georg Martius  <georg dot martius at web dot de>                     *
    00004  *    Frank Guettler <guettler at informatik dot uni-leipzig dot de        *
    00005  *    Frank Hesse    <frank at nld dot ds dot mpg dot de>                  *
    00006  *    Ralf Der       <ralfder at mis dot mpg dot de>                       *
    00007  *                                                                         *
    00008  *   This program is free software; you can redistribute it and/or modify  *
    00009  *   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  *   This program 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 this program; if not, write to the                         *
    00020  *   Free Software Foundation, Inc.,                                       *
    00021  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
    00022  *                                                                         *
    00023  ***************************************************************************/
    00024 #ifndef __STOREABLE_H
    00025 #define __STOREABLE_H
    00026
    00027 #include<stdio.h>
    00028
    00029 /**
    00030  * Interface for objects, that can be stored and restored to/from a file stream (binary).
    00031 */
    00032
    00033 class Storeable {
    00034 public:
    00035   virtual ~Storeable(){}
    00036   /** stores the object to the given file stream (binary).
    00037   */
    00038   virtual bool store(FILE* f) const = 0;
    00039
    00040   /** loads the object from the given file stream (binary).
    00041   */
    00042   virtual bool restore(FILE* f) = 0;
    00043
    00044   /** Provided for convenience.
    00045       Stores the object into a new file with the given filename (binary)
    00046    */
    00047   bool storeToFile(const char* filename) const;
    00048
    00049   /** Provided for convenience.
    00050       restores the object from the file given by filename (binary)
    00051    */
    00052   bool restoreFromFile(const char* filename);
    00053
    00054 };
    00055
    00056 #endif