GenericJobInputter.hh

Go to the documentation of this file.

// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// (c) Copyright Rosetta Commons Member Institutions.
// (c) This file is part of the Rosetta software suite and is made available under license.
// (c) The Rosetta software is developed by the contributing members of the Rosetta Commons.
// (c) For more information, see http://www.rosettacommons.org. Questions about this can be
// (c) addressed to University of Washington UW TechTransfer, email: license@u.washington.edu.

/// @file   protocols/jd2/GenericJobInputter.hh
/// @brief  header file for GenericJobInputter class, part of August 2008 job distributor as planned at RosettaCon08
/// @author Oliver Lange


#ifndef INCLUDED_protocols_comparative_modeling_GenericJobInputter_hh
#define INCLUDED_protocols_comparative_modeling_GenericJobInputter_hh

//unit headers
#include <protocols/jd2/JobInputter.hh>
#include <protocols/comparative_modeling/GenericJobInputter.fwd.hh>
#include <protocols/jd2/Job.fwd.hh>

//project headers
#include <core/pose/Pose.fwd.hh>

#include <utility/vector1.hh>


//utility headers

namespace protocols {
namespace comparative_modeling {

///@details This is the simplest implementation of JobInputter
class GenericJobInputter : public protocols::jd2::JobInputter
{
public:
  GenericJobInputter();
  /// @brief 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.
  virtual void pose_from_job( core::pose::Pose & pose, protocols::jd2::JobOP job );

  ///@brief this function determines what jobs exist
  virtual void fill_jobs( protocols::jd2::Jobs & jobs );

  /// @brief Return the type of input source that the GenericJobInputter is currently
  ///  using.
  /// @return Always <em>POSE</em>.
  virtual protocols::jd2::JobInputterInputSource::Enum input_source() const;

}; // GenericJobInputter

} // namespace comparative_modeling
} // namespace protocols

#endif //INCLUDED_protocols_comparative_modeling_GenericJobInputter_HH