Rosetta Protocols  2014.35
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
protocols::flxbb::FilterStructs Class Referenceabstract

#include <FilterStructs.hh>

Public Types

typedef std::string String
 
typedef core::Real Real
 
typedef core::Size Size
 
typedef core::pose::Pose Pose
 
typedef core::pose::PoseOP PoseOP
 

Public Member Functions

 FilterStructs ()
 default constructor More...
 
 FilterStructs (String const &name)
 value constructor More...
 
 FilterStructs (String const &name, Size const ntrial)
 value constructor More...
 
 FilterStructs (String const &name, Pose const &pose, Size const ntrial)
 value constructor More...
 
 FilterStructs (FilterStructs const &rval)
 copy constructor More...
 
virtual ~FilterStructs ()
 destructor More...
 
virtual FilterStructsOP clone () const
 clone this object More...
 
virtual FilterStructsOP fresh_instance () const
 create a new instance of this type of object More...
 
virtual void apply (Pose const &)=0
 
virtual void reset (Pose const &)=0
 
String name () const
 
bool filter_on () const
 
Size current_trial () const
 
PoseOP get_bestpose () const
 return best pose More...
 
void name (String const &name)
 
void set_ntrial (Size const ntrial)
 set ntrial More...
 

Protected Member Functions

void initialize (Pose const &pose)
 
void set_filter_off ()
 
void set_filter_on ()
 
void count_ntrial ()
 set ntrial More...
 
bool filter_is_over ()
 
void set_bestpose (Pose const &pose)
 set best pose More...
 

Private Attributes

String name_
 
bool filter_on_
 
Size ntrial_
 
Size current_trial_
 
PoseOP best_pose_
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::flxbb::FilterStructs::FilterStructs ( )

default constructor

protocols::flxbb::FilterStructs::FilterStructs ( String const &  name)

value constructor

protocols::flxbb::FilterStructs::FilterStructs ( String const &  name,
Size const  ntrial 
)

value constructor

protocols::flxbb::FilterStructs::FilterStructs ( String const &  name,
Pose const &  pose,
Size const  ntrial 
)

value constructor

protocols::flxbb::FilterStructs::FilterStructs ( FilterStructs const &  rval)

copy constructor

References current_trial_.

protocols::flxbb::FilterStructs::~FilterStructs ( )
virtual

destructor

Member Function Documentation

virtual void protocols::flxbb::FilterStructs::apply ( Pose const &  )
pure virtual
FilterStructsOP protocols::flxbb::FilterStructs::clone ( ) const
virtual
void protocols::flxbb::FilterStructs::count_ntrial ( )
protected
Size protocols::flxbb::FilterStructs::current_trial ( ) const
inline

References current_trial_.

bool protocols::flxbb::FilterStructs::filter_is_over ( )
protected
bool protocols::flxbb::FilterStructs::filter_on ( ) const
inline
FilterStructsOP protocols::flxbb::FilterStructs::fresh_instance ( ) const
virtual

create a new instance of this type of object

Reimplemented in protocols::flxbb::FilterStructs_TotalCharge, and protocols::flxbb::FilterStructs_Packstat.

References utility_exit_with_message.

pose::PoseOP protocols::flxbb::FilterStructs::get_bestpose ( ) const

return best pose

References best_pose_.

Referenced by protocols::flxbb::FlxbbDesignPack::apply().

void protocols::flxbb::FilterStructs::initialize ( Pose const &  pose)
protected
String protocols::flxbb::FilterStructs::name ( ) const
inline

References name_.

Referenced by name().

void protocols::flxbb::FilterStructs::name ( String const &  name)

References name(), and name_.

virtual void protocols::flxbb::FilterStructs::reset ( Pose const &  )
pure virtual
void protocols::flxbb::FilterStructs::set_bestpose ( Pose const &  pose)
protected
void protocols::flxbb::FilterStructs::set_filter_off ( )
inlineprotected
void protocols::flxbb::FilterStructs::set_filter_on ( )
inlineprotected

References filter_on_.

Referenced by initialize().

void protocols::flxbb::FilterStructs::set_ntrial ( Size const  ntrial)

set ntrial

References ntrial_.

Member Data Documentation

PoseOP protocols::flxbb::FilterStructs::best_pose_
private
Size protocols::flxbb::FilterStructs::current_trial_
private
bool protocols::flxbb::FilterStructs::filter_on_
private
String protocols::flxbb::FilterStructs::name_
private

Referenced by name().

Size protocols::flxbb::FilterStructs::ntrial_
private

Referenced by filter_is_over(), and set_ntrial().


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