Line data    Source code

       1             : /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
       2             :    Copyright (c) 2011-2023 The plumed team
       3             :    (see the PEOPLE file at the root of the distribution for a list of names)
       4             : 
       5             :    See http://www.plumed.org for more information.
       6             : 
       7             :    This file is part of plumed, version 2.
       8             : 
       9             :    plumed is free software: you can redistribute it and/or modify
      10             :    it under the terms of the GNU Lesser General Public License as published by
      11             :    the Free Software Foundation, either version 3 of the License, or
      12             :    (at your option) any later version.
      13             : 
      14             :    plumed is distributed in the hope that it will be useful,
      15             :    but WITHOUT ANY WARRANTY; without even the implied warranty of
      16             :    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      17             :    GNU Lesser General Public License for more details.
      18             : 
      19             :    You should have received a copy of the GNU Lesser General Public License
      20             :    along with plumed.  If not, see <http://www.gnu.org/licenses/>.
      21             : +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ */
      22             : #ifndef __PLUMED_core_ActionSet_h
      23             : #define __PLUMED_core_ActionSet_h
      24             : 
      25             : #include "Action.h"
      26             : #include "ActionShortcut.h"
      27             : #include <memory>
      28             : 
      29             : namespace PLMD {
      30             : 
      31             : class PlumedMain;
      32             : 
      33             : /// std::vector containing the sequence of Action to be done.
      34             : /// It is a vector of Action*, and as such it has the entire
      35             : /// std::vector interface. Moreover, it implements methods to extract
      36             : /// Acion* of a given type (select<T>()), NOT of a given type (selectNot<T>())
      37             : /// or to find an Action with a given label (selectWithLabel())
      38             : /// Finally, since it holds pointers, there is a clearDelete() function
      39             : /// which deletes the pointers before deleting the vector
      40             : class ActionSet:
      41             :   public std::vector<std::unique_ptr<Action>>
      42             : {
      43             :   PlumedMain& plumed;
      44             : public:
      45             :   explicit ActionSet(PlumedMain&p);
      46             :   ~ActionSet();
      47             : /// Clear and deletes all the included pointers.
      48             :   void clearDelete();
      49             : 
      50             : /// Extract pointers to all Action's of type T
      51             : /// To extract all Colvar , use select<Colvar*>();
      52             :   template <class T>
      53             :   std::vector<T> select()const;
      54             : /// Extract pointers to all Action's which are not of type T
      55             : /// E.g., to extract all noncolvars, use
      56             : ///    selectNot<Colvar*>();
      57             :   template <class T>
      58             :   std::vector<Action*> selectNot()const;
      59             : /// Extract pointer to an action labeled s, only if it is of
      60             : /// type T. E.g., to extract an action labeled "pippo", use selectWithLabel<Action*>("pippo")
      61             : /// If you want it to be a Colvar, use selectWithLabel<Colvar*>(pippo). If it is
      62             : /// not found, it returns NULL
      63             :   template <class T>
      64             :   T selectWithLabel(const std::string&s)const;
      65             : /// get the labels in the list of actions in form of a string (useful to debug)
      66             : /// Only classes that can be dynamic casted to T are reported
      67             :   template <class T>
      68             :   std::string getLabelList() const;
      69             : /// get the labels in the form of a vector of strings
      70             : /// Only classes that can be dynamic casted to T are reported
      71             :   template <class T>
      72             :   std::vector<std::string> getLabelVector() const;
      73             : /// Extract pointer to last action of type T located before
      74             : /// action. If action is not in ActionSet or if there is no action of type T
      75             : /// returns NULL.
      76             : /// Typically to be used as selectLatest<Type>(this);
      77             :   template <class T>
      78             :   T selectLatest(const Action*action)const;
      79             : /// Get any shortcuts with this shortcut label
      80             :   ActionShortcut* getShortcutActionWithLabel( const std::string& s ) const ;
      81             : };
      82             : 
      83             : /////
      84             : // INLINE IMPLEMENTATIONS:
      85             : 
      86             : template <class T>
      87      148118 : std::vector<T> ActionSet::select()const {
      88             :   std::vector<T> ret;
      89    87753350 :   for(const auto & p : (*this)) {
      90    87605232 :     T t=dynamic_cast<T>(p.get());
      91    87605232 :     if(t) ret.push_back(t);
      92             :   };
      93      148118 :   return ret;
      94             : }
      95             : 
      96             : template <class T>
      97     1534140 : T ActionSet::selectWithLabel(const std::string&s)const {
      98   162772517 :   for(const auto & p : (*this)) {
      99   133447458 :     T t=dynamic_cast<T>(p.get());
     100   162654612 :     if(t && t->getLabel()==s) return t;
     101             :   };
     102             :   return NULL;
     103             : }
     104             : 
     105             : template <class T>
     106             : std::vector<Action*> ActionSet::selectNot()const {
     107             :   std::vector<Action*> ret;
     108             :   for(const auto & p : (*this)) {
     109             :     T t=dynamic_cast<T>(p);
     110             :     if(!t) ret.push_back(p.get());
     111             :   };
     112             :   return ret;
     113             : }
     114             : 
     115             : template <class T>
     116           1 : std::string ActionSet::getLabelList() const {
     117             :   std::string outlist;
     118          16 :   for(const auto & p : (*this)) {
     119          26 :     if(dynamic_cast<T>(p.get())) outlist+=p->getLabel()+" ";
     120             :   };
     121           1 :   return  outlist;
     122             : }
     123             : 
     124             : 
     125             : template <class T>
     126             : std::vector<std::string> ActionSet::getLabelVector() const {
     127             :   std::vector<std::string> outlist;
     128             :   for(const auto & p : (*this)) {
     129             :     if(dynamic_cast<T>(p.get())) outlist.push_back(p->getLabel());
     130             :   };
     131             :   return  outlist;
     132             : }
     133             : 
     134             : template <class T>
     135        1100 : T ActionSet::selectLatest(const Action*action) const {
     136             :   T t=nullptr;
     137       37763 :   for(const auto & p : (*this)) {
     138       36691 :     if(p.get()==action) return t;
     139       36663 :     T r=dynamic_cast<T>(p.get());
     140       36663 :     if(r) t=r;
     141             :   }
     142             :   return t;
     143             : }
     144             : 
     145             : 
     146             : 
     147             : }
     148             : 
     149             : #endif
     150             :