2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2019, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS 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 GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
37 * Tests MdModuleNotification
39 * \author Christian Blau <blau@kth.se>
40 * \ingroup module_mdrun_integration_tests
44 #include <gmock/gmock.h>
46 #include "gromacs/utility/mdmodulenotification.h"
57 class EventACallee final
60 void callback(EventA /*a*/)
62 notifiedEventA_ = true;
65 bool notifiedEventA() { return notifiedEventA_; }
68 bool notifiedEventA_ = false;
71 class EventBCallee final
74 void callback(EventB * /* bPointer */)
76 notifiedEventB_ = true;
79 bool notifiedEventB() { return notifiedEventB_; }
82 bool notifiedEventB_ = false;
85 class EventAandBCallee final
88 void notify(EventB * /* bPointer */)
90 notifiedEventB_ = true;
93 void callback(EventA /* a */)
95 notifiedEventA_ = true;
98 bool notifiedEventB() { return notifiedEventB_; }
99 bool notifiedEventA() { return notifiedEventA_; }
102 bool notifiedEventB_ = false;
103 bool notifiedEventA_ = false;
106 TEST(MDModuleNotificationTest, addConsumer)
108 registerMdModuleNotification<EventA>::type notifications;
109 EventACallee eventACallee;
111 EXPECT_FALSE(eventACallee.notifiedEventA());
113 notifications.subscribe([&eventACallee](EventA eventA) { eventACallee.callback(eventA); });
114 notifications.notify(EventA {});
116 EXPECT_TRUE(eventACallee.notifiedEventA());
119 TEST(MDModuleNotificationTest, addConsumerWithPointerParameter)
121 registerMdModuleNotification<EventB *>::type notifications;
122 EventBCallee eventBCallee;
124 EXPECT_FALSE(eventBCallee.notifiedEventB());
126 notifications.subscribe([&eventBCallee](EventB * eventB) { eventBCallee.callback(eventB); });
127 EventB * eventBPointer = nullptr;
128 notifications.notify(eventBPointer);
130 EXPECT_TRUE(eventBCallee.notifiedEventB());
133 TEST(MDModuleNotificationTest, addTwoDifferentConsumers)
135 registerMdModuleNotification<EventA, EventB *>::type notifications;
136 EventBCallee eventBCallee;
137 EventACallee eventACallee;
139 EXPECT_FALSE(eventACallee.notifiedEventA());
140 EXPECT_FALSE(eventBCallee.notifiedEventB());
142 notifications.subscribe([&eventBCallee](EventB *eventB) { eventBCallee.callback(eventB); });
143 notifications.subscribe([&eventACallee](EventA eventA) { eventACallee.callback(eventA); });
145 EventB * eventBPointer = nullptr;
146 notifications.notify(eventBPointer);
148 EXPECT_FALSE(eventACallee.notifiedEventA());
149 EXPECT_TRUE(eventBCallee.notifiedEventB());
151 notifications.notify(EventA {});
153 EXPECT_TRUE(eventACallee.notifiedEventA());
154 EXPECT_TRUE(eventBCallee.notifiedEventB());
157 TEST(MDModuleNotificationTest, consumerOfTwoResources)
159 registerMdModuleNotification<EventA, EventB *>::type notifications;
161 EventAandBCallee callee;
163 EXPECT_FALSE(callee.notifiedEventB());
164 EXPECT_FALSE(callee.notifiedEventA());
166 // requires a template parameter here, because call is ambiguous otherwise
167 notifications.subscribe([&callee](EventA msg) { callee.callback(msg); });
168 notifications.subscribe([&callee](EventB *msg) { callee.notify(msg); });
170 EventB * eventBp = nullptr;
172 notifications.notify(eventBp);
174 EXPECT_FALSE(callee.notifiedEventA());
175 EXPECT_TRUE(callee.notifiedEventB());
177 notifications.notify(EventA {});
179 EXPECT_TRUE(callee.notifiedEventA());
180 EXPECT_TRUE(callee.notifiedEventB());