protocols::flxbb::FilterStructs Class Reference

#include <FilterStructs.hh>

Inheritance diagram for protocols::flxbb::FilterStructs:

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, core::Size const ntrial)
	value constructor More...
	FilterStructs (String const &name, Pose const &pose, core::Size const ntrial)
	value constructor More...
	FilterStructs (FilterStructs const &rval)
	copy constructor More...
	~FilterStructs () override
	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
core::Size	current_trial () const
PoseOP	get_bestpose () const
	return best pose More...
void	name (String const &name)
void	set_ntrial (core::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_
core::Size	ntrial_
core::Size	current_trial_
PoseOP	best_pose_

Member Typedef Documentation

Pose

typedef core::pose::Pose protocols::flxbb::FilterStructs::Pose

PoseOP

typedef core::pose::PoseOP protocols::flxbb::FilterStructs::PoseOP

Real

typedef core::Real protocols::flxbb::FilterStructs::Real

Size

typedef core::Size protocols::flxbb::FilterStructs::Size

String

typedef std::string protocols::flxbb::FilterStructs::String

Constructor & Destructor Documentation

FilterStructs() [1/5]

protocols::flxbb::FilterStructs::FilterStructs

(

)

default constructor

FilterStructs() [2/5]

protocols::flxbb::FilterStructs::FilterStructs

(

String const &

name

)

value constructor

FilterStructs() [3/5]

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

value constructor

FilterStructs() [4/5]

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

value constructor

FilterStructs() [5/5]

protocols::flxbb::FilterStructs::FilterStructs

(

FilterStructs const &

rval

)

copy constructor

References current_trial_.

~FilterStructs()

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

overridedefault

destructor

Member Function Documentation

apply()

virtual void protocols::flxbb::FilterStructs::apply ( Pose const &  )

pure virtual

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

clone()

FilterStructsOP protocols::flxbb::FilterStructs::clone ( ) const

virtual

clone this object

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

count_ntrial()

void protocols::flxbb::FilterStructs::count_ntrial ( )

protected

set ntrial

References current_trial_.

Referenced by protocols::flxbb::FilterStructs_Packstat::apply(), and protocols::flxbb::FilterStructs_TotalCharge::apply().

current_trial()

core::Size protocols::flxbb::FilterStructs::current_trial ( ) const

inline

References current_trial_.

filter_is_over()

bool protocols::flxbb::FilterStructs::filter_is_over ( )

protected

References current_trial_, and ntrial_.

Referenced by protocols::flxbb::FilterStructs_Packstat::apply(), and protocols::flxbb::FilterStructs_TotalCharge::apply().

filter_on()

bool protocols::flxbb::FilterStructs::filter_on ( ) const

inline

References filter_on_.

fresh_instance()

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.

get_bestpose()

pose::PoseOP protocols::flxbb::FilterStructs::get_bestpose

(

)

const

return best pose

References best_pose_.

initialize()

void protocols::flxbb::FilterStructs::initialize ( Pose const &  pose )

protected

References best_pose_, current_trial_, and set_filter_on().

Referenced by protocols::flxbb::FilterStructs_Packstat::reset(), and protocols::flxbb::FilterStructs_TotalCharge::reset().

name() [1/2]

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

inline

References name_.

Referenced by name().

name() [2/2]

void protocols::flxbb::FilterStructs::name

(

String const &

name

)

References name(), and name_.

reset()

virtual void protocols::flxbb::FilterStructs::reset ( Pose const &  )

pure virtual

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

set_bestpose()

void protocols::flxbb::FilterStructs::set_bestpose ( Pose const &  pose )

protected

set best pose

References best_pose_.

Referenced by protocols::flxbb::FilterStructs_Packstat::apply(), and protocols::flxbb::FilterStructs_TotalCharge::apply().

set_filter_off()

void protocols::flxbb::FilterStructs::set_filter_off ( )

inlineprotected

References filter_on_.

Referenced by protocols::flxbb::FilterStructs_Packstat::apply(), and protocols::flxbb::FilterStructs_TotalCharge::apply().

set_filter_on()

void protocols::flxbb::FilterStructs::set_filter_on ( )

inlineprotected

References filter_on_.

Referenced by initialize().

set_ntrial()

void protocols::flxbb::FilterStructs::set_ntrial

(

core::Size const

ntrial

)

set ntrial

References ntrial_.

Member Data Documentation

best_pose_

PoseOP protocols::flxbb::FilterStructs::best_pose_

private

Referenced by get_bestpose(), initialize(), and set_bestpose().

current_trial_

core::Size protocols::flxbb::FilterStructs::current_trial_

private

Referenced by count_ntrial(), current_trial(), filter_is_over(), FilterStructs(), and initialize().

filter_on_

bool protocols::flxbb::FilterStructs::filter_on_

private

Referenced by filter_on(), set_filter_off(), and set_filter_on().

name_

String protocols::flxbb::FilterStructs::name_

private

Referenced by name().

ntrial_

core::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:

• src/protocols/flxbb/FilterStructs.hh
• src/protocols/flxbb/FilterStructs.cc