IMP  2.1.0
The Integrative Modeling Platform
periodic_optimizer_state_macros.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/periodic_optimizer_state_macros.h
3  * \brief Various important macros
4  * for implementing decorators.
5  *
6  * Copyright 2007-2013 IMP Inventors. All rights reserved.
7  *
8  */
9 
10 #ifndef IMPCORE_PERIODIC_OPTIMIZER_STATE_MACROS_H
11 #define IMPCORE_PERIODIC_OPTIMIZER_STATE_MACROS_H
12 
13 #include "PeriodicOptimizerState.h"
14 
15 IMPCORE_DEPRECATED_HEADER(
16  2.1, "Not needed any more, functionality is in OptimizerState")
17 
18 /** Do not use, simply use IMP_OBJECT_METHODS() and declare
19  - IMP::core::PeriodicOptimizerState::do_update()
20 */
21 #define IMP_CORE_PERIODIC_OPTIMIZER_STATE(Name) \
22  IMP_DEPRECATED_MACRO(2.1, "Just expand the macro in place instead"); \
23  /** do a periodic update of Name \
24  \
25  @param call_num the number of times do_update() was called \
26  since creation of Name or since last call to \
27  reset() \
28  */ \
29  virtual void do_update(unsigned int call_num) IMP_OVERRIDE; \
30  IMP_OBJECT_NO_WARNING(Name)
31 
32 #endif /* IMPCORE_PERIODIC_OPTIMIZER_STATE_MACROS_H */
Angle restraint between three particles.