Rosetta 3.4
Public Member Functions | Protected Member Functions | Friends
protocols::jd2::InnerJob Class Reference

#include <InnerJob.hh>

Inheritance diagram for protocols::jd2::InnerJob:
Inheritance graph
[legend]
Collaboration diagram for protocols::jd2::InnerJob:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 InnerJob (std::string const &input_tag, core::Size nstruct_max)
 ctor. Note that it takes only the input tag and max nstruct, pose instantiation is deferred until the pose is needed
 InnerJob (core::pose::PoseCOP, std::string const &input_tag, core::Size nstruct_max)
 ctor. Note that it takes only the input tag and max nstruct, pose instantiation is deferred until the pose is needed
virtual ~InnerJob ()
std::string const & input_tag () const
 return the input tag (a string of space separated PDB filenames)
core::Size nstruct_max () const
core::pose::PoseCOP get_pose () const
 return a COP to the input pose DO NOT USE OUTSIDE OF JD2 NAMESPACE
void set_bad (bool value=true)
bool bad () const

Protected Member Functions

void set_pose (core::pose::PoseCOP pose)
 set the input pose. this function is deliberately heavily protected. Parser uses it to re-load the pose after adding constraints. JobInputter is its primary client (using it to load poses). JobDistributor uses it to set the PoseCOP to NULL when done with the input.

Friends

class protocols::jd2::Parser
class protocols::jd2::JobInputter
class protocols::jd2::JobDistributor

Detailed Description

The InnerJob class is responsible for knowing input requirements for a given job - how many nstruct, and what the input is. InnerJobs are relatively heavy; there is no need to duplicate a series of InnerJobs for each index into nstruct. The companion Job class handles the nstruct index and has a pointer to an InnerJob (which is shared across many Jobs). InnerJob also holds a PoseOP to maintain the unmodified input pose for that job.


Constructor & Destructor Documentation

protocols::jd2::InnerJob::InnerJob ( std::string const &  input_tag,
core::Size  nstruct_max 
)

ctor. Note that it takes only the input tag and max nstruct, pose instantiation is deferred until the pose is needed

protocols::jd2::InnerJob::InnerJob ( core::pose::PoseCOP  pose,
std::string const &  input_tag,
core::Size  nstruct_max 
)

ctor. Note that it takes only the input tag and max nstruct, pose instantiation is deferred until the pose is needed

protocols::jd2::InnerJob::~InnerJob ( ) [virtual]

Member Function Documentation

bool protocols::jd2::InnerJob::bad ( ) const [inline]
core::pose::PoseCOP protocols::jd2::InnerJob::get_pose ( ) const

return a COP to the input pose DO NOT USE OUTSIDE OF JD2 NAMESPACE

std::string const & protocols::jd2::InnerJob::input_tag ( ) const

return the input tag (a string of space separated PDB filenames)

core::Size protocols::jd2::InnerJob::nstruct_max ( ) const
void protocols::jd2::InnerJob::set_bad ( bool  value = true) [inline]
void protocols::jd2::InnerJob::set_pose ( core::pose::PoseCOP  pose) [protected]

set the input pose. this function is deliberately heavily protected. Parser uses it to re-load the pose after adding constraints. JobInputter is its primary client (using it to load poses). JobDistributor uses it to set the PoseCOP to NULL when done with the input.


Friends And Related Function Documentation

friend class protocols::jd2::JobDistributor [friend]
friend class protocols::jd2::JobInputter [friend]
friend class protocols::jd2::Parser [friend]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines