Rosetta Protocols  2014.35
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
protocols::indexed_structure_store::filters::FragmentLookupFilter Class Reference

#include <FragmentLookupFilter.hh>

Public Types

typedef
core::indexed_structure_store::FragmentLookupOP 
FragmentLookupOP
 
typedef
core::indexed_structure_store::FragmentLookupResult 
FragmentLookupResult
 
typedef
core::indexed_structure_store::FragmentSpecification 
FragmentSpecification
 
typedef core::Real Real
 
typedef core::Size Size
 
typedef core::pose::Pose Pose
 
typedef utility::tag::TagPtr TagPtr
 
typedef
protocols::filters::Filters_map 
Filters_map
 
typedef
protocols::filters::FilterOP 
FilterOP
 
typedef basic::datacache::DataMap DataMap
 
typedef
protocols::moves::Movers_map 
Movers_map
 

Public Member Functions

 FragmentLookupFilter (std::string lookup_name, LookupMode mode=First)
 Construct targeting the given named lookup in the default backend. More...
 
 FragmentLookupFilter (std::string lookup_name, std::string store_path, LookupMode mode=First, core::Size target_chain=0, core::Size threshold=0, bool b_target_chain=false)
 Construct targeting the given lookup in the given backend. More...
 
 FragmentLookupFilter (FragmentLookupFilter const &rval)
 
virtual ~FragmentLookupFilter ()
 
virtual FilterOP clone () const
 
virtual FilterOP fresh_instance () const
 
virtual std::string name () const
 
virtual bool apply (Pose const &pose) const
 Returns true if the given pose passes the filter, false otherwise. More...
 
virtual void parse_my_tag (utility::tag::TagCOP tag, DataMap &, Filters_map const &, Movers_map const &, Pose const &)
 
core::Size compute (core::pose::Pose const &pose) const
 
virtual void report (std::ostream &, core::pose::Pose const &) const
 
core::Real report_sm (core::pose::Pose const &pose) const
 used to report filter internals through a score or silent file More...
 
std::map< core::Size,
FragmentLookupResult > const & 
lookup_result ()
 
FragmentSpecification const & fragment_specification ()
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 Filter (Filter const &)
 
virtual ~Filter ()
 
virtual std::string get_type () const
 
std::string get_user_defined_name () const
 
void set_user_defined_name (std::string const &name)
 
virtual void clear ()
 used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...
 
virtual void apply (core::io::serialization::PipeMap &pmap)
 
virtual void score (core::io::serialization::PipeMap &pmap)
 
virtual core::Real score (core::pose::Pose &pose)
 
virtual void parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks)
 

Protected Member Functions

 FragmentLookupFilter ()
 

Private Attributes

FragmentLookupOP target_lookup_
 
std::map< core::Size,
FragmentLookupResult
cached_lookup_result_
 
LookupMode lookup_mode_
 
core::Size target_chain_
 
core::Size threshold_
 
bool b_target_chain_
 

Friends

class FragmentLookupFilterCreator
 

Additional Inherited Members

- Protected Attributes inherited from protocols::filters::Filter
std::string scorename_
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::indexed_structure_store::filters::FragmentLookupFilter::FragmentLookupFilter ( std::string  lookup_name,
LookupMode  mode = First 
)

Construct targeting the given named lookup in the default backend.

protocols::indexed_structure_store::filters::FragmentLookupFilter::FragmentLookupFilter ( std::string  lookup_name,
std::string  store_path,
LookupMode  mode = First,
core::Size  target_chain = 0,
core::Size  threshold = 0,
bool  b_target_chain = false 
)

Construct targeting the given lookup in the given backend.

protocols::indexed_structure_store::filters::FragmentLookupFilter::FragmentLookupFilter ( FragmentLookupFilter const &  rval)

References filters.

virtual protocols::indexed_structure_store::filters::FragmentLookupFilter::~FragmentLookupFilter ( )
inlinevirtual
protocols::indexed_structure_store::filters::FragmentLookupFilter::FragmentLookupFilter ( )
protected

Member Function Documentation

bool protocols::indexed_structure_store::filters::FragmentLookupFilter::apply ( Pose const &  pose) const
virtual

Returns true if the given pose passes the filter, false otherwise.

Implements protocols::filters::Filter.

References compute(), and threshold_.

virtual FilterOP protocols::indexed_structure_store::filters::FragmentLookupFilter::clone ( ) const
inlinevirtual
core::Size protocols::indexed_structure_store::filters::FragmentLookupFilter::compute ( core::pose::Pose const &  pose) const
FragmentSpecification const & protocols::indexed_structure_store::filters::FragmentLookupFilter::fragment_specification ( )

References target_lookup_.

virtual FilterOP protocols::indexed_structure_store::filters::FragmentLookupFilter::fresh_instance ( ) const
inlinevirtual
std::map<core::Size, FragmentLookupResult> const& protocols::indexed_structure_store::filters::FragmentLookupFilter::lookup_result ( )
inline

References cached_lookup_result_.

Referenced by compute().

virtual std::string protocols::indexed_structure_store::filters::FragmentLookupFilter::name ( ) const
inlinevirtual

Reimplemented from protocols::filters::Filter.

void protocols::indexed_structure_store::filters::FragmentLookupFilter::parse_my_tag ( utility::tag::TagCOP  tag,
DataMap ,
Filters_map const &  ,
Movers_map const &  ,
Pose const &   
)
virtual
void protocols::indexed_structure_store::filters::FragmentLookupFilter::report ( std::ostream &  os,
core::pose::Pose const &   
) const
virtual
core::Real protocols::indexed_structure_store::filters::FragmentLookupFilter::report_sm ( core::pose::Pose const &  ) const
virtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References cached_lookup_result_, core::pose::Pose::n_residue(), utility::json_spirit::pretty_print, and utility::json_spirit::write().

Friends And Related Function Documentation

friend class FragmentLookupFilterCreator
friend

Member Data Documentation

bool protocols::indexed_structure_store::filters::FragmentLookupFilter::b_target_chain_
private

Referenced by compute(), and parse_my_tag().

std::map<core::Size, FragmentLookupResult> protocols::indexed_structure_store::filters::FragmentLookupFilter::cached_lookup_result_
mutableprivate
LookupMode protocols::indexed_structure_store::filters::FragmentLookupFilter::lookup_mode_
private

Referenced by compute(), and parse_my_tag().

core::Size protocols::indexed_structure_store::filters::FragmentLookupFilter::target_chain_
private

Referenced by compute(), and parse_my_tag().

FragmentLookupOP protocols::indexed_structure_store::filters::FragmentLookupFilter::target_lookup_
private
core::Size protocols::indexed_structure_store::filters::FragmentLookupFilter::threshold_
private

Referenced by apply(), and parse_my_tag().


The documentation for this class was generated from the following files: