Rosetta Protocols  2014.35
Public Member Functions | List of all members
protocols::jd2::PDBJobInputter Class Reference

#include <PDBJobInputter.hh>

Public Member Functions

 PDBJobInputter ()
 
virtual ~PDBJobInputter ()
 
virtual void pose_from_job (core::pose::Pose &pose, JobOP job)
 this function is responsible for filling the pose reference with the pose indicated by the job. The Job object (within its InnerJob) contains a PoseCOP. This function needs to either fill the pose reference from the InnerJob or, on first demand of a pose from that InnerJob, instantiate the pose, hand off a COP to the InnerJob, and fill the reference. This implementation uses pose_from_pdb More...
 
virtual void fill_jobs (Jobs &jobs)
 this function determines what jobs exist from -s/-l More...
 
virtual
JobInputterInputSource::Enum 
input_source () const
 Return the type of input source that the PDBJobInputter is currently using. More...
 
- Public Member Functions inherited from protocols::jd2::JobInputter
virtual ~JobInputter ()
 

Additional Inherited Members

- Static Public Member Functions inherited from protocols::jd2::JobInputter
static std::string job_inputter_input_source_to_string (JobInputterInputSource::Enum source)
 call this with input_source() to get the input source of a particular job inputter More...
 
- Protected Member Functions inherited from protocols::jd2::JobInputter
void load_pose_into_job (core::pose::Pose const &pose, JobOP job)
 this function modifies the InnerJob's pose. Access to that pose is via friendship. More...
 
void load_pose_into_job (core::pose::PoseCOP pose, JobOP job)
 this function modifies the InnerJob's pose. Access to that pose is via friendship. More...
 
virtual core::Size get_nstruct () const
 this code is here to restrict the use of inner_job_nonconst (this class is a friend class and can do it) More...
 

Detailed Description

This is the simplest implementation of JobInputter, which reads from -s/-l and PDB files.

Constructor & Destructor Documentation

protocols::jd2::PDBJobInputter::PDBJobInputter ( )

References protocols::jd2::TR.

protocols::jd2::PDBJobInputter::~PDBJobInputter ( )
virtual

Member Function Documentation

void protocols::jd2::PDBJobInputter::fill_jobs ( Jobs jobs)
virtual

this function determines what jobs exist from -s/-l

this function determines what jobs exist from -s/-l

Implements protocols::jd2::JobInputter.

References nstruct, basic::options::start_files(), and protocols::jd2::TR.

JobInputterInputSource::Enum protocols::jd2::PDBJobInputter::input_source ( ) const
virtual

Return the type of input source that the PDBJobInputter is currently using.

Returns
Always PDB_FILE.

Implements protocols::jd2::JobInputter.

References protocols::jd2::JobInputterInputSource::PDB_FILE.

void protocols::jd2::PDBJobInputter::pose_from_job ( core::pose::Pose pose,
JobOP  job 
)
virtual

this function is responsible for filling the pose reference with the pose indicated by the job. The Job object (within its InnerJob) contains a PoseCOP. This function needs to either fill the pose reference from the InnerJob or, on first demand of a pose from that InnerJob, instantiate the pose, hand off a COP to the InnerJob, and fill the reference. This implementation uses pose_from_pdb

This function will first see if the pose already exists in the Job. If not, it will read it into the pose reference, and hand a COP cloned from that pose to the Job. If the pose pre-exists it just copies the COP's pose into it.

Implements protocols::jd2::JobInputter.

Reimplemented in protocols::enzdes::EnzdesJobInputter, and protocols::protein_interface_design::ParserJobInputter.

References core::util::auto_setup_all_metal_constraints(), in::auto_setup_metals, protocols::jd2::Job::inner_job(), protocols::jd2::Job::input_tag(), in::metals_angle_constraint_multiplier, in::metals_distance_constraint_multiplier, option, core::import_pose::pose_from_pdb(), protocols::jd2::TR, and user.


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