Rosetta 3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Attributes | List of all members
protocols::fldsgn::filters::NcontactsFilter Class Reference

#include <NcontactsFilter.hh>

Inheritance diagram for protocols::fldsgn::filters::NcontactsFilter:
Inheritance graph
[legend]
Collaboration diagram for protocols::fldsgn::filters::NcontactsFilter:
Collaboration graph
[legend]

Public Types

typedef protocols::filters::Filter Super
 
typedef std::string String
 
typedef core::Size Size
 
typedef core::Real Real
 
typedef protocols::filters::Filter Filter
 
typedef
protocols::filters::FilterOP 
FilterOP
 
typedef core::pose::Pose Pose
 
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 Member Functions

 NcontactsFilter ()
 default constructor More...
 
 NcontactsFilter (String const &report_type, Real const filter_value)
 default constructor More...
 
 NcontactsFilter (NcontactsFilter const &rval)
 copy constructor More...
 
virtual ~NcontactsFilter ()
 destructor More...
 
virtual FilterOP clone () const
 make clone More...
 
virtual FilterOP fresh_instance () const
 make fresh instance More...
 
virtual std::string name () const
 get name of this filter More...
 
Real compute (Pose const &pose) const
 compute number of contacts More...
 
virtual Real report_sm (Pose const &pose) const
 used to report score More...
 
virtual void report (std::ostream &out, Pose const &pose) const
 used to report score More...
 
virtual bool apply (Pose const &pose) const
 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. More...
 
virtual void parse_my_tag (TagPtr const tag, DataMap &, Filters_map const &, Movers_map const &, Pose const &)
 parse xml More...
 
- 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)
 

Private Attributes

String report_type_
 
Real filter_value_
 

Additional Inherited Members

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

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::fldsgn::filters::NcontactsFilter::NcontactsFilter ( )

default constructor

Referenced by clone(), and fresh_instance().

protocols::fldsgn::filters::NcontactsFilter::NcontactsFilter ( String const &  report_type,
Real const  filter_value 
)

default constructor

protocols::fldsgn::filters::NcontactsFilter::NcontactsFilter ( NcontactsFilter const &  rval)

copy constructor

protocols::fldsgn::filters::NcontactsFilter::~NcontactsFilter ( )
virtual

destructor

Member Function Documentation

bool protocols::fldsgn::filters::NcontactsFilter::apply ( Pose const &  pose) const
virtual

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.

Implements protocols::filters::Filter.

References compute(), filter_value_, and protocols::filters::Filter::score().

virtual FilterOP protocols::fldsgn::filters::NcontactsFilter::clone ( ) const
inlinevirtual

make clone

Implements protocols::filters::Filter.

References NcontactsFilter().

NcontactsFilter::Real protocols::fldsgn::filters::NcontactsFilter::compute ( Pose const &  pose) const

compute number of contacts

comute ncontacts

References core::pose::metrics::StructureDependentCalculator::get(), and report_type_.

Referenced by apply(), report(), and report_sm().

virtual FilterOP protocols::fldsgn::filters::NcontactsFilter::fresh_instance ( ) const
inlinevirtual

make fresh instance

Implements protocols::filters::Filter.

References NcontactsFilter().

virtual std::string protocols::fldsgn::filters::NcontactsFilter::name ( ) const
inlinevirtual

get name of this filter

Reimplemented from protocols::filters::Filter.

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

parse xml

Reimplemented from protocols::filters::Filter.

References filter_value_, and report_type_.

void protocols::fldsgn::filters::NcontactsFilter::report ( std::ostream &  out,
Pose const &  pose 
) const
virtual

used to report score

Reimplemented from protocols::filters::Filter.

References compute().

NcontactsFilter::Real protocols::fldsgn::filters::NcontactsFilter::report_sm ( Pose const &  pose) const
virtual

used to report score

Reimplemented from protocols::filters::Filter.

References compute().

Member Data Documentation

Real protocols::fldsgn::filters::NcontactsFilter::filter_value_
private

Referenced by apply(), and parse_my_tag().

String protocols::fldsgn::filters::NcontactsFilter::report_type_
private

Referenced by compute(), and parse_my_tag().


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