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