Rosetta Protocols  2014.35
Public Types | Public Member Functions | Private Attributes | List of all members
protocols::protein_interface_design::movers::PlacementAuctionMover Class Reference

#include <PlacementAuctionMover.hh>

Public Types

typedef std::pair
< protocols::hotspot_hashing::HotspotStubSetOP,
std::pair
< protocols::hotspot_hashing::HotspotStubOP,
core::Size > > 
StubSetStubPos
 
typedef std::pair
< protocols::hotspot_hashing::HotspotStubSetOP,
protocols::hotspot_hashing::HotspotStubOP
StubsetStubPair
 
typedef std::pair< core::Real,
std::pair< core::Size,
StubsetStubPair > > 
ResidueAuctionItem
 
typedef std::multimap
< core::Real, std::pair
< core::Size, StubsetStubPair > > 
ResidueAuction
 
typedef ResidueAuction::iterator iterator
 
typedef
ResidueAuction::const_iterator 
const_iterator
 
- 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::stringStrings
 

Public Member Functions

 PlacementAuctionMover ()
 
void apply (core::pose::Pose &pose)
 a dummy apply so that instantiation of this baseclass would be possible. More...
 
virtual std::string get_name () const
 Each derived class must specify its name. The class name. More...
 
ResidueAuction auction_results () const
 
protocols::moves::MoverOP clone () const
 Return a clone of the Mover object. More...
 
protocols::moves::MoverOP fresh_instance () const
 Generates a new Mover object freshly created with the default ctor. More...
 
void insert (ResidueAuctionItem const &item)
 
core::Size size () const
 
void erase (iterator it)
 
void clear ()
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
virtual void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &, protocols::filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &)
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
 
void host_chain (core::Size const hc)
 
void max_cb_cb_dist (core::Real const mccd)
 
void cb_force (core::Real const cf)
 
void stub_sets (utility::vector1< StubSetStubPos > const &vec)
 
std::string get_stub_scorefxn () const
 
utility::vector1
< StubSetStubPos > const & 
stub_sets () const
 
utility::vector1
< StubSetStubPos > & 
stub_sets ()
 
 ~PlacementAuctionMover ()
 
- Public Member Functions inherited from protocols::simple_moves::DesignRepackMover
 DesignRepackMover ()
 
 DesignRepackMover (std::string const name)
 
void setup_packer_and_movemap (core::pose::Pose const &pose)
 
void min_rb (utility::vector1< bool > const min_rb)
 
void min_rb (bool const min_rb)
 in most cases, there would only be one rb dof making it useful to have a non-vector accessor to min_rb_. However, if the pose has multiple jumps, setting min_rb_ in this way might cause trouble in other parts of the code. More...
 
utility::vector1< bool > const & min_rb () const
 
bool min_rb_set () const
 
void min_sc (utility::vector1< bool > const &min_sc)
 
utility::vector1< bool > const & min_sc () const
 
bool min_sc_set () const
 
void min_bb (utility::vector1< bool > const &min_bb)
 
utility::vector1< bool > const & min_bb () const
 
bool min_bb_set () const
 
bool optimize_foldtree () const
 
void optimize_foldtree (bool const opt)
 
void prevent_repacking (utility::vector1< core::Size > const p)
 
utility::vector1< core::Size >
const & 
prevent_repacking () const
 
void restrict_to_repacking (utility::vector1< core::Size > const p)
 
utility::vector1< core::Size >
const & 
restrict_to_repacking () const
 
void design (bool const des)
 
bool design () const
 
void set_scorefxn_repack (core::scoring::ScoreFunctionCOP scorefxn)
 
void set_scorefxn_minimize (core::scoring::ScoreFunctionCOP scorefxn)
 
core::scoring::ScoreFunctionOP scorefxn_repack () const
 
core::scoring::ScoreFunctionOP scorefxn_minimize () const
 
core::pack::task::PackerTaskCOP task () const
 
core::pack::task::PackerTaskOPtask ()
 
void clear_task ()
 after fiddling with a task from outside this mover, clear it, or else, on the next iteration through the mover the changes will be remembered More...
 
void clear_task_factory ()
 
void use_preset_task (bool const bt)
 
bool use_preset_task () const
 
void task_factory (core::pack::task::TaskFactoryOP p)
 
core::pack::task::TaskFactoryOPtask_factory ()
 
core::pack::task::TaskFactoryOP task_factory () const
 
virtual ~DesignRepackMover ()
 
- Public Member Functions inherited from protocols::moves::Mover
 Mover ()
 
virtual ~Mover ()
 
virtual MoverSP create ()
 
virtual void apply (core::io::serialization::PipeMap &pmap)
 
virtual void parse_state (SerializableState const &state)
 
virtual void parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks, MoverCacheSP cache)
 
virtual void save_state (SerializableState &state)
 
 Mover (std::string const &type_name)
 sets the type for a mover; name_ has been removed (2010/05/14) More...
 
 Mover (Mover const &other)
 
Moveroperator= (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...
 
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)
 
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 Stringsinfo ()
 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...
 

Private Attributes

ResidueAuction auction_results_
 
core::Size host_chain_
 
core::Real max_cb_cb_dist_
 
core::Real cb_force_
 
std::string stub_energy_fxn_
 
utility::vector1< StubSetStubPosstub_sets_
 

Additional Inherited Members

- 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...
 
- Protected Attributes inherited from protocols::simple_moves::DesignRepackMover
core::scoring::ScoreFunctionOP scorefxn_repack_
 
core::scoring::ScoreFunctionOP scorefxn_minimize_
 
bool repack_partner1_
 
bool repack_partner2_
 
bool design_partner1_
 
bool design_partner2_
 
utility::vector1< boolmin_sc_
 
utility::vector1< boolcurr_min_sc_
 
utility::vector1< boolmin_rb_
 
utility::vector1< boolmin_bb_
 
utility::vector1< boolcurr_min_bb_
 
utility::vector1< boolcurr_min_rb_
 
bool min_rb_set_
 
bool min_sc_set_
 
bool min_bb_set_
 
utility::vector1< core::Sizetarget_residues_
 
core::Real interface_distance_cutoff_
 
bool repack_non_ala_
 
bool optimize_foldtree_
 
bool automatic_repacking_definition_
 
core::pack::task::PackerTaskOP task_
 
bool use_preset_task_
 
utility::vector1< boolallowed_aas_
 
utility::vector1< core::Sizeprevent_repacking_
 
utility::vector1< core::Sizerestrict_to_repacking_
 
core::pack::task::TaskFactoryOP task_factory_
 
bool symmetry_
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::protein_interface_design::movers::PlacementAuctionMover::PlacementAuctionMover ( )

Referenced by clone().

protocols::protein_interface_design::movers::PlacementAuctionMover::~PlacementAuctionMover ( )

Member Function Documentation

void protocols::protein_interface_design::movers::PlacementAuctionMover::apply ( core::pose::Pose )
virtual
PlacementAuctionMover::ResidueAuction protocols::protein_interface_design::movers::PlacementAuctionMover::auction_results ( ) const

References auction_results_.

Referenced by apply().

PlacementAuctionMover::iterator protocols::protein_interface_design::movers::PlacementAuctionMover::begin ( )

References auction_results_.

Referenced by apply().

PlacementAuctionMover::const_iterator protocols::protein_interface_design::movers::PlacementAuctionMover::begin ( ) const

References auction_results_.

void protocols::protein_interface_design::movers::PlacementAuctionMover::cb_force ( core::Real const  cf)

References cb_force_.

void protocols::protein_interface_design::movers::PlacementAuctionMover::clear ( )

References auction_results_.

Referenced by apply().

protocols::moves::MoverOP protocols::protein_interface_design::movers::PlacementAuctionMover::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.

Implements protocols::simple_moves::DesignRepackMover.

References PlacementAuctionMover().

PlacementAuctionMover::iterator protocols::protein_interface_design::movers::PlacementAuctionMover::end ( )

References auction_results_.

Referenced by apply().

PlacementAuctionMover::const_iterator protocols::protein_interface_design::movers::PlacementAuctionMover::end ( ) const

References auction_results_.

void protocols::protein_interface_design::movers::PlacementAuctionMover::erase ( PlacementAuctionMover::iterator  it)

References auction_results_.

Referenced by apply().

protocols::moves::MoverOP protocols::protein_interface_design::movers::PlacementAuctionMover::fresh_instance ( ) const
inlinevirtual

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.

Implements protocols::simple_moves::DesignRepackMover.

std::string protocols::protein_interface_design::movers::PlacementAuctionMover::get_name ( ) const
virtual

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

Reimplemented from protocols::simple_moves::DesignRepackMover.

References protocols::protein_interface_design::movers::PlacementAuctionMoverCreator::mover_name().

std::string protocols::protein_interface_design::movers::PlacementAuctionMover::get_stub_scorefxn ( ) const

References stub_energy_fxn_.

void protocols::protein_interface_design::movers::PlacementAuctionMover::host_chain ( core::Size const  hc)

References host_chain_.

void protocols::protein_interface_design::movers::PlacementAuctionMover::insert ( PlacementAuctionMover::ResidueAuctionItem const &  item)

References auction_results_.

Referenced by apply().

void protocols::protein_interface_design::movers::PlacementAuctionMover::max_cb_cb_dist ( core::Real const  mccd)

References max_cb_cb_dist_.

void protocols::protein_interface_design::movers::PlacementAuctionMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap data,
protocols::filters::Filters_map const &  filters,
protocols::moves::Movers_map const &  movers,
core::pose::Pose const &  pose 
)
virtual

Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing.

Some movers need not be parsed, so we shouldn't stop executions. This, however, calls attention to the lack of this method, which could be due to something as silly as a wrong parameters definition.

Reimplemented from protocols::simple_moves::DesignRepackMover.

References cb_force_, host_chain_, max_cb_cb_dist_, protocols::protein_interface_design::movers::parse_stub_sets(), runtime_assert, stub_energy_fxn_, stub_sets_, and protocols::protein_interface_design::movers::TR.

core::Size protocols::protein_interface_design::movers::PlacementAuctionMover::size ( ) const

References auction_results_.

Referenced by apply().

void protocols::protein_interface_design::movers::PlacementAuctionMover::stub_sets ( utility::vector1< StubSetStubPos > const &  vec)

References stub_sets(), and stub_sets_.

utility::vector1< protocols::protein_interface_design::movers::PlacementAuctionMover::StubSetStubPos > const & protocols::protein_interface_design::movers::PlacementAuctionMover::stub_sets ( ) const

References stub_sets_.

Referenced by apply(), and stub_sets().

utility::vector1< protocols::protein_interface_design::movers::PlacementAuctionMover::StubSetStubPos > & protocols::protein_interface_design::movers::PlacementAuctionMover::stub_sets ( )

References stub_sets_.

Member Data Documentation

ResidueAuction protocols::protein_interface_design::movers::PlacementAuctionMover::auction_results_
private
core::Real protocols::protein_interface_design::movers::PlacementAuctionMover::cb_force_
private

Referenced by apply(), cb_force(), and parse_my_tag().

core::Size protocols::protein_interface_design::movers::PlacementAuctionMover::host_chain_
private

Referenced by apply(), host_chain(), and parse_my_tag().

core::Real protocols::protein_interface_design::movers::PlacementAuctionMover::max_cb_cb_dist_
private

Referenced by apply(), max_cb_cb_dist(), and parse_my_tag().

std::string protocols::protein_interface_design::movers::PlacementAuctionMover::stub_energy_fxn_
private
utility::vector1< StubSetStubPos > protocols::protein_interface_design::movers::PlacementAuctionMover::stub_sets_
private

Referenced by apply(), parse_my_tag(), and stub_sets().


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