output

Bindings for protocols::jd3::output namespace

class pyrosetta.rosetta.protocols.jd3.output.MultipleOutputSpecification

Bases: OutputSpecification

The %MultipleOutputSpecification

append_specification(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputSpecification, spec: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification) → None

C++: protocols::jd3::output::MultipleOutputSpecification::append_specification(class std::shared_ptr<class protocols::jd3::output::OutputSpecification>) –> void

assign(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputSpecification, : pyrosetta.rosetta.protocols.jd3.output.MultipleOutputSpecification) → pyrosetta.rosetta.protocols.jd3.output.MultipleOutputSpecification

C++: protocols::jd3::output::MultipleOutputSpecification::operator=(const class protocols::jd3::output::MultipleOutputSpecification &) –> class protocols::jd3::output::MultipleOutputSpecification &

jd_output_suffix(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputSpecification, setting: str) → None

Set the jd_output_suffix for myself and for the specifications I hold

C++: protocols::jd3::output::MultipleOutputSpecification::jd_output_suffix(const std::string &) –> void

output_index(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputSpecification, setting: pyrosetta.rosetta.protocols.jd3.JobOutputIndex) → None

Set the output_index for myself and for the specifications I hold

C++: protocols::jd3::output::MultipleOutputSpecification::output_index(const struct protocols::jd3::JobOutputIndex &) –> void

output_specifications(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputSpecification) → pyrosetta.rosetta.utility.vector1_std_shared_ptr_protocols_jd3_output_OutputSpecification_t

C++: protocols::jd3::output::MultipleOutputSpecification::output_specifications() const –> const class utility::vector1<class std::shared_ptr<class protocols::jd3::output::OutputSpecification>, class std::allocator<class std::shared_ptr<class protocols::jd3::output::OutputSpecification> > > &

result_id(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputSpecification, setting: Tuple[int, int]) → None

Set the result_id for myself and for the specifications I hold

C++: protocols::jd3::output::MultipleOutputSpecification::result_id(const struct std::pair<unsigned long, unsigned long> &) –> void

suffix_from_jd_with_sep(self: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification) → str

C++: protocols::jd3::output::OutputSpecification::suffix_from_jd_with_sep() const –> std::string

class pyrosetta.rosetta.protocols.jd3.output.MultipleOutputter

Bases: ResultOutputter

The %MultipleOutputter class is a vector of ResultOutputters. It should be used alongside the MultipleOutputSpecification class, which is a vector of ResultSpecifications and will hand each ResultSpecification in that vector to the corresponding ResultOutputter in its own vector.

append_outputter(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputter, outputter: pyrosetta.rosetta.protocols.jd3.output.ResultOutputter) → None

C++: protocols::jd3::output::MultipleOutputter::append_outputter(class std::shared_ptr<class protocols::jd3::output::ResultOutputter>) –> void

assign(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputter, : pyrosetta.rosetta.protocols.jd3.output.MultipleOutputter) → pyrosetta.rosetta.protocols.jd3.output.MultipleOutputter

C++: protocols::jd3::output::MultipleOutputter::operator=(const class protocols::jd3::output::MultipleOutputter &) –> class protocols::jd3::output::MultipleOutputter &

flush(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputter) → None

Invoke flush on all of the ResultOutputters this %MultipleOutputter contains

C++: protocols::jd3::output::MultipleOutputter::flush() –> void

outputters(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputter) → pyrosetta.rosetta.utility.vector1_std_shared_ptr_protocols_jd3_output_ResultOutputter_t

C++: protocols::jd3::output::MultipleOutputter::outputters() const –> const class utility::vector1<class std::shared_ptr<class protocols::jd3::output::ResultOutputter>, class std::allocator<class std::shared_ptr<class protocols::jd3::output::ResultOutputter> > > &

write_output(self: pyrosetta.rosetta.protocols.jd3.output.MultipleOutputter, specification: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification, result: pyrosetta.rosetta.protocols.jd3.JobResult) → None

Invoke write_output on all of the ResultOutputters this %MultipleOutputter contains.

This class expects the OutputSpecification to be of type MultipleOutputSpecification and will hand the ResultSpecifications that this class contains to the corresponding ResultOutputter.

C++: protocols::jd3::output::MultipleOutputter::write_output(const class protocols::jd3::output::OutputSpecification &, const class protocols::jd3::JobResult &) –> void

class pyrosetta.rosetta.protocols.jd3.output.OutputSpecification

Bases: pybind11_object

The %OutputSpecification

assign(self: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification, : pyrosetta.rosetta.protocols.jd3.output.OutputSpecification) → pyrosetta.rosetta.protocols.jd3.output.OutputSpecification

C++: protocols::jd3::output::OutputSpecification::operator=(const class protocols::jd3::output::OutputSpecification &) –> class protocols::jd3::output::OutputSpecification &

jd_output_suffix(*args, **kwargs)

Overloaded function.

1. jd_output_suffix(self: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification) -> str

C++: protocols::jd3::output::OutputSpecification::jd_output_suffix() const –> const std::string &

2. jd_output_suffix(self: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification, setting: str) -> None

C++: protocols::jd3::output::OutputSpecification::jd_output_suffix(const std::string &) –> void

output_index(*args, **kwargs)

Overloaded function.

1. output_index(self: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification) -> pyrosetta.rosetta.protocols.jd3.JobOutputIndex

C++: protocols::jd3::output::OutputSpecification::output_index() const –> struct protocols::jd3::JobOutputIndex

2. output_index(self: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification, setting: pyrosetta.rosetta.protocols.jd3.JobOutputIndex) -> None

C++: protocols::jd3::output::OutputSpecification::output_index(const struct protocols::jd3::JobOutputIndex &) –> void

result_id(*args, **kwargs)

Overloaded function.

1. result_id(self: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification) -> Tuple[int, int]

C++: protocols::jd3::output::OutputSpecification::result_id() const –> struct std::pair<unsigned long, unsigned long>

2. result_id(self: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification, setting: Tuple[int, int]) -> None

C++: protocols::jd3::output::OutputSpecification::result_id(const struct std::pair<unsigned long, unsigned long> &) –> void

suffix_from_jd_with_sep(self: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification) → str

C++: protocols::jd3::output::OutputSpecification::suffix_from_jd_with_sep() const –> std::string

class pyrosetta.rosetta.protocols.jd3.output.ResultOutputter

Bases: pybind11_object

The %ResultOutputter

assign(self: pyrosetta.rosetta.protocols.jd3.output.ResultOutputter, : pyrosetta.rosetta.protocols.jd3.output.ResultOutputter) → pyrosetta.rosetta.protocols.jd3.output.ResultOutputter

C++: protocols::jd3::output::ResultOutputter::operator=(const class protocols::jd3::output::ResultOutputter &) –> class protocols::jd3::output::ResultOutputter &

flush(self: pyrosetta.rosetta.protocols.jd3.output.ResultOutputter) → None

Output from an outputter may be held back and only flushed when requested

by the JobQueen; I/O can be expensive, so it’s a good idea to gather up the results of many outputs before flushing them to disk.

C++: protocols::jd3::output::ResultOutputter::flush() –> void

write_output(self: pyrosetta.rosetta.protocols.jd3.output.ResultOutputter, specification: pyrosetta.rosetta.protocols.jd3.output.OutputSpecification, result: pyrosetta.rosetta.protocols.jd3.JobResult) → None

C++: protocols::jd3::output::ResultOutputter::write_output(const class protocols::jd3::output::OutputSpecification &, const class protocols::jd3::JobResult &) –> void