jobs

Bindings for protocols::jd3::jobs namespace

class pyrosetta.rosetta.protocols.jd3.jobs.MoverJob

Bases: Job

A Generic Mover(andPose)Job. Can be subclassed for derived jobs.

JobSummary is a StandardPoseJobSummary that includes the energy and a SimpleMetricDataOP for any set metrics. If you require anything else in your JobResult, derive from the PoseJobResult and then derive this class.

add_metric(self: pyrosetta.rosetta.protocols.jd3.jobs.MoverJob, metric: pyrosetta.rosetta.core.simple_metrics.SimpleMetric, data_prefix: str) → None

Set any metrics for this particular job.

The metrics will be stored in the pose so they can eventually be output.

C++: protocols::jd3::jobs::MoverJob::add_metric(class std::shared_ptr<const class core::simple_metrics::SimpleMetric>, const std::string &) –> void

add_metrics(self: pyrosetta.rosetta.protocols.jd3.jobs.MoverJob, metrics: pyrosetta.rosetta.utility.vector1_std_shared_ptr_const_core_simple_metrics_SimpleMetric_t, data_prefix: str) → None

Set any metrics for this particular job.

The metrics will be stored in the pose so they can eventually be output.

C++: protocols::jd3::jobs::MoverJob::add_metrics(class utility::vector1<class std::shared_ptr<const class core::simple_metrics::SimpleMetric>, class std::allocator<class std::shared_ptr<const class core::simple_metrics::SimpleMetric> > >, const std::string &) –> void

add_mover(self: pyrosetta.rosetta.protocols.jd3.jobs.MoverJob, mover: pyrosetta.rosetta.protocols.moves.Mover) → None

Add a mover to a sequence mover.

Overrides any single Mover set

C++: protocols::jd3::jobs::MoverJob::add_mover(class std::shared_ptr<class protocols::moves::Mover>) –> void

assign(self: pyrosetta.rosetta.protocols.jd3.jobs.MoverJob, : pyrosetta.rosetta.protocols.jd3.jobs.MoverJob) → pyrosetta.rosetta.protocols.jd3.jobs.MoverJob

C++: protocols::jd3::jobs::MoverJob::operator=(const class protocols::jd3::jobs::MoverJob &) –> class protocols::jd3::jobs::MoverJob &

pose(*args, **kwargs)

Overloaded function.

1. pose(self: pyrosetta.rosetta.protocols.jd3.jobs.MoverJob, setting: pyrosetta.rosetta.core.pose.Pose) -> None

Set the pose this job will run on.

C++: protocols::jd3::jobs::MoverJob::pose(class std::shared_ptr<class core::pose::Pose>) –> void

2. pose(self: pyrosetta.rosetta.protocols.jd3.jobs.MoverJob) -> pyrosetta.rosetta.core.pose.Pose

Get a modifieable pose

C++: protocols::jd3::jobs::MoverJob::pose() –> class std::shared_ptr<class core::pose::Pose>

run(self: pyrosetta.rosetta.protocols.jd3.jobs.MoverJob) → pyrosetta.rosetta.protocols.jd3.CompletedJobOutput

Run the job on any set private variables (such as a PoseOP)

Return a completed job output after this Job is done.

C++: protocols::jd3::jobs::MoverJob::run() –> struct protocols::jd3::CompletedJobOutput

set_mover(self: pyrosetta.rosetta.protocols.jd3.jobs.MoverJob, mover: pyrosetta.rosetta.protocols.moves.Mover) → None

Set the Mover this job will run. Use a MoverContainer to use multiple movers.

C++: protocols::jd3::jobs::MoverJob::set_mover(class std::shared_ptr<class protocols::moves::Mover>) –> void