IMP  2.0.1
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 /** Do not use, simply use IMP_OBJECT_METHODS() and declare
16  - IMP::core::PeriodicOptimizerState::do_update()
17  */
18 #define IMP_CORE_PERIODIC_OPTIMIZER_STATE(Name) \
19  /** do a periodic update of Name
20 
21  @param call_num the number of times do_update() was called
22  since creation of Name or since last call to
23  reset()
24  */ \
25  IMP_IMPLEMENT(virtual void do_update(unsigned int call_num)); \
26  IMP_OBJECT(Name)
27 
28 
29 #endif /* IMPCORE_PERIODIC_OPTIMIZER_STATE_MACROS_H */