IMP logo
IMP Reference Guide  2.5.0
The Integrative Modeling Platform
EventSingletonsOptimizerState.h
Go to the documentation of this file.
1 // Autogenerated by ../../../../tmp/nightly-build-6636/imp-2.5.0/tools/build/make_containers.py
2 // from ../../../../tmp/nightly-build-6636/imp-2.5.0/tools/build/container_templates/container/EventClassnamesOptimizerState.h
3 // Do not edit - any changes will be lost!
4 
5 /**
6  * \file IMP/container/EventSingletonsOptimizerState.h
7  * \brief Define some predicates.
8  *
9  * Copyright 2007-2015 IMP Inventors. All rights reserved.
10  */
11 
12 #ifndef IMPCONTAINER_EVENT_SINGLETONS_OPTIMIZER_STATE_H
13 #define IMPCONTAINER_EVENT_SINGLETONS_OPTIMIZER_STATE_H
14 
15 #include <IMP/container/container_config.h>
16 #include <IMP/SingletonPredicate.h>
17 #include <IMP/OptimizerState.h>
18 #include <IMP/SingletonContainer.h>
19 
20 IMPCONTAINER_BEGIN_NAMESPACE
21 
22 /** Raise an IMP::EventException when a certain condition is met.
23  Currently the supported logic is when the number of items in the
24  container for which the predicate returns a certain value is in the
25  range [min_count, max_count).
26  */
27 class IMPCONTAINEREXPORT EventSingletonsOptimizerState : public OptimizerState {
28  IMP::PointerMember<SingletonPredicate> pred_;
29  IMP::PointerMember<SingletonContainer> container_;
30  int v_;
31  int min_, max_;
32 
33  public:
34  EventSingletonsOptimizerState(SingletonPredicate *pred,
35  SingletonContainerAdaptor container, int value,
36  int min_count, int max_count,
37  std::string name =
38  "ConstSingletonPredicate%1%");
39  virtual void update() IMP_OVERRIDE;
40  IMP_OBJECT_METHODS(EventSingletonsOptimizerState);
41 };
42 
43 IMPCONTAINER_END_NAMESPACE
44 
45 #endif /* IMPCONTAINER_EVENT_SINGLETONS_OPTIMIZER_STATE_H */
SingletonContainer.h
A container for Singletons.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
SingletonPredicate.h
Define SingletonPredicate.
IMP::PointerMember
A smart pointer to a ref-counted Object that is a class member.
Definition: Pointer.h:146
IMP::OptimizerState
Shared optimizer state that is invoked upon commitment of new coordinates.
Definition: OptimizerState.h:43
IMP::SingletonPredicate
Abstract predicate function.
Definition: SingletonPredicate.h:32
OptimizerState.h
Shared optimizer state.
IMP::OptimizerState::update
virtual void update()
Called when the Optimizer accepts a new conformation.
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:80