src/sortaction.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Michael Andreen                                 *
   3  *   andreen@student.chalmers.se                                           *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA          *
  19  ***************************************************************************/
  20
  21 #ifndef __SORTACTION_H__
  22 #define __SORTACTION_H__
  23
  24 #include <tr1/memory>
  25 class GeneOrder;
  26 /**
  27  * Abstraction of a sort action, all child actions has to be immutable.
  28  *
  29  * \author Michael Andreen
  30  */
  31 class SortAction{
  32         public:
  33                 typedef std::tr1::shared_ptr<SortAction> ActionPointer;
  34
  35                 /**
  36                  * Creates a new sort action, given a specified action.
  37                  * SortAction promises to remove the given action.
  38                  */
  39                 SortAction(SortAction* sa): _action(sa){
  40                 }
  41
  42                 virtual ~SortAction(){};
  43
  44                 /**
  45                  * Applies the action on the GeneOrder and returning it.
  46                  */
  47                 virtual GeneOrder& operator()(GeneOrder& go) const{
  48                         return (*_action)(go);
  49                 }
  50
  51                 /**
  52                  * Compares sort actions.
  53                  */
  54                 virtual bool operator==(const SortAction& sa) const{
  55                         return (*_action) == (sa._action.get() == 0 ? sa : *sa._action);
  56                 }
  57         private:
  58                 ActionPointer _action;
  59
  60 };
  61
  62 #endif
  63