LCOV - code coverage report
Current view: top level - core - ActionSet.h (source / functions) Hit Total Coverage
Test: plumed test coverage Lines: 13 13 100.0 %
Date: 2020-11-18 11:20:57 Functions: 14 18 77.8 %

          Line data    Source code
       1             : /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
       2             :    Copyright (c) 2011-2019 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             : 
      27             : namespace PLMD {
      28             : 
      29             : class PlumedMain;
      30             : 
      31             : /// std::vector containing the sequence of Action to be done.
      32             : /// It is a vector of Action*, and as such it has the entire
      33             : /// std::vector interface. Moreover, it implements methods to extract
      34             : /// Acion* of a given type (select<T>()), NOT of a given type (selectNot<T>())
      35             : /// or to find an Action with a given label (selectWithLabel())
      36             : /// Finally, since it holds pointers, there is a clearDelete() function
      37             : /// which deletes the pointers before deleting the vector
      38             : class ActionSet:
      39             :   public std::vector<Action*>
      40             : {
      41             :   PlumedMain& plumed;
      42             : public:
      43             :   explicit ActionSet(PlumedMain&p);
      44             :   ~ActionSet();
      45             : /// Clear and deletes all the included pointers.
      46             :   void clearDelete();
      47             : 
      48             : /// Extract pointers to all Action's of type T
      49             : /// To extract all Colvar , use select<Colvar*>();
      50             :   template <class T>
      51             :   std::vector<T> select()const;
      52             : /// Extract pointers to all Action's which are not of type T
      53             : /// E.g., to extract all noncolvars, use
      54             : ///    selectNot<Colvar*>();
      55             :   template <class T>
      56             :   std::vector<Action*> selectNot()const;
      57             : /// Extract pointer to an action labeled s, only if it is of
      58             : /// type T. E.g., to extract an action labeled "pippo", use selectWithLabel<Action*>("pippo")
      59             : /// If you want it to be a Colvar, use selectWithLabel<Colvar*>(pippo). If it is
      60             : /// not found, it returns NULL
      61             :   template <class T>
      62             :   T selectWithLabel(const std::string&s)const;
      63             : /// get the labels in the list of actions in form of a string (useful to debug)
      64             : /// Only classes that can be dynamic casted to T are reported
      65             :   template <class T>
      66             :   std::string getLabelList() const;
      67             : /// get the labels in the form of a vector of strings
      68             : /// Only classes that can be dynamic casted to T are reported
      69             :   template <class T>
      70             :   std::vector<std::string> getLabelVector() const;
      71             : };
      72             : 
      73             : /////
      74             : // INLINE IMPLEMENTATIONS:
      75             : 
      76             : template <class T>
      77        6770 : std::vector<T> ActionSet::select()const {
      78             :   std::vector<T> ret;
      79       63009 :   for(const auto & p : (*this)) {
      80       56239 :     T t=dynamic_cast<T>(p);
      81       56239 :     if(t) ret.push_back(t);
      82             :   };
      83        6770 :   return ret;
      84             : }
      85             : 
      86             : template <class T>
      87       33924 : T ActionSet::selectWithLabel(const std::string&s)const {
      88      175188 :   for(const auto & p : (*this)) {
      89      169731 :     T t=dynamic_cast<T>(p);
      90      323852 :     if(t && dynamic_cast<Action*>(t)->getLabel()==s) return t;
      91             :   };
      92             :   return NULL;
      93             : }
      94             : 
      95             : template <class T>
      96             : std::vector<Action*> ActionSet::selectNot()const {
      97             :   std::vector<Action*> ret;
      98             :   for(const auto & p : (*this)) {
      99             :     T t=dynamic_cast<T>(p);
     100             :     if(!t) ret.push_back(p);
     101             :   };
     102             :   return ret;
     103             : }
     104             : 
     105             : template <class T>
     106           1 : std::string ActionSet::getLabelList() const {
     107             :   std::string outlist;
     108           5 :   for(const auto & p : (*this)) {
     109          12 :     if(dynamic_cast<T>(p)) outlist+=p->getLabel()+" ";
     110             :   };
     111           1 :   return  outlist;
     112             : }
     113             : 
     114             : 
     115             : template <class T>
     116             : std::vector<std::string> ActionSet::getLabelVector() const {
     117             :   std::vector<std::string> outlist;
     118             :   for(const auto & p : (*this)) {
     119             :     if(dynamic_cast<T>(p)) outlist.push_back(p->getLabel());
     120             :   };
     121             :   return  outlist;
     122             : }
     123             : 
     124             : 
     125             : 
     126             : }
     127             : 
     128             : #endif
     129             : 

Generated by: LCOV version 1.13