An instance of this type is created by the SubsetFilterTable::get_subset_filter method(). It's job is to reject some of the Assignments correspinding to the Subset it was created with. It has one method of interest, get_is_ok() which true if the state passes the filter.
The passed Assignment has the particles ordered in the same order as they were in the Subset that was passed to the table in order to create the filter.
Examples: custom filter
Inheritance diagram for IMP::domino::SubsetFilter:Public Member Functions | |
| SubsetFilter (std::string name="SubsetFilter%1%") | |
| virtual bool | get_is_ok (const Assignment &state) const =0 |
| virtual int | get_next_state (int pos, const Assignment &state) const |
| Return a next possible acceptable state for the particle in pos. | |
Public Member Functions inherited from IMP::base::Object | |
| std::size_t | __hash__ () const |
| virtual std::string | get_type_name () const =0 |
| Return a string identifying the type of the object. | |
| virtual IMP::base::VersionInfo | get_version_info () const =0 |
| Get information about the module and version of the object. | |
| void | set_check_level (CheckLevel l) |
| void | set_log_level (LogLevel l) |
| Set the logging level used in this object. | |
| void | set_was_used (bool tf) const |
| void | show (std::ostream &out=std::cout) const |
| const std::string & | get_name () const |
| void | set_name (std::string name) |
Additional Inherited Members | |
Protected Member Functions inherited from IMP::base::Object | |
| Object (std::string name) | |
|
pure virtual |
Return true if the given state passes this filter for the Subset it was created with
|
virtual |
Return a next possible acceptable state for the particle in pos.
The default implementation returns the current value +1. This method needs to make sure it does not skip any valid states.
The method can assume !get_is_ok(state) and that the state minus pos is ok.