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 #include <string>
  26 class GeneOrder;
  27
  28
  29 class SortActionImpl{
  30         public:
  31
  32                 virtual ~SortActionImpl(){};
  33
  34                 /**
  35                  * Applies the action on the GeneOrder and returning it.
  36                  */
  37                 virtual GeneOrder& operator()(GeneOrder& go) const = 0;
  38
  39                 /**
  40                  * Compares sort actions.
  41                  */
  42                 virtual bool operator==(const SortActionImpl& sa) const = 0;
  43
  44                 /**
  45                  * Gives a string representation of the action, for output
  46                  */
  47                 virtual std::string toString() const = 0;
  48 };
  49
  50 /**
  51  * Abstraction of a sort action, all child actions has to be immutable.
  52  *
  53  * \author Michael Andreen
  54  */
  55 class SortAction{
  56         public:
  57                 typedef std::tr1::shared_ptr<SortActionImpl> ActionPointer;
  58
  59                 /**
  60                  * Creates a new sort action, given a specified action.
  61                  * SortAction promises to remove the given action.
  62                  */
  63                 SortAction(SortActionImpl* sa): _action(sa){
  64                 }
  65
  66                 SortAction(const SortAction& sa): _action(sa._action){
  67                 }
  68
  69                 const SortAction& operator=(const SortAction& sa){
  70                         if (this != &sa)
  71                                 _action = sa._action;
  72                         return *this;
  73                 }
  74
  75                 ~SortAction(){};
  76
  77                 /**
  78                  * Applies the action on the GeneOrder and returning it.
  79                  */
  80                 GeneOrder& operator()(GeneOrder& go) const{
  81                         return (*_action)(go);
  82                 }
  83
  84                 /**
  85                  * Compares sort actions.
  86                  */
  87                 bool operator==(const SortAction& sa) const{
  88                         return (*_action) == (*sa._action);
  89                 }
  90
  91                 /**
  92                  * Compares sort actions.
  93                  */
  94                 bool operator==(const SortActionImpl& sa) const{
  95                         return (*_action) == sa;
  96                 }
  97
  98                 /**
  99                  * Gives a string representation of the action, for output
 100                  */
 101                 std::string toString() const{
 102                         return _action->toString();
 103                 }
 104
 105                 /**
 106                  * Gives access to the implementation
 107                  */
 108                 const SortActionImpl& impl() const{
 109                         return *_action;
 110                 }
 111         private:
 112                 ActionPointer _action;
 113
 114 };
 115
 116 #endif
 117