Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
protocols::jd2::LazySilentFileJobInputter Class Reference

#include <LazySilentFileJobInputter.hh>

Inheritance diagram for protocols::jd2::LazySilentFileJobInputter:
Inheritance graph
[legend]

Public Member Functions

 LazySilentFileJobInputter ()
 
 ~LazySilentFileJobInputter () override
 
void pose_from_job (core::pose::Pose &pose, JobOP job) override
 this function is responsible for returning the starting pose to use for the input job. The Job object (within its InnerJob) contains a PoseCOP. This function needs to either create a new Pose from the InnerJob Pose or, on first demand of a pose from that InnerJob, instantiate the pose, hand off a COP to the InnerJob, and fill the reference. More...
 
virtual
core::io::silent::SilentStruct
const & 
struct_from_job (JobOP job)
 
void fill_jobs (JobsContainer &jobs) override
 this function determines what jobs exist. This function neither knows nor cares what jobs are already complete on disk/memory - it just figures out what ones should exist given the input. NOTE: your JobInputter should order Job objects in the Jobs vector to have as few "transitions" between inputs as possible (group all Jobs of the same input next to each other). This improves efficiency of the "FAIL_BAD_INPUT" functionality. Note I (Brave Sir Steven) said "should", not "must". More...
 
JobInputterInputSource::Enum input_source () const override
 return the type of input source that the JobInputter is currently using More...
 
core::io::silent::SilentFileData
const & 
silent_file_data () const
 
- Public Member Functions inherited from protocols::jd2::JobInputter
 ~JobInputter () override
 
JobInputterCOP get_self_ptr () const
 Get self const owning pointers. More...
 
JobInputterOP get_self_ptr ()
 Get self owning pointers. More...
 
JobInputterCAP get_self_weak_ptr () const
 Get self const weak pointers. More...
 
JobInputterAP get_self_weak_ptr ()
 Get self weak pointers. More...
 
virtual void update_jobs_list (JobsContainerOP jobs)
 This function is only called by certain JobInputters to update the jobs list after it has already been created. More...
 
virtual bool updates_jobs_list () const
 Does this type of JobInputter update the jobs list? More...
 

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

Constructor & Destructor Documentation

protocols::jd2::LazySilentFileJobInputter::LazySilentFileJobInputter ( )

References protocols::jd2::tr().

protocols::jd2::LazySilentFileJobInputter::~LazySilentFileJobInputter ( )
overridedefault

Member Function Documentation

void protocols::jd2::LazySilentFileJobInputter::fill_jobs ( JobsContainer jobs)
overridevirtual

this function determines what jobs exist. This function neither knows nor cares what jobs are already complete on disk/memory - it just figures out what ones should exist given the input. NOTE: your JobInputter should order Job objects in the Jobs vector to have as few "transitions" between inputs as possible (group all Jobs of the same input next to each other). This improves efficiency of the "FAIL_BAD_INPUT" functionality. Note I (Brave Sir Steven) said "should", not "must".

Implements protocols::jd2::JobInputter.

References core::sequence::end, protocols::jd2::JobsContainer::push_back(), and protocols::jd2::tr().

JobInputterInputSource::Enum protocols::jd2::LazySilentFileJobInputter::input_source ( ) const
overridevirtual

return the type of input source that the JobInputter is currently using

Implements protocols::jd2::JobInputter.

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

void protocols::jd2::LazySilentFileJobInputter::pose_from_job ( core::pose::Pose pose,
JobOP  job 
)
overridevirtual

this function is responsible for returning the starting pose to use for the input job. The Job object (within its InnerJob) contains a PoseCOP. This function needs to either create a new Pose from the InnerJob Pose or, on first demand of a pose from that InnerJob, instantiate the pose, hand off a COP to the InnerJob, and fill the reference.

Implements protocols::jd2::JobInputter.

References core::pose::Pose::clear(), core::pose::tag_into_pose(), and protocols::jd2::tr().

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

References sfd_.

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

Member Data Documentation

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

Referenced by silent_file_data().


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