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 class GeneOrder;
  25 /**
  26  * Abstraction of a sort action
  27  *
  28  * \author Michael Andreen
  29  */
  30 class SortAction{
  31         public:
  32
  33                 virtual ~SortAction(){};
  34
  35                 /**
  36                  * Applies the action on the GeneOrder and returning it.
  37                  */
  38                 virtual GeneOrder& operator()(GeneOrder& go) const{
  39                         return go;
  40                 }
  41
  42                 /**
  43                  * Compares sort actions.
  44                  */
  45                 virtual bool operator==(const SortAction& sa) const{
  46                         return false;
  47                 }
  48 };
  49
  50 #endif
  51