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

#include <SilentFileJobInputter.hh>

Public Member Functions

 SilentFileJobInputter ()
 
virtual ~SilentFileJobInputter ()
 
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
core::io::silent::SilentStruct
const & 
struct_from_job (JobOP job)
 this function returns the SilentStruct that belongs to the given job More...
 
virtual void fill_jobs (Jobs &jobs)
 this function determines what jobs exist from -in::file::silent and -in::file::tags. More...
 
virtual
JobInputterInputSource::Enum 
input_source () const
 Return the type of input source that the SilentFileJobInputter is currently using. More...
 
core::io::silent::SilentFileData
const & 
silent_file_data () const
 
- Public Member Functions inherited from protocols::jd2::JobInputter
virtual ~JobInputter ()
 

Private Attributes

core::io::silent::SilentFileData sfd_
 

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 SilentFile files.

Constructor & Destructor Documentation

protocols::jd2::SilentFileJobInputter::SilentFileJobInputter ( )

References protocols::jd2::tr.

protocols::jd2::SilentFileJobInputter::~SilentFileJobInputter ( )
virtual

Member Function Documentation

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

this function determines what jobs exist from -in::file::silent and -in::file::tags.

this function determines what jobs exist from -in::file::silent and -in::file::tags

Implements protocols::jd2::JobInputter.

References end, nstruct, option, in::file::silent, tag, in::file::tags, tags, protocols::jd2::tr, and user.

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

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

Returns
Always SILENT_FILE.

Implements protocols::jd2::JobInputter.

References protocols::jd2::JobInputterInputSource::SILENT_FILE.

void protocols::jd2::SilentFileJobInputter::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.

References core::pose::Pose::clear(), protocols::jd2::Job::inner_job(), protocols::jd2::Job::input_tag(), core::pose::symmetry::is_symmetric(), core::pose::symmetry::make_asymmetric_pose(), tag_into_pose(), and protocols::jd2::tr.

core::io::silent::SilentFileData const& protocols::jd2::SilentFileJobInputter::silent_file_data ( ) const
inline

References sfd_.

core::io::silent::SilentStruct const & protocols::jd2::SilentFileJobInputter::struct_from_job ( JobOP  job)
virtual

this function returns the SilentStruct that belongs to the given job

References protocols::jd2::Job::inner_job(), and utility_exit_with_message.

Member Data Documentation

core::io::silent::SilentFileData protocols::jd2::SilentFileJobInputter::sfd_
private

Referenced by silent_file_data().


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