A FilterMover that also calls report() on apply() More...

#include <FilterReporterMover.hh>

Inheritance diagram for protocols::moves::FilterReporterMover:

Public Member Functions
	FilterReporterMover ()

	FilterReporterMover (protocols::moves::MoverOP const &, protocols::filters::FilterOP const &, core::Size const, std::ostream &, protocols::moves::MoverStatus const =protocols::moves::FAIL_DO_NOT_RETRY)

	FilterReporterMover (FilterReporterMover const &)

	~FilterReporterMover ()

FilterReporterMover &	operator= (FilterReporterMover const &rhs)

virtual void	apply (core::pose::Pose &pose)

virtual protocols::moves::MoverOP	clone () const
	Return a clone of the Mover object. More...

virtual std::string	get_name () const
	Each derived class must specify its name. The class name. More...

virtual protocols::moves::MoverOP	fresh_instance () const
	Generates a new Mover object freshly created with the default ctor. More...

protocols::moves::MoverOP	get_mover () const

void	set_mover (protocols::moves::MoverOP const &mover)

protocols::filters::FilterOP	get_filter () const

void	set_filter (protocols::filters::FilterOP const &filter)

std::ostream &	get_out ()

void	set_out (std::ostream const &out)

Public Member Functions inherited from protocols::moves::Mover
	Mover ()

virtual	~Mover ()

virtual MoverOP	create ()

MoverCOP	get_self_ptr () const

MoverOP	get_self_ptr ()

MoverCAP	get_self_weak_ptr () const

MoverAP	get_self_weak_ptr ()

	Mover (std::string const &type_name)
	sets the type for a mover; name_ has been removed (2010/05/14) More...

	Mover (Mover const &other)

Mover &	operator= (Mover const &other)
	assignment operator More...

virtual core::Real	last_proposal_density_ratio ()

std::string const &	type () const

void	set_type (std::string const &setting)

std::string	get_current_tag () const
	A tag is a unique identifier used to identify structures produced by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor. More...

virtual void	set_current_tag (std::string const &new_tag)

virtual void	set_input_pose (PoseCOP pose)
	setter for poses contained for rms More...

virtual void	set_native_pose (PoseCOP pose)
	setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...

PoseCOP	get_input_pose () const

PoseCOP	get_native_pose () const

virtual void	test_move (Pose &pose)
	: Unit test support function. Apply one move to a given pose. Allows extra test specific functions to be called before applying More...

void	type (const std::string &type_in)

virtual void	parse_my_tag (TagCOP tag, basic::datacache::DataMap &data, Filters_map const &filters, Movers_map const &movers, Pose const &pose)
	Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...

std::string	get_type () const

MoverStatus	get_last_move_status () const
	end parser interface, start Job Distributor interface///////////// More...

void	reset_status ()
	resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s. More...

virtual core::pose::PoseOP	get_additional_output ()
	Mechanism by which a mover may return multiple output poses from a single input pose. More...

virtual void	clear_info ()
	Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file. More...

virtual Strings &	info ()
	non-const accessor More...

virtual Strings const &	info () const
	const accessor More...

virtual bool	reinitialize_for_each_job () const
	Inform the Job Distributor (August '08 vintage) whether this object needs to be freshly regenerated on each use. More...

virtual bool	reinitialize_for_new_input () const
	Inform the Job Distributor (August '08 vintage) whether this object needs to be regenerated when the input pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose). More...

void	set_current_job (protocols::jobdist::BasicJobCOP job)

jobdist::BasicJobCOP	get_current_job () const

virtual void	show (std::ostream &output=std::cout) const
	Outputs details about the Mover, including current settings. More...

Static Private Member Functions
static void	assign (FilterReporterMover &lhs, FilterReporterMover const &rhs)
	used by cctor and operator= to assign one such object to the other More...

Private Attributes
protocols::moves::MoverOP	mover_

protocols::filters::FilterOP	filter_

protocols::moves::FilterMoverOP	filter_mover_
	mixin inheritence of FilterMover More...

std::ostream	out_

Additional Inherited Members
Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagCOP	TagCOP

typedef core::pose::Pose	Pose

typedef core::pose::PoseCOP	PoseCOP

typedef protocols::filters::Filters_map	Filters_map

typedef std::list< std::string >	Strings

Static Public Member Functions inherited from protocols::moves::Mover
static std::string	name ()

static void	register_options ()
	Overload this static method if you access options within the mover. More...

Protected Member Functions inherited from protocols::moves::Mover
void	set_last_move_status (MoverStatus status)
	nonvirtual setter for MoverStatus last_status_. Protected means that only the mover itself will be able to change its own status. The job distributor (august 08 vintage) is aware of status set with this function and will do what the MoverStatus says. More...

Detailed Description

A FilterMover that also calls report() on apply()

Constructor & Destructor Documentation

protocols::moves::FilterReporterMover::FilterReporterMover ( )

References filter_mover_.

Referenced by clone().

protocols::moves::FilterReporterMover::FilterReporterMover	(	protocols::moves::MoverOP const &	mover,
		protocols::filters::FilterOP const &	filter,
		core::Size const	max_tries,
		std::ostream &	out,
		protocols::moves::MoverStatus const	mover_status = `protocols::moves::FAIL_DO_NOT_RETRY`
	)

References filter_mover_, and set_out().

protocols::moves::FilterReporterMover::FilterReporterMover ( FilterReporterMover const & rhs )

References assign().

protocols::moves::FilterReporterMover::~FilterReporterMover ( )

References filter_mover_.

Member Function Documentation

void protocols::moves::FilterReporterMover::apply ( core::pose::Pose & pose )

virtual

Implements protocols::moves::Mover.

References filter_, filter_mover_, and out_.

void protocols::moves::FilterReporterMover::assign	(	FilterReporterMover &	lhs,
		FilterReporterMover const &	rhs
	)

staticprivate

used by cctor and operator= to assign one such object to the other

References filter_, filter_mover_, mover_, out_, and set_out().

Referenced by FilterReporterMover(), and operator=().

protocols::moves::MoverOP protocols::moves::FilterReporterMover::clone ( ) const

virtual

Return a clone of the Mover object.

clone is meant to return an OP'ed deep copy of this object. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function.

Reimplemented from protocols::moves::Mover.

References FilterReporterMover().

protocols::moves::MoverOP protocols::moves::FilterReporterMover::fresh_instance ( ) const

virtual

Generates a new Mover object freshly created with the default ctor.

fresh_instance is meant to return a new object of this class, created with the default constructor. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function. This is used by the August 08 job distributor.

Reimplemented from protocols::moves::Mover.

protocols::filters::FilterOP protocols::moves::FilterReporterMover::get_filter ( ) const

References filter_.

protocols::moves::MoverOP protocols::moves::FilterReporterMover::get_mover ( ) const

References mover_.

std::string protocols::moves::FilterReporterMover::get_name ( ) const

virtual

Each derived class must specify its name. The class name.

Implements protocols::moves::Mover.

std::ostream & protocols::moves::FilterReporterMover::get_out ( )

FilterReporterMover & protocols::moves::FilterReporterMover::operator= ( FilterReporterMover const & rhs )

References assign(), and protocols::moves::Mover::operator=().

void protocols::moves::FilterReporterMover::set_filter ( protocols::filters::FilterOP const & filter )

References filter_, and filter_mover_.

void protocols::moves::FilterReporterMover::set_mover ( protocols::moves::MoverOP const & mover )

References filter_mover_, and mover_.

void protocols::moves::FilterReporterMover::set_out ( std::ostream const & out )

References out_.

Referenced by assign(), and FilterReporterMover().

Member Data Documentation

protocols::filters::FilterOP protocols::moves::FilterReporterMover::filter_

private

Referenced by apply(), assign(), get_filter(), and set_filter().

protocols::moves::FilterMoverOP protocols::moves::FilterReporterMover::filter_mover_

private

mixin inheritence of FilterMover

Referenced by apply(), assign(), FilterReporterMover(), set_filter(), set_mover(), and ~FilterReporterMover().

protocols::moves::MoverOP protocols::moves::FilterReporterMover::mover_

private

Referenced by assign(), get_mover(), and set_mover().

std::ostream protocols::moves::FilterReporterMover::out_

private

Referenced by apply(), assign(), and set_out().

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

src/protocols/moves/FilterReporterMover.hh
src/protocols/moves/FilterReporterMover.cc

Public Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation