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