IMP: core_macros.h Source File

00001 /**
00002  *  \file core_macros.h    \brief Various important macros
00003  *                           for implementing decorators.
00004  *
00005  *  Copyright 2007-2010 IMP Inventors. All rights reserved.
00006  *
00007  */
00008 
00009 #ifndef IMPCORE_MACROS_H
00010 #define IMPCORE_MACROS_H
00011 
00012 /** Helper macro for implementing IMP::core::Mover. In
00013     addition to the IMP_OBJECT methods, it declares
00014     - IMP::core::Mover::propose_move()
00015     - IMP::core::Mover::accept_move()
00016     - IMP::core::Mover::reject_move()
00017  */
00018 #define IMP_MOVER(Name)                                 \
00019   virtual void propose_move(Float size);                \
00020   virtual void accept_move();                           \
00021   virtual void reject_move();                           \
00022   IMP_OBJECT(Name)
00023 
00024 /** Helper macro for implementing
00025     IMP::core::ClosePairsFinder objects. In addition to the
00026     IMP_OBJECT methods it declares:
00027     - IMP::core::get_close_pairs()
00028 */
00029 #define IMP_CLOSE_PAIRS_FINDER(Name)                                    \
00030   ParticlePairsTemp get_close_pairs(SingletonContainer *pc) const;      \
00031   ParticlePairsTemp get_close_pairs(SingletonContainer *pca,            \
00032                                     SingletonContainer *pcb) const;     \
00033   ParticlesTemp get_input_particles(SingletonContainer *pc) const;      \
00034   ParticlesTemp get_input_particles(SingletonContainer *a,              \
00035                                    SingletonContainer *b) const;        \
00036   ContainersTemp get_input_containers(SingletonContainer *pc) const;    \
00037   ContainersTemp get_input_containers(SingletonContainer *a,            \
00038                                    SingletonContainer *b) const;        \
00039   IMP_OBJECT(Name)
00040 
00041 #endif  /* IMPCORE_MACROS_H */