/**
 *  \file domino2_macros.h    \brief Various important macros
 *                           for implementing decorators.
 *
 *  Copyright 2007-2010 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPDOMINO2_MACROS_H
#define IMPDOMINO2_MACROS_H

/** This macro declares
    - IMP::domino2::ParticleStates::get_number_of_states()
    - IMP::domino2::ParticleStates::load_state()
    and defines
    - IMP::domino2::after_set_current_particle() to be empty
*/
#define IMP_PARTICLE_STATES(Name)                                       \
  public:                                                               \
 virtual unsigned int get_number_of_particle_states() const;            \
 virtual void load_particle_state(unsigned int, Particle*) const;       \
 IMP_OBJECT(Name)


/** This macro declares
    - IMP::domino2::SubsetStateTable::get_subset_states()
*/
#define IMP_SUBSET_STATES_TABLE(Name)                                   \
  public:                                                               \
  virtual SubsetStates get_subset_states(const Subset&s) const;        \
  IMP_OBJECT(Name)


/** This macro declares
    - IMP::domino2::SubsetEvaluatorTable::get_subset_evaluator()
*/
#define IMP_SUBSET_EVALUATOR_TABLE(Name)                                \
  public:                                                               \
  virtual SubsetEvaluator* get_subset_evaluator(const Subset&s) const;  \
  IMP_OBJECT(Name)


/** This macro declares
    - IMP::domino2::Evaluator::get_score()
*/
#define IMP_SUBSET_EVALUATOR(Name)                             \
  public:                                                      \
 virtual double get_score(const SubsetState& state) const;     \
 IMP_OBJECT(Name)



/** This macro declares
    - IMP::domino2::SubsetFilterTable::get_subset_filter()
*/
#define IMP_SUBSET_FILTER_TABLE(Name)                                   \
  public:                                                               \
  virtual SubsetFilter* get_subset_filter(const Subset&s,               \
                                          const Subsets &excluded) const; \
  IMP_OBJECT(Name)


/** This macro declares
    - IMP::domino2::SubsetFilter::get_is_ok()
*/
#define IMP_SUBSET_FILTER(Name)                                \
  public:                                                      \
  virtual bool get_is_ok(const SubsetState& state) const;      \
  virtual double get_strength() const;                         \
 IMP_OBJECT(Name)


/** This macro declares
    - IMP::domino2::DiscreteSampler::do_get_sample_states()
*/
#define IMP_DISCRETE_SAMPLER(Name)                              \
  public:                                                       \
  SubsetStates do_get_sample_states(const Subset &known) const; \
  IMP_OBJECT(Name)


/** This macro declares:
    - IMP::domino2::SubsetGraphTable::get_subset_graph()
    - IMP::Object methods
 */
#define IMP_SUBSET_GRAPH_TABLE(Name)                            \
  public:                                                       \
SubsetGraph get_subset_graph(ParticleStatesTable *pst) const;   \
IMP_OBJECT(Name)

#endif  /* IMPDOMINO2_MACROS_H */