RangeFilter.hh

Go to the documentation of this file.

// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// (c) Copyright Rosetta Commons Member Institutions.
// (c) This file is part of the Rosetta software suite and is made available under license.
// (c) The Rosetta software is developed by the contributing members of the Rosetta Commons.
// (c) For more information, see http://www.rosettacommons.org. Questions about this can be
// (c) addressed to University of Washington UW TechTransfer, email: license@u.washington.edu.

/// @file ./src/protocols/simple_filters/RangeFilter.hh
/// @brief Range filter evaluates if the return value of a particular filter is between a specific range
/// @detailed
/// @author Javier Castellanos (javiercv@uw.edu)


#ifndef INCLUDED_protocols_simple_filters_RangeFilter_hh
#define INCLUDED_protocols_simple_filters_RangeFilter_hh

// Unit Headers
#include <protocols/simple_filters/RangeFilter.fwd.hh>

// Package Headers
#include <protocols/filters/Filter.hh>

// Project Headers
#include <core/pose/Pose.fwd.hh>

// Utility headers

// Parser headers
#include <protocols/moves/DataMap.fwd.hh>
#include <protocols/moves/Mover.fwd.hh>
#include <protocols/filters/Filter.fwd.hh>
#include <utility/tag/Tag.fwd.hh>

#include <utility/vector1.hh>


//// C++ headers

namespace protocols {
namespace simple_filters {

class RangeFilter : public protocols::filters::Filter {
public:

  typedef protocols::filters::Filter Super;
  typedef protocols::filters::Filter Filter;
  typedef protocols::filters::FilterOP FilterOP;
  typedef core::Real Real;
  typedef core::pose::Pose Pose;
  typedef std::string String;

  typedef utility::tag::TagPtr TagPtr;
  typedef protocols::filters::Filters_map Filters_map;
  typedef protocols::moves::DataMap DataMap;
  typedef protocols::moves::Movers_map Movers_map;


public:// constructor/destructor


  // @brief default constructor
  RangeFilter();

  // @brief default constructor
  RangeFilter(Real lower_bound, Real upper_bound, const FilterOP & filter);

  // @brief copy constructor
  RangeFilter( RangeFilter const & rval );

  virtual ~RangeFilter(){}


public:// virtual constructor


  // @brief make clone
  virtual filters::FilterOP clone() const { return new RangeFilter( *this ); }

  // @brief make fresh instance
  virtual filters::FilterOP fresh_instance() const {  return new RangeFilter(); }


public:// mutator


public:// accessor


  // @brief get name of this filter
  virtual std::string name() const { return "RangeFilter"; }



public:// parser

  virtual void parse_my_tag( TagPtr const tag,
                             DataMap &,
                             filters::Filters_map const &,
                             Movers_map const &,
                             Pose const & );


public:// virtual main operation


  // @brief returns true if the given pose passes the filter, false otherwise.
  // In this case, the test is whether the give pose is the topology we want.
  virtual bool apply( Pose const & pose ) const;

  /// @brief used to report score
  virtual void report( std::ostream & out, Pose const & pose ) const;

private:
  FilterOP filter_;
  Real lower_bound_, upper_bound_;

};

} // filters
} // protocols

#endif