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

# taskedsimulationcreator.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 _TASKEDSIMULATIONCREATOR_H_
    00025 #define _TASKEDSIMULATIONCREATOR_H_
    00026
    00027 namespace lpzrobots
    00028 {
    00029
    00030   /**
    00031    * Defines a method to construct a TaskedSimulation. This method is needed by the
    00032    * SimulationTask, provided through the SimulationTaskSupervisor.
    00033    * If you like to get the singleton instance of SimulationTaskSupervisor, you have
    00034    * to pass as argument a deduced instance of the TaskedSimulationCreator.
    00035    */
    00036   class TaskedSimulationCreator
    00037   {
    00038   public:
    00039
    00040     /**
    00041      * Constructs and returns an instance of this class.
    00042      */
    00043     TaskedSimulationCreator() {}
    00044
    00045     /**
    00046      * Destroys the instance.
    00047      */
    00048     virtual ~TaskedSimulationCreator() {}
    00049
    00050     /**
    00051      * Builds (constructs) an instance of TaskedSimulation.
    00052      * This method must be overwritten by a deduced builder
    00053      * @return the builded instance with basic type TaskedSimulation
    00054      */
    00055     virtual TaskedSimulation* buildTaskedSimulationInstance() = 0;
    00056
    00057   };
    00058
    00059 }
    00060
    00061 #endif /* _TASKEDSIMULATIONCREATOR_H_ */