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"
61 class EventACallee final
64 void callback(EventA /*a*/) { notifiedEventA_ = true; };
66 bool notifiedEventA() { return notifiedEventA_; }
69 bool notifiedEventA_ = false;
72 class EventBCallee final
75 void callback(EventB* /* bPointer */) { notifiedEventB_ = true; };
77 bool notifiedEventB() { return notifiedEventB_; }
80 bool notifiedEventB_ = false;
83 class EventAandBCallee final
86 void notify(EventB* /* bPointer */) { notifiedEventB_ = true; };
88 void callback(EventA /* a */) { notifiedEventA_ = true; };
90 bool notifiedEventB() { return notifiedEventB_; }
91 bool notifiedEventA() { return notifiedEventA_; }
94 bool notifiedEventB_ = false;
95 bool notifiedEventA_ = false;
98 TEST(MDModuleNotificationTest, addConsumer)
100 registerMdModuleNotification<EventA>::type notifications;
101 EventACallee eventACallee;
103 EXPECT_FALSE(eventACallee.notifiedEventA());
105 notifications.subscribe([&eventACallee](EventA eventA) { eventACallee.callback(eventA); });
106 notifications.notify(EventA{});
108 EXPECT_TRUE(eventACallee.notifiedEventA());
111 TEST(MDModuleNotificationTest, addConsumerWithPointerParameter)
113 registerMdModuleNotification<EventB*>::type notifications;
114 EventBCallee eventBCallee;
116 EXPECT_FALSE(eventBCallee.notifiedEventB());
118 notifications.subscribe([&eventBCallee](EventB* eventB) { eventBCallee.callback(eventB); });
119 EventB* eventBPointer = nullptr;
120 notifications.notify(eventBPointer);
122 EXPECT_TRUE(eventBCallee.notifiedEventB());
125 TEST(MDModuleNotificationTest, addTwoDifferentConsumers)
127 registerMdModuleNotification<EventA, EventB*>::type notifications;
128 EventBCallee eventBCallee;
129 EventACallee eventACallee;
131 EXPECT_FALSE(eventACallee.notifiedEventA());
132 EXPECT_FALSE(eventBCallee.notifiedEventB());
134 notifications.subscribe([&eventBCallee](EventB* eventB) { eventBCallee.callback(eventB); });
135 notifications.subscribe([&eventACallee](EventA eventA) { eventACallee.callback(eventA); });
137 EventB* eventBPointer = nullptr;
138 notifications.notify(eventBPointer);
140 EXPECT_FALSE(eventACallee.notifiedEventA());
141 EXPECT_TRUE(eventBCallee.notifiedEventB());
143 notifications.notify(EventA{});
145 EXPECT_TRUE(eventACallee.notifiedEventA());
146 EXPECT_TRUE(eventBCallee.notifiedEventB());
149 TEST(MDModuleNotificationTest, consumerOfTwoResources)
151 registerMdModuleNotification<EventA, EventB*>::type notifications;
153 EventAandBCallee callee;
155 EXPECT_FALSE(callee.notifiedEventB());
156 EXPECT_FALSE(callee.notifiedEventA());
158 // requires a template parameter here, because call is ambiguous otherwise
159 notifications.subscribe([&callee](EventA msg) { callee.callback(msg); });
160 notifications.subscribe([&callee](EventB* msg) { callee.notify(msg); });
162 EventB* eventBp = nullptr;
164 notifications.notify(eventBp);
166 EXPECT_FALSE(callee.notifiedEventA());
167 EXPECT_TRUE(callee.notifiedEventB());
169 notifications.notify(EventA{});
171 EXPECT_TRUE(callee.notifiedEventA());
172 EXPECT_TRUE(callee.notifiedEventB());