Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::constraint_movers::CstInfoMover Class Reference

A Mover to output information about constraints. More...

#include <CstInfoMover.hh>

Inheritance diagram for protocols::constraint_movers::CstInfoMover:
Inheritance graph

Public Member Functions

 CstInfoMover ()
 CstInfoMover (CstInfoMover const &src)
 ~CstInfoMover () override
void cst_file (std::string const &setting)
void dump_cst_file (std::string const &setting)
void prefix (std::string const &setting)
void recursive (bool setting)
std::string const & cst_file () const
std::string const & dump_cst_file () const
std::string const & prefix () const
bool recursive () const
void apply (core::pose::Pose &pose) override
 Main Method. More...
void add_info_for_csts (core::scoring::constraints::ConstraintCOPs const &cstlist, core::pose::Pose &pose, std::string const &tag) const
core::scoring::constraints::ConstraintCOPs get_constraints_from_file (std::string const &filename, core::pose::Pose const &pose) const
core::scoring::constraints::ConstraintCOPs get_constraints_from_pose (core::pose::Pose const &pose) const
void show (std::ostream &output=std::cout) const override
 Outputs details about the Mover, including current settings. More...
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
 parse XML tag (to use this Mover in Rosetta Scripts) More...
moves::MoverOP fresh_instance () const override
 required in the context of the parser/scripting scheme More...
protocols::moves::MoverOP clone () const override
 required in the context of the parser/scripting scheme More...
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
- Public Member Functions inherited from protocols::moves::Mover
 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...
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...
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...
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...
void set_type (std::string const &setting)
 Set the 'type' string. More...
std::string get_type () const
void type (const std::string &type_in)
 Set the 'type' string. More...
std::string const & type () const
 Get the set 'type' string. More...
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
void set_current_job (protocols::jobdist::BasicJobCOP job)
jobdist::BasicJobCOP get_current_job () const
virtual void set_current_tag (std::string const &new_tag)
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 core::Real last_proposal_density_ratio ()
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 Stringsinfo ()
 non-const accessor More...
virtual Strings const & info () const
 const accessor More...
virtual void provide_citation_info (basic::citation_manager::CitationCollectionList &) const
 Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...

Static Public Member Functions

static std::string mover_name ()
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
- 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...

Private Attributes

std::string cst_file_
std::string dump_cst_file_
std::string prefix_
bool recursive_

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 std::list< std::string > Strings
- 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 Mover to output information about constraints.

Constructor & Destructor Documentation

◆ CstInfoMover() [1/2]

protocols::constraint_movers::CstInfoMover::CstInfoMover ( )

◆ CstInfoMover() [2/2]

protocols::constraint_movers::CstInfoMover::CstInfoMover ( CstInfoMover const &  src)

◆ ~CstInfoMover()

protocols::constraint_movers::CstInfoMover::~CstInfoMover ( )

Member Function Documentation

◆ add_info_for_csts()

void protocols::constraint_movers::CstInfoMover::add_info_for_csts ( core::scoring::constraints::ConstraintCOPs const &  cstlist,
core::pose::Pose pose,
std::string const &  tag 
) const

◆ apply()

void protocols::constraint_movers::CstInfoMover::apply ( core::pose::Pose )

◆ clone()

protocols::moves::MoverOP protocols::constraint_movers::CstInfoMover::clone ( ) const

required in the context of the parser/scripting scheme

Reimplemented from protocols::moves::Mover.

◆ cst_file() [1/2]

std::string const& protocols::constraint_movers::CstInfoMover::cst_file ( ) const

References cst_file_.

Referenced by parse_my_tag().

◆ cst_file() [2/2]

void protocols::constraint_movers::CstInfoMover::cst_file ( std::string const &  setting)

References cst_file_.

◆ dump_cst_file() [1/2]

std::string const& protocols::constraint_movers::CstInfoMover::dump_cst_file ( ) const

References dump_cst_file_.

Referenced by parse_my_tag().

◆ dump_cst_file() [2/2]

void protocols::constraint_movers::CstInfoMover::dump_cst_file ( std::string const &  setting)

References dump_cst_file_.

◆ fresh_instance()

moves::MoverOP protocols::constraint_movers::CstInfoMover::fresh_instance ( ) const

required in the context of the parser/scripting scheme

Reimplemented from protocols::moves::Mover.

◆ get_constraints_from_file()

core::scoring::constraints::ConstraintCOPs protocols::constraint_movers::CstInfoMover::get_constraints_from_file ( std::string const &  filename,
core::pose::Pose const &  pose 
) const

◆ get_constraints_from_pose()

core::scoring::constraints::ConstraintCOPs protocols::constraint_movers::CstInfoMover::get_constraints_from_pose ( core::pose::Pose const &  pose) const

◆ get_name()

std::string protocols::constraint_movers::CstInfoMover::get_name ( ) const

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

Implements protocols::moves::Mover.

References mover_name().

◆ mover_name()

std::string protocols::constraint_movers::CstInfoMover::mover_name ( )

◆ parse_my_tag()

void protocols::constraint_movers::CstInfoMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap data 

parse XML tag (to use this Mover in Rosetta Scripts)

Reimplemented from protocols::moves::Mover.

References cst_file(), dump_cst_file(), prefix(), and recursive().

◆ prefix() [1/2]

std::string const& protocols::constraint_movers::CstInfoMover::prefix ( ) const

References prefix_.

Referenced by parse_my_tag().

◆ prefix() [2/2]

void protocols::constraint_movers::CstInfoMover::prefix ( std::string const &  setting)

References prefix_.

◆ provide_xml_schema()

void protocols::constraint_movers::CstInfoMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)

◆ recursive() [1/2]

bool protocols::constraint_movers::CstInfoMover::recursive ( ) const

References recursive_.

Referenced by parse_my_tag().

◆ recursive() [2/2]

void protocols::constraint_movers::CstInfoMover::recursive ( bool  setting)

References recursive_.

◆ show()

void protocols::constraint_movers::CstInfoMover::show ( std::ostream &  output = std::cout) const

Outputs details about the Mover, including current settings.

Ideally, a child Mover should call and add additional information particular to that Mover.

Reimplemented from protocols::moves::Mover.

References cst_file_, prefix_, recursive_, and protocols::moves::Mover::show().

Referenced by protocols::constraint_movers::operator<<().

Member Data Documentation

◆ cst_file_

std::string protocols::constraint_movers::CstInfoMover::cst_file_

Referenced by apply(), cst_file(), and show().

◆ dump_cst_file_

std::string protocols::constraint_movers::CstInfoMover::dump_cst_file_

Referenced by apply(), and dump_cst_file().

◆ prefix_

std::string protocols::constraint_movers::CstInfoMover::prefix_

Referenced by apply(), prefix(), and show().

◆ recursive_

bool protocols::constraint_movers::CstInfoMover::recursive_

Referenced by add_info_for_csts(), recursive(), and show().

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