options

Bindings for utility::options namespace

class pyrosetta.rosetta.utility.options.AnyOptionKey

Bases: pyrosetta.rosetta.utility.options.ScalarOptionKey

Automatic hidden index key for any scalar-valued options

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: pyrosetta.rosetta.utility.options.AnyOptionKey, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.options.AnyOptionKey

Key assignment

C++: utility::options::AnyOptionKey::operator=(const class utility::keys::Key &) –> class utility::options::AnyOptionKey &

  1. assign(self: pyrosetta.rosetta.utility.options.AnyOptionKey, : pyrosetta.rosetta.utility.options.AnyOptionKey) -> pyrosetta.rosetta.utility.options.AnyOptionKey

C++: utility::options::AnyOptionKey::operator=(const class utility::options::AnyOptionKey &) –> class utility::options::AnyOptionKey &

clone(self: pyrosetta.rosetta.utility.options.AnyOptionKey) pyrosetta.rosetta.utility.options.AnyOptionKey

Clone this

C++: utility::options::AnyOptionKey::clone() const –> class utility::options::AnyOptionKey *

code(*args, **kwargs)

Overloaded function.

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Code

C++: utility::keys::Key::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const std::string &) –> class utility::keys::Key &

id(*args, **kwargs)

Overloaded function.

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

ID

C++: utility::keys::Key::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const std::string &) –> class utility::keys::Key &

identifier(*args, **kwargs)

Overloaded function.

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> class utility::keys::Key &

static n_key() int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

scalar(self: pyrosetta.rosetta.utility.options.ScalarOptionKey) bool

Scalar option key?

C++: utility::options::ScalarOptionKey::scalar() const –> bool

vector(self: pyrosetta.rosetta.utility.options.ScalarOptionKey) bool

Vector option key?

C++: utility::options::ScalarOptionKey::vector() const –> bool

class pyrosetta.rosetta.utility.options.AnyVectorOptionKey

Bases: pyrosetta.rosetta.utility.options.VectorOptionKey

Automatic hidden index key for any vector-valued options

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: pyrosetta.rosetta.utility.options.AnyVectorOptionKey, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.options.AnyVectorOptionKey

Key assignment

C++: utility::options::AnyVectorOptionKey::operator=(const class utility::keys::Key &) –> class utility::options::AnyVectorOptionKey &

  1. assign(self: pyrosetta.rosetta.utility.options.AnyVectorOptionKey, : pyrosetta.rosetta.utility.options.AnyVectorOptionKey) -> pyrosetta.rosetta.utility.options.AnyVectorOptionKey

C++: utility::options::AnyVectorOptionKey::operator=(const class utility::options::AnyVectorOptionKey &) –> class utility::options::AnyVectorOptionKey &

clone(self: pyrosetta.rosetta.utility.options.AnyVectorOptionKey) pyrosetta.rosetta.utility.options.AnyVectorOptionKey

Clone this

C++: utility::options::AnyVectorOptionKey::clone() const –> class utility::options::AnyVectorOptionKey *

code(*args, **kwargs)

Overloaded function.

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Code

C++: utility::keys::Key::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const std::string &) –> class utility::keys::Key &

id(*args, **kwargs)

Overloaded function.

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

ID

C++: utility::keys::Key::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const std::string &) –> class utility::keys::Key &

identifier(*args, **kwargs)

Overloaded function.

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> class utility::keys::Key &

static n_key() int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

scalar(self: pyrosetta.rosetta.utility.options.VectorOptionKey) bool

Scalar option key?

C++: utility::options::VectorOptionKey::scalar() const –> bool

vector(self: pyrosetta.rosetta.utility.options.VectorOptionKey) bool

Vector option key?

C++: utility::options::VectorOptionKey::vector() const –> bool

class pyrosetta.rosetta.utility.options.BooleanOption

Bases: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

Program boolean option class

static NoDefault(key_a: pyrosetta.rosetta.utility.options.BooleanOptionKey, description_a: str) pyrosetta.rosetta.utility.options.BooleanOption

Key + description no-default named constructor

C++: utility::options::BooleanOption::NoDefault(const class utility::options::BooleanOptionKey &, const std::string &) –> class utility::options::BooleanOption

activate(*args, **kwargs)

Overloaded function.

  1. activate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::activate() –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

  1. activate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Activate

C++: utility::options::ScalarOption::activate() –> class utility::options::ScalarOption &

active(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::active() const –> bool

assign(self: pyrosetta.rosetta.utility.options.BooleanOption, : pyrosetta.rosetta.utility.options.BooleanOption) pyrosetta.rosetta.utility.options.BooleanOption

C++: utility::options::BooleanOption::operator=(const class utility::options::BooleanOption &) –> class utility::options::BooleanOption &

been_accessed(self: pyrosetta.rosetta.utility.options.Option) None

Set access property to true.

C++: utility::options::Option::been_accessed() const –> void

can_hold_another(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::can_hold_another() const –> bool

check_restricted_access(self: pyrosetta.rosetta.utility.options.Option, do_check: bool) None

C++: utility::options::Option::check_restricted_access(bool) const –> void

cl_value(*args, **kwargs)

Overloaded function.

  1. cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_str: str) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::cl_value(const std::string &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

  1. cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_str: str) -> pyrosetta.rosetta.utility.options.ScalarOption

Value assignment from a command line string

C++: utility::options::ScalarOption::cl_value(const std::string &) –> class utility::options::ScalarOption &

clear(*args, **kwargs)

Overloaded function.

  1. clear(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::clear() –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

  1. clear(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Clear

C++: utility::options::ScalarOption::clear() –> class utility::options::ScalarOption &

clone(self: pyrosetta.rosetta.utility.options.BooleanOption) pyrosetta.rosetta.utility.options.BooleanOption

Clone this

C++: utility::options::BooleanOption::clone() const –> class utility::options::BooleanOption *

code(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) str

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::code() const –> const std::string &

copy_from(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, other: pyrosetta.rosetta.utility.options.Option) None

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::copy_from(const class utility::options::Option &) –> void

deactivate(*args, **kwargs)

Overloaded function.

  1. deactivate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::deactivate() –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

  1. deactivate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Deactivate

C++: utility::options::ScalarOption::deactivate() –> class utility::options::ScalarOption &

def(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::def(const bool &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

default_active(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::default_active() const –> bool

default_inactive(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::default_inactive() const –> bool

default_size(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) int

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::default_size() const –> unsigned long

default_string(self: pyrosetta.rosetta.utility.options.BooleanOption) str

Default value string representation

C++: utility::options::BooleanOption::default_string() const –> std::string

default_to(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, option: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::default_to(const class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

default_value(*args, **kwargs)

Overloaded function.

  1. default_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::default_value(const bool &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

  1. default_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::default_value() const –> const bool &

description(*args, **kwargs)

Overloaded function.

  1. description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::description() const –> const std::string &

  1. description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, sd: str) -> None

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::description(const std::string &) –> void

equals_string(self: pyrosetta.rosetta.utility.options.BooleanOption) str

=Value string representation

C++: utility::options::BooleanOption::equals_string() const –> std::string

has_any_of_characters(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, str1: str, s: str) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::has_any_of_characters(const std::string &, const std::string &) const –> bool

has_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::has_default() const –> bool

id(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) str

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::id() const –> const std::string &

identifier(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) str

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::identifier() const –> const std::string &

is_been_accessed(self: pyrosetta.rosetta.utility.options.Option) bool

Return true if option value was anyhow accessed.

C++: utility::options::Option::is_been_accessed() const –> bool

is_cl_value(self: pyrosetta.rosetta.utility.options.BooleanOption, value_str: str) bool

Is a string readable as this option’s value type and a legal command line value?

C++: utility::options::BooleanOption::is_cl_value(const std::string &) const –> bool

is_group(*args, **kwargs)

Overloaded function.

  1. is_group(self: pyrosetta.rosetta.utility.options.Option, value: bool) -> pyrosetta.rosetta.utility.options.Option

C++: utility::options::Option::is_group(bool) –> class utility::options::Option &

  1. is_group(self: pyrosetta.rosetta.utility.options.Option) -> bool

Is this the synonymous option for an option group (e.g. -in:file:file)

C++: utility::options::Option::is_group() const –> bool

is_value(self: pyrosetta.rosetta.utility.options.BooleanOption, value_str: str) bool

Is a string readable as this option’s value type?

C++: utility::options::BooleanOption::is_value(const std::string &) const –> bool

key(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) pyrosetta.rosetta.utility.options.BooleanOptionKey

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::key() const –> const class utility::options::BooleanOptionKey &

legal(*args, **kwargs)

Overloaded function.

  1. legal(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal(const bool &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

  1. legal(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal() const –> bool

legal_check(*args, **kwargs)

Overloaded function.

  1. legal_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> None

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_check() const –> void

  1. legal_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) -> None

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_check(const bool &) const –> void

legal_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_default() const –> bool

legal_default_check(*args, **kwargs)

Overloaded function.

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> None

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_default_check() const –> void

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) -> None

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_default_check(const bool &) const –> void

legal_default_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_default_report() const –> bool

legal_limits_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_limits_report() const –> bool

legal_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_report() const –> bool

legal_size_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_size_report() const –> bool

legal_specs_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_specs_report() const –> bool

legal_string(self: pyrosetta.rosetta.utility.options.BooleanOption) str

Legal value string representation

C++: utility::options::BooleanOption::legal_string() const –> std::string

legal_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::legal_value(const bool &) const –> bool

lower(*args, **kwargs)

Overloaded function.

  1. lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::lower(const bool &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

  1. lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> pyrosetta.rosetta.utility.Bound_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::lower() const –> const class utility::Bound<bool> &

n_default_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) int

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::n_default_value() const –> unsigned long

n_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) int

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::n_value() const –> unsigned long

name(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) str

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::name() const –> const std::string &

static print_error_message(message: str) None
Print an error message. As a separate function to keep stream handling

from being part of the header files.

C++: utility::options::Option::print_error_message(const std::string &) –> void

raw_default_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) str

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::raw_default_string() const –> std::string

raw_value_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) str

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::raw_value_string() const –> std::string

restrict_access(self: pyrosetta.rosetta.utility.options.Option, setting: bool) pyrosetta.rosetta.utility.options.Option

Restrict direct access to option for general use.

In the past, protocols were able to access the values of options in the option system directly. However this tied protocol behavior tightly to setting specific options on the command line, making it difficult to use Rosetta using other workflows. Now, options are accessed through the resource manager, which has control over which options are passed to which protocols.

basic::resource_manager::ResourceManager::get_instance()->get_option(key);

To incrementally deprectate direct usage of options, an option is set to have restricted access in basic/options/options_rosetta.py

C++: utility::options::Option::restrict_access(bool) –> class utility::options::Option &

set_accessed(self: pyrosetta.rosetta.utility.options.Option, setting: bool) None

C++: utility::options::Option::set_accessed(bool) const –> void

set_cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_str: str) None
Value assignemt from a command line string but without

a ScalarOption & return type.

C++: utility::options::ScalarOption::set_cl_value(const std::string &) –> void

set_value(*args, **kwargs)

Overloaded function.

  1. set_value(self: pyrosetta.rosetta.utility.options.ScalarOption, value_str: str) -> None

  2. set_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_str: str, : bool) -> None

Value assignment from full string.

C++: utility::options::ScalarOption::set_value(const std::string &, bool) –> void

short_description(*args, **kwargs)

Overloaded function.

  1. short_description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::short_description() const –> const std::string &

  1. short_description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, sd: str) -> None

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::short_description(const std::string &) –> void

shortd(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, s: str) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::shortd(const std::string &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

size(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) int

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::size() const –> unsigned long

size_constraint_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) str

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::size_constraint_string() const –> std::string

specified_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) None

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::specified_check() const –> void

specified_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::specified_report() const –> bool

strict_lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::strict_lower(const bool &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

strict_upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::strict_upper(const bool &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

to_default(*args, **kwargs)

Overloaded function.

  1. to_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::to_default() –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

  1. to_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Set to default value, if any

C++: utility::options::ScalarOption::to_default() –> class utility::options::ScalarOption &

type_string(self: pyrosetta.rosetta.utility.options.BooleanOption) str

Option type code string representation

C++: utility::options::BooleanOption::type_string() const –> std::string

upper(*args, **kwargs)

Overloaded function.

  1. upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::upper(const bool &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

  1. upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> pyrosetta.rosetta.utility.Bound_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::upper() –> const class utility::Bound<bool> &

user(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::user() const –> bool

user_or(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::user_or(const bool &) const –> bool

value(*args, **kwargs)

Overloaded function.

  1. value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::value(const bool &) –> class utility::options::ScalarOption_T_<class utility::options::BooleanOptionKey, bool> &

  1. value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::value() const –> const bool &

value_or(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a: bool) bool

C++: utility::options::ScalarOption_T_<utility::options::BooleanOptionKey, bool>::value_or(const bool &) const –> bool

value_string(self: pyrosetta.rosetta.utility.options.BooleanOption) str

Value string representation

C++: utility::options::BooleanOption::value_string() const –> std::string

class pyrosetta.rosetta.utility.options.BooleanOptionKey

Bases: pyrosetta.rosetta.utility.options.ScalarOptionKey

Automatic hidden index key for boolean options

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: pyrosetta.rosetta.utility.options.BooleanOptionKey, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.options.BooleanOptionKey

Key assignment

C++: utility::options::BooleanOptionKey::operator=(const class utility::keys::Key &) –> class utility::options::BooleanOptionKey &

  1. assign(self: pyrosetta.rosetta.utility.options.BooleanOptionKey, : pyrosetta.rosetta.utility.options.BooleanOptionKey) -> pyrosetta.rosetta.utility.options.BooleanOptionKey

C++: utility::options::BooleanOptionKey::operator=(const class utility::options::BooleanOptionKey &) –> class utility::options::BooleanOptionKey &

clone(self: pyrosetta.rosetta.utility.options.BooleanOptionKey) pyrosetta.rosetta.utility.options.BooleanOptionKey

Clone this

C++: utility::options::BooleanOptionKey::clone() const –> class utility::options::BooleanOptionKey *

code(*args, **kwargs)

Overloaded function.

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Code

C++: utility::keys::Key::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const std::string &) –> class utility::keys::Key &

id(*args, **kwargs)

Overloaded function.

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

ID

C++: utility::keys::Key::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const std::string &) –> class utility::keys::Key &

identifier(*args, **kwargs)

Overloaded function.

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> class utility::keys::Key &

static n_key() int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

scalar(self: pyrosetta.rosetta.utility.options.ScalarOptionKey) bool

Scalar option key?

C++: utility::options::ScalarOptionKey::scalar() const –> bool

vector(self: pyrosetta.rosetta.utility.options.ScalarOptionKey) bool

Vector option key?

C++: utility::options::ScalarOptionKey::vector() const –> bool

class pyrosetta.rosetta.utility.options.BooleanVectorOption

Bases: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

Program boolean vector option class

activate(*args, **kwargs)

Overloaded function.

  1. activate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::activate() –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. activate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.VectorOption

Activate

C++: utility::options::VectorOption::activate() –> class utility::options::VectorOption &

active(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::active() const –> bool

assign(self: pyrosetta.rosetta.utility.options.BooleanVectorOption, : pyrosetta.rosetta.utility.options.BooleanVectorOption) pyrosetta.rosetta.utility.options.BooleanVectorOption

C++: utility::options::BooleanVectorOption::operator=(const class utility::options::BooleanVectorOption &) –> class utility::options::BooleanVectorOption &

been_accessed(self: pyrosetta.rosetta.utility.options.Option) None

Set access property to true.

C++: utility::options::Option::been_accessed() const –> void

can_hold_another(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::can_hold_another() const –> bool

check_restricted_access(self: pyrosetta.rosetta.utility.options.Option, do_check: bool) None

C++: utility::options::Option::check_restricted_access(bool) const –> void

cl_value(*args, **kwargs)

Overloaded function.

  1. cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_str: str) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::cl_value(const std::string &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_str: str) -> pyrosetta.rosetta.utility.options.VectorOption

Value assignment from a command line string

C++: utility::options::VectorOption::cl_value(const std::string &) –> class utility::options::VectorOption &

clear(*args, **kwargs)

Overloaded function.

  1. clear(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::clear() –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. clear(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.VectorOption

Clear

C++: utility::options::VectorOption::clear() –> class utility::options::VectorOption &

clone(self: pyrosetta.rosetta.utility.options.BooleanVectorOption) pyrosetta.rosetta.utility.options.BooleanVectorOption

Clone this

C++: utility::options::BooleanVectorOption::clone() const –> class utility::options::BooleanVectorOption *

code(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::code() const –> const std::string &

copy_from(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, other: pyrosetta.rosetta.utility.options.Option) None

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::copy_from(const class utility::options::Option &) –> void

deactivate(*args, **kwargs)

Overloaded function.

  1. deactivate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::deactivate() –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. deactivate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.VectorOption

Deactivate

C++: utility::options::VectorOption::deactivate() –> class utility::options::VectorOption &

def(*args, **kwargs)

Overloaded function.

  1. def(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::def(const bool &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. def(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::def() –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. def(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: pyrosetta.rosetta.utility.vector1_bool) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::def(const class utility::vector1<bool, class std::allocator<bool> > &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

default_active(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::default_active() const –> bool

default_inactive(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::default_inactive() const –> bool

default_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) int

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::default_size() const –> unsigned long

default_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::default_string() const –> std::string

default_to(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, option: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::default_to(const class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

default_value(*args, **kwargs)

Overloaded function.

  1. default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::default_value(const bool &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: pyrosetta.rosetta.utility.vector1_bool) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::default_value(const class utility::vector1<bool, class std::allocator<bool> > &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.vector1_bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::default_value() const –> const class utility::vector1<bool, class std::allocator<bool> > &

  1. default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i: int) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::default_value(const unsigned long) const –> const bool &

description(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::description() const –> const std::string &

equals_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::equals_string() const –> std::string

fixed_size(*args, **kwargs)

Overloaded function.

  1. fixed_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::fixed_size() const –> bool

  1. fixed_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

Fixed number of values required?

C++: utility::options::VectorOption::fixed_size() const –> bool

has_any_of_characters(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, str1: str, s: str) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::has_any_of_characters(const std::string &, const std::string &) const –> bool

has_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::has_default() const –> bool

has_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value: bool) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::has_value(const bool &) –> bool

id(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::id() const –> const std::string &

identifier(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::identifier() const –> const std::string &

is_been_accessed(self: pyrosetta.rosetta.utility.options.Option) bool

Return true if option value was anyhow accessed.

C++: utility::options::Option::is_been_accessed() const –> bool

is_cl_value(self: pyrosetta.rosetta.utility.options.BooleanVectorOption, value_str: str) bool

Is a string readable as this option’s value type and a legal command line value?

C++: utility::options::BooleanVectorOption::is_cl_value(const std::string &) const –> bool

is_group(*args, **kwargs)

Overloaded function.

  1. is_group(self: pyrosetta.rosetta.utility.options.Option, value: bool) -> pyrosetta.rosetta.utility.options.Option

C++: utility::options::Option::is_group(bool) –> class utility::options::Option &

  1. is_group(self: pyrosetta.rosetta.utility.options.Option) -> bool

Is this the synonymous option for an option group (e.g. -in:file:file)

C++: utility::options::Option::is_group() const –> bool

is_value(self: pyrosetta.rosetta.utility.options.BooleanVectorOption, value_str: str) bool

Is a string readable as this option’s value type?

C++: utility::options::BooleanVectorOption::is_value(const std::string &) const –> bool

key(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) pyrosetta.rosetta.utility.options.BooleanVectorOptionKey

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::key() const –> const class utility::options::BooleanVectorOptionKey &

legal(*args, **kwargs)

Overloaded function.

  1. legal(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal(const bool &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. legal(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal() const –> bool

legal_check(*args, **kwargs)

Overloaded function.

  1. legal_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> None

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_check() const –> void

  1. legal_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) -> None

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_check(const bool &) const –> void

legal_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_default() const –> bool

legal_default_check(*args, **kwargs)

Overloaded function.

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> None

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_default_check() const –> void

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) -> None

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_default_check(const bool &) const –> void

legal_default_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_default_report() const –> bool

legal_default_size(*args, **kwargs)

Overloaded function.

  1. legal_default_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_default_size() const –> bool

  1. legal_default_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

Legal default value size?

C++: utility::options::VectorOption::legal_default_size() const –> bool

legal_default_value(*args, **kwargs)

Overloaded function.

  1. legal_default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_default_value() const –> bool

  1. legal_default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

Legal or inactive default value?

C++: utility::options::VectorOption::legal_default_value() const –> bool

legal_limits_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_limits_report() const –> bool

legal_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_report() const –> bool

legal_size(*args, **kwargs)

Overloaded function.

  1. legal_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_size() const –> bool

  1. legal_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

Legal value size?

C++: utility::options::VectorOption::legal_size() const –> bool

legal_size_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_size_report() const –> bool

legal_specs_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_specs_report() const –> bool

legal_string(self: pyrosetta.rosetta.utility.options.BooleanVectorOption) str

Legal value string representation

C++: utility::options::BooleanVectorOption::legal_string() const –> std::string

legal_value(*args, **kwargs)

Overloaded function.

  1. legal_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_value() const –> bool

  1. legal_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::legal_value(const bool &) const –> bool

  1. legal_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool

Legal value?

C++: utility::options::VectorOption::legal_value() const –> bool

lower(*args, **kwargs)

Overloaded function.

  1. lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::lower(const bool &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.Bound_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::lower() const –> const class utility::Bound<bool> &

n(*args, **kwargs)

Overloaded function.

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::n(const unsigned long) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::n() const –> unsigned long

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption

Fixed number of values required assignment

C++: utility::options::VectorOption::n(const unsigned long) –> class utility::options::VectorOption &

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int

Fixed number of values required (zero if none)

C++: utility::options::VectorOption::n() const –> unsigned long

n_default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) int

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::n_default_value() const –> unsigned long

n_lower(*args, **kwargs)

Overloaded function.

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::n_lower(const unsigned long) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::n_lower() const –> unsigned long

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption

Lower number of values allowed assignment

C++: utility::options::VectorOption::n_lower(const unsigned long) –> class utility::options::VectorOption &

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int

Lower number of values allowed (zero if none)

C++: utility::options::VectorOption::n_lower() const –> unsigned long

n_upper(*args, **kwargs)

Overloaded function.

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::n_upper(const unsigned long) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::n_upper() const –> unsigned long

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption

Upper number of values allowed assignment

C++: utility::options::VectorOption::n_upper(const unsigned long) –> class utility::options::VectorOption &

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int

Upper number of values allowed (zero if none)

C++: utility::options::VectorOption::n_upper() const –> unsigned long

n_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) int

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::n_value() const –> unsigned long

name(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::name() const –> const std::string &

static print_error_message(message: str) None
Print an error message. As a separate function to keep stream handling

from being part of the header files.

C++: utility::options::Option::print_error_message(const std::string &) –> void

push_back(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::push_back(const bool &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

raw_default_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::raw_default_string() const –> std::string

raw_value_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::raw_value_string() const –> std::string

restrict_access(self: pyrosetta.rosetta.utility.options.Option, setting: bool) pyrosetta.rosetta.utility.options.Option

Restrict direct access to option for general use.

In the past, protocols were able to access the values of options in the option system directly. However this tied protocol behavior tightly to setting specific options on the command line, making it difficult to use Rosetta using other workflows. Now, options are accessed through the resource manager, which has control over which options are passed to which protocols.

basic::resource_manager::ResourceManager::get_instance()->get_option(key);

To incrementally deprectate direct usage of options, an option is set to have restricted access in basic/options/options_rosetta.py

C++: utility::options::Option::restrict_access(bool) –> class utility::options::Option &

set_accessed(self: pyrosetta.rosetta.utility.options.Option, setting: bool) None

C++: utility::options::Option::set_accessed(bool) const –> void

set_cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_str: str) None

C++: utility::options::VectorOption::set_cl_value(const std::string &) –> void

set_value(*args, **kwargs)

Overloaded function.

  1. set_value(self: pyrosetta.rosetta.utility.options.VectorOption, value_str: str) -> None

  2. set_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_str: str, reset: bool) -> None

Value assignemt from a command line string but without

a VectorOption & return type. This will separate arguments by whitespace and set the vector option accordingly. If reset is true, the current values will be cleared first.

C++: utility::options::VectorOption::set_value(const std::string &, bool) –> void

short_description(*args, **kwargs)

Overloaded function.

  1. short_description(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::short_description() const –> const std::string &

  1. short_description(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, sd: str) -> None

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::short_description(const std::string &) –> void

shortd(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, s: str) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::shortd(const std::string &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) int

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::size() const –> unsigned long

size_constraint_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::size_constraint_string() const –> std::string

specified_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) None

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::specified_check() const –> void

specified_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::specified_report() const –> bool

strict_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::strict_lower(const bool &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

strict_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::strict_upper(const bool &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

to_default(*args, **kwargs)

Overloaded function.

  1. to_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::to_default() –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. to_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.options.VectorOption

Set to default value, if any

C++: utility::options::VectorOption::to_default() –> class utility::options::VectorOption &

type_string(self: pyrosetta.rosetta.utility.options.BooleanVectorOption) str

Option type code string representation

C++: utility::options::BooleanVectorOption::type_string() const –> std::string

upper(*args, **kwargs)

Overloaded function.

  1. upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::upper(const bool &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.Bound_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::upper() –> const class utility::Bound<bool> &

user(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::user() const –> bool

user_or(*args, **kwargs)

Overloaded function.

  1. user_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: pyrosetta.rosetta.utility.vector1_bool) -> pyrosetta.rosetta.utility.vector1_bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::user_or(const class utility::vector1<bool, class std::allocator<bool> > &) const –> class utility::vector1<bool, class std::allocator<bool> >

  1. user_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i: int, value_a: bool) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::user_or(const unsigned long, const bool &) const –> bool

value(*args, **kwargs)

Overloaded function.

  1. value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: bool) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::value(const bool &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: pyrosetta.rosetta.utility.vector1_bool) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::value(const class utility::vector1<bool, class std::allocator<bool> > &) –> class utility::options::VectorOption_T_<class utility::options::BooleanVectorOptionKey, bool> &

  1. value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> pyrosetta.rosetta.utility.vector1_bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::value() const –> const class utility::vector1<bool, class std::allocator<bool> > &

  1. value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i: int) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::value(const unsigned long) const –> const bool &

value_or(*args, **kwargs)

Overloaded function.

  1. value_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a: pyrosetta.rosetta.utility.vector1_bool) -> pyrosetta.rosetta.utility.vector1_bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::value_or(const class utility::vector1<bool, class std::allocator<bool> > &) const –> class utility::vector1<bool, class std::allocator<bool> >

  1. value_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i: int, value_a: bool) -> bool

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::value_or(const unsigned long, const bool &) const –> bool

value_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) str

C++: utility::options::VectorOption_T_<utility::options::BooleanVectorOptionKey, bool>::value_string() const –> std::string

class pyrosetta.rosetta.utility.options.BooleanVectorOptionKey

Bases: pyrosetta.rosetta.utility.options.VectorOptionKey

Automatic hidden index key for boolean options

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.options.BooleanVectorOptionKey

Key assignment

C++: utility::options::BooleanVectorOptionKey::operator=(const class utility::keys::Key &) –> class utility::options::BooleanVectorOptionKey &

  1. assign(self: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey, : pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) -> pyrosetta.rosetta.utility.options.BooleanVectorOptionKey

C++: utility::options::BooleanVectorOptionKey::operator=(const class utility::options::BooleanVectorOptionKey &) –> class utility::options::BooleanVectorOptionKey &

clone(self: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) pyrosetta.rosetta.utility.options.BooleanVectorOptionKey

Clone this

C++: utility::options::BooleanVectorOptionKey::clone() const –> class utility::options::BooleanVectorOptionKey *

code(*args, **kwargs)

Overloaded function.

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Code

C++: utility::keys::Key::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const std::string &) –> class utility::keys::Key &

id(*args, **kwargs)

Overloaded function.

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

ID

C++: utility::keys::Key::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const std::string &) –> class utility::keys::Key &

identifier(*args, **kwargs)

Overloaded function.

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> class utility::keys::Key &

static n_key() int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

scalar(self: pyrosetta.rosetta.utility.options.VectorOptionKey) bool

Scalar option key?

C++: utility::options::VectorOptionKey::scalar() const –> bool

vector(self: pyrosetta.rosetta.utility.options.VectorOptionKey) bool

Vector option key?

C++: utility::options::VectorOptionKey::vector() const –> bool

class pyrosetta.rosetta.utility.options.FileOption

Bases: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

Program file option class

activate(*args, **kwargs)

Overloaded function.

  1. activate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::activate() –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

  1. activate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Activate

C++: utility::options::ScalarOption::activate() –> class utility::options::ScalarOption &

active(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::active() const –> bool

assign(self: pyrosetta.rosetta.utility.options.FileOption, : pyrosetta.rosetta.utility.options.FileOption) pyrosetta.rosetta.utility.options.FileOption

C++: utility::options::FileOption::operator=(const class utility::options::FileOption &) –> class utility::options::FileOption &

been_accessed(self: pyrosetta.rosetta.utility.options.Option) None

Set access property to true.

C++: utility::options::Option::been_accessed() const –> void

can_hold_another(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::can_hold_another() const –> bool

check_restricted_access(self: pyrosetta.rosetta.utility.options.Option, do_check: bool) None

C++: utility::options::Option::check_restricted_access(bool) const –> void

cl_value(*args, **kwargs)

Overloaded function.

  1. cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_str: str) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::cl_value(const std::string &) –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

  1. cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_str: str) -> pyrosetta.rosetta.utility.options.ScalarOption

Value assignment from a command line string

C++: utility::options::ScalarOption::cl_value(const std::string &) –> class utility::options::ScalarOption &

clear(*args, **kwargs)

Overloaded function.

  1. clear(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::clear() –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

  1. clear(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Clear

C++: utility::options::ScalarOption::clear() –> class utility::options::ScalarOption &

clone(self: pyrosetta.rosetta.utility.options.FileOption) pyrosetta.rosetta.utility.options.FileOption

Clone this

C++: utility::options::FileOption::clone() const –> class utility::options::FileOption *

code(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::code() const –> const std::string &

copy_from(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, other: pyrosetta.rosetta.utility.options.Option) None

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::copy_from(const class utility::options::Option &) –> void

deactivate(*args, **kwargs)

Overloaded function.

  1. deactivate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::deactivate() –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

  1. deactivate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Deactivate

C++: utility::options::ScalarOption::deactivate() –> class utility::options::ScalarOption &

def(*args, **kwargs)

Overloaded function.

  1. def(self: pyrosetta.rosetta.utility.options.FileOption, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

  2. def(self: pyrosetta.rosetta.utility.options.FileOption, value_a: str) -> pyrosetta.rosetta.utility.options.FileOption

Default value assignment

C++: utility::options::FileOption::def(const std::string &) –> class utility::options::FileOption &

default_active(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::default_active() const –> bool

default_inactive(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::default_inactive() const –> bool

default_size(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) int

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::default_size() const –> unsigned long

default_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::default_string() const –> std::string

default_to(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, option: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::default_to(const class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &) –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

default_value(*args, **kwargs)

Overloaded function.

  1. default_value(self: pyrosetta.rosetta.utility.options.FileOption) -> pyrosetta.rosetta.utility.file.FileName

  2. default_value(self: pyrosetta.rosetta.utility.options.FileOption, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

  3. default_value(self: pyrosetta.rosetta.utility.options.FileOption, value_a: str) -> pyrosetta.rosetta.utility.options.FileOption

Default value assignment

C++: utility::options::FileOption::default_value(const std::string &) –> class utility::options::FileOption &

description(*args, **kwargs)

Overloaded function.

  1. description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::description() const –> const std::string &

  1. description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, sd: str) -> None

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::description(const std::string &) –> void

equals_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::equals_string() const –> std::string

has_any_of_characters(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, str1: str, s: str) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::has_any_of_characters(const std::string &, const std::string &) const –> bool

has_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::has_default() const –> bool

id(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::id() const –> const std::string &

identifier(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::identifier() const –> const std::string &

is_been_accessed(self: pyrosetta.rosetta.utility.options.Option) bool

Return true if option value was anyhow accessed.

C++: utility::options::Option::is_been_accessed() const –> bool

is_cl_value(self: pyrosetta.rosetta.utility.options.FileOption, value_str: str) bool

Is a string readable as this option’s value type and a legal command line value?

C++: utility::options::FileOption::is_cl_value(const std::string &) const –> bool

is_group(*args, **kwargs)

Overloaded function.

  1. is_group(self: pyrosetta.rosetta.utility.options.Option, value: bool) -> pyrosetta.rosetta.utility.options.Option

C++: utility::options::Option::is_group(bool) –> class utility::options::Option &

  1. is_group(self: pyrosetta.rosetta.utility.options.Option) -> bool

Is this the synonymous option for an option group (e.g. -in:file:file)

C++: utility::options::Option::is_group() const –> bool

is_value(self: pyrosetta.rosetta.utility.options.FileOption, : str) bool

Is a string readable as this option’s value type?

C++: utility::options::FileOption::is_value(const std::string &) const –> bool

key(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) pyrosetta.rosetta.utility.options.FileOptionKey

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::key() const –> const class utility::options::FileOptionKey &

legal(*args, **kwargs)

Overloaded function.

  1. legal(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a: utility::file::FileName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal(const class utility::file::FileName &) –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

  1. legal(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal() const –> bool

legal_check(*args, **kwargs)

Overloaded function.

  1. legal_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> None

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_check() const –> void

  1. legal_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a: utility::file::FileName) -> None

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_check(const class utility::file::FileName &) const –> void

legal_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_default() const –> bool

legal_default_check(*args, **kwargs)

Overloaded function.

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> None

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_default_check() const –> void

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a: utility::file::FileName) -> None

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_default_check(const class utility::file::FileName &) const –> void

legal_default_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_default_report() const –> bool

legal_limits_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_limits_report() const –> bool

legal_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_report() const –> bool

legal_size_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_size_report() const –> bool

legal_specs_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_specs_report() const –> bool

legal_string(*args, **kwargs)

Overloaded function.

  1. legal_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, : bool) -> str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_string(const bool) const –> std::string

  1. legal_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_string() const –> std::string

legal_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a: utility::file::FileName) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::legal_value(const class utility::file::FileName &) const –> bool

lower(*args, **kwargs)

Overloaded function.

  1. lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a: utility::file::FileName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::lower(const class utility::file::FileName &) –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

  1. lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.Bound_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::lower() const –> const class utility::Bound<class utility::file::FileName> &

n_default_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) int

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::n_default_value() const –> unsigned long

n_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) int

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::n_value() const –> unsigned long

name(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::name() const –> const std::string &

static print_error_message(message: str) None
Print an error message. As a separate function to keep stream handling

from being part of the header files.

C++: utility::options::Option::print_error_message(const std::string &) –> void

raw_default_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::raw_default_string() const –> std::string

raw_value_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::raw_value_string() const –> std::string

restrict_access(self: pyrosetta.rosetta.utility.options.Option, setting: bool) pyrosetta.rosetta.utility.options.Option

Restrict direct access to option for general use.

In the past, protocols were able to access the values of options in the option system directly. However this tied protocol behavior tightly to setting specific options on the command line, making it difficult to use Rosetta using other workflows. Now, options are accessed through the resource manager, which has control over which options are passed to which protocols.

basic::resource_manager::ResourceManager::get_instance()->get_option(key);

To incrementally deprectate direct usage of options, an option is set to have restricted access in basic/options/options_rosetta.py

C++: utility::options::Option::restrict_access(bool) –> class utility::options::Option &

set_accessed(self: pyrosetta.rosetta.utility.options.Option, setting: bool) None

C++: utility::options::Option::set_accessed(bool) const –> void

set_cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_str: str) None
Value assignemt from a command line string but without

a ScalarOption & return type.

C++: utility::options::ScalarOption::set_cl_value(const std::string &) –> void

set_value(*args, **kwargs)

Overloaded function.

  1. set_value(self: pyrosetta.rosetta.utility.options.ScalarOption, value_str: str) -> None

  2. set_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_str: str, : bool) -> None

Value assignment from full string.

C++: utility::options::ScalarOption::set_value(const std::string &, bool) –> void

short_description(*args, **kwargs)

Overloaded function.

  1. short_description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::short_description() const –> const std::string &

  1. short_description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, sd: str) -> None

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::short_description(const std::string &) –> void

shortd(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, s: str) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::shortd(const std::string &) –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

size(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) int

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::size() const –> unsigned long

size_constraint_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::size_constraint_string() const –> std::string

specified_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) None

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::specified_check() const –> void

specified_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::specified_report() const –> bool

strict_lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a: utility::file::FileName) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::strict_lower(const class utility::file::FileName &) –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

strict_upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a: utility::file::FileName) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::strict_upper(const class utility::file::FileName &) –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

to_default(*args, **kwargs)

Overloaded function.

  1. to_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::to_default() –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

  1. to_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Set to default value, if any

C++: utility::options::ScalarOption::to_default() –> class utility::options::ScalarOption &

type_string(self: pyrosetta.rosetta.utility.options.FileOption) str

Option type code string representation

C++: utility::options::FileOption::type_string() const –> std::string

upper(*args, **kwargs)

Overloaded function.

  1. upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a: utility::file::FileName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::upper(const class utility::file::FileName &) –> class utility::options::ScalarOption_T_<class utility::options::FileOptionKey, class utility::file::FileName> &

  1. upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.Bound_utility_file_FileName_t

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::upper() –> const class utility::Bound<class utility::file::FileName> &

user(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::user() const –> bool

user_or(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a: utility::file::FileName) utility::file::FileName

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::user_or(const class utility::file::FileName &) const –> class utility::file::FileName

value(*args, **kwargs)

Overloaded function.

  1. value(self: pyrosetta.rosetta.utility.options.FileOption) -> pyrosetta.rosetta.utility.file.FileName

  2. value(self: pyrosetta.rosetta.utility.options.FileOption, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t

  3. value(self: pyrosetta.rosetta.utility.options.FileOption, value_a: str) -> pyrosetta.rosetta.utility.options.FileOption

Value assignment

C++: utility::options::FileOption::value(const std::string &) –> class utility::options::FileOption &

value_or(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a: utility::file::FileName) utility::file::FileName

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::value_or(const class utility::file::FileName &) const –> class utility::file::FileName

value_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) str

C++: utility::options::ScalarOption_T_<utility::options::FileOptionKey, utility::file::FileName>::value_string() const –> std::string

class pyrosetta.rosetta.utility.options.FileOptionKey

Bases: pyrosetta.rosetta.utility.options.ScalarOptionKey

Automatic hidden index key for file options

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: pyrosetta.rosetta.utility.options.FileOptionKey, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.options.FileOptionKey

Key assignment

C++: utility::options::FileOptionKey::operator=(const class utility::keys::Key &) –> class utility::options::FileOptionKey &

  1. assign(self: pyrosetta.rosetta.utility.options.FileOptionKey, : pyrosetta.rosetta.utility.options.FileOptionKey) -> pyrosetta.rosetta.utility.options.FileOptionKey

C++: utility::options::FileOptionKey::operator=(const class utility::options::FileOptionKey &) –> class utility::options::FileOptionKey &

clone(self: pyrosetta.rosetta.utility.options.FileOptionKey) pyrosetta.rosetta.utility.options.FileOptionKey

Clone this

C++: utility::options::FileOptionKey::clone() const –> class utility::options::FileOptionKey *

code(*args, **kwargs)

Overloaded function.

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Code

C++: utility::keys::Key::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const std::string &) –> class utility::keys::Key &

id(*args, **kwargs)

Overloaded function.

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

ID

C++: utility::keys::Key::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const std::string &) –> class utility::keys::Key &

identifier(*args, **kwargs)

Overloaded function.

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> class utility::keys::Key &

static n_key() int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

scalar(self: pyrosetta.rosetta.utility.options.ScalarOptionKey) bool

Scalar option key?

C++: utility::options::ScalarOptionKey::scalar() const –> bool

vector(self: pyrosetta.rosetta.utility.options.ScalarOptionKey) bool

Vector option key?

C++: utility::options::ScalarOptionKey::vector() const –> bool

class pyrosetta.rosetta.utility.options.FileVectorOption

Bases: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

Program file vector option class

activate(*args, **kwargs)

Overloaded function.

  1. activate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::activate() –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. activate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.VectorOption

Activate

C++: utility::options::VectorOption::activate() –> class utility::options::VectorOption &

active(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::active() const –> bool

assign(self: pyrosetta.rosetta.utility.options.FileVectorOption, : pyrosetta.rosetta.utility.options.FileVectorOption) pyrosetta.rosetta.utility.options.FileVectorOption

C++: utility::options::FileVectorOption::operator=(const class utility::options::FileVectorOption &) –> class utility::options::FileVectorOption &

been_accessed(self: pyrosetta.rosetta.utility.options.Option) None

Set access property to true.

C++: utility::options::Option::been_accessed() const –> void

begin(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) __gnu_cxx::__normal_iterator<utility::file::FileName const*, std::vector<utility::file::FileName, std::allocator<utility::file::FileName> > >

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::begin() const –> class __gnu_cxx::__normal_iterator<const class utility::file::FileName *, class std::vector<class utility::file::FileName, class std::allocator<class utility::file::FileName> > >

can_hold_another(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::can_hold_another() const –> bool

check_restricted_access(self: pyrosetta.rosetta.utility.options.Option, do_check: bool) None

C++: utility::options::Option::check_restricted_access(bool) const –> void

cl_value(*args, **kwargs)

Overloaded function.

  1. cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_str: str) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::cl_value(const std::string &) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_str: str) -> pyrosetta.rosetta.utility.options.VectorOption

Value assignment from a command line string

C++: utility::options::VectorOption::cl_value(const std::string &) –> class utility::options::VectorOption &

clear(*args, **kwargs)

Overloaded function.

  1. clear(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::clear() –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. clear(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.VectorOption

Clear

C++: utility::options::VectorOption::clear() –> class utility::options::VectorOption &

clone(self: pyrosetta.rosetta.utility.options.FileVectorOption) pyrosetta.rosetta.utility.options.FileVectorOption

Clone this

C++: utility::options::FileVectorOption::clone() const –> class utility::options::FileVectorOption *

code(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::code() const –> const std::string &

copy_from(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, other: pyrosetta.rosetta.utility.options.Option) None

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::copy_from(const class utility::options::Option &) –> void

deactivate(*args, **kwargs)

Overloaded function.

  1. deactivate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::deactivate() –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. deactivate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.VectorOption

Deactivate

C++: utility::options::VectorOption::deactivate() –> class utility::options::VectorOption &

def(*args, **kwargs)

Overloaded function.

  1. def(self: pyrosetta.rosetta.utility.options.FileVectorOption, value_a: pyrosetta.rosetta.utility.vector1_utility_file_FileName) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

  2. def(self: pyrosetta.rosetta.utility.options.FileVectorOption) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

  3. def(self: pyrosetta.rosetta.utility.options.FileVectorOption, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

  4. def(self: pyrosetta.rosetta.utility.options.FileVectorOption, value_a: str) -> pyrosetta.rosetta.utility.options.FileVectorOption

Default value assignment

C++: utility::options::FileVectorOption::def(const std::string &) –> class utility::options::FileVectorOption &

default_active(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::default_active() const –> bool

default_inactive(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::default_inactive() const –> bool

default_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) int

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::default_size() const –> unsigned long

default_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::default_string() const –> std::string

default_to(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, option: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::default_to(const class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

default_value(*args, **kwargs)

Overloaded function.

  1. default_value(self: pyrosetta.rosetta.utility.options.FileVectorOption, i: int) -> pyrosetta.rosetta.utility.file.FileName

  2. default_value(self: pyrosetta.rosetta.utility.options.FileVectorOption) -> pyrosetta.rosetta.utility.vector1_utility_file_FileName

  3. default_value(self: pyrosetta.rosetta.utility.options.FileVectorOption, value_a: pyrosetta.rosetta.utility.vector1_utility_file_FileName) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

  4. default_value(self: pyrosetta.rosetta.utility.options.FileVectorOption, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

  5. default_value(self: pyrosetta.rosetta.utility.options.FileVectorOption, value_a: str) -> pyrosetta.rosetta.utility.options.FileVectorOption

Default value assignment

C++: utility::options::FileVectorOption::default_value(const std::string &) –> class utility::options::FileVectorOption &

description(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::description() const –> const std::string &

end(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) __gnu_cxx::__normal_iterator<utility::file::FileName const*, std::vector<utility::file::FileName, std::allocator<utility::file::FileName> > >

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::end() const –> class __gnu_cxx::__normal_iterator<const class utility::file::FileName *, class std::vector<class utility::file::FileName, class std::allocator<class utility::file::FileName> > >

equals_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::equals_string() const –> std::string

fixed_size(*args, **kwargs)

Overloaded function.

  1. fixed_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::fixed_size() const –> bool

  1. fixed_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

Fixed number of values required?

C++: utility::options::VectorOption::fixed_size() const –> bool

has_any_of_characters(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, str1: str, s: str) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::has_any_of_characters(const std::string &, const std::string &) const –> bool

has_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::has_default() const –> bool

has_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value: pyrosetta.rosetta.utility.file.FileName) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::has_value(const class utility::file::FileName &) –> bool

id(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::id() const –> const std::string &

identifier(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::identifier() const –> const std::string &

is_been_accessed(self: pyrosetta.rosetta.utility.options.Option) bool

Return true if option value was anyhow accessed.

C++: utility::options::Option::is_been_accessed() const –> bool

is_cl_value(self: pyrosetta.rosetta.utility.options.FileVectorOption, value_str: str) bool

Is a string readable as this option’s value type and a legal command line value?

C++: utility::options::FileVectorOption::is_cl_value(const std::string &) const –> bool

is_group(*args, **kwargs)

Overloaded function.

  1. is_group(self: pyrosetta.rosetta.utility.options.Option, value: bool) -> pyrosetta.rosetta.utility.options.Option

C++: utility::options::Option::is_group(bool) –> class utility::options::Option &

  1. is_group(self: pyrosetta.rosetta.utility.options.Option) -> bool

Is this the synonymous option for an option group (e.g. -in:file:file)

C++: utility::options::Option::is_group() const –> bool

is_value(self: pyrosetta.rosetta.utility.options.FileVectorOption, : str) bool

Is a string readable as this option’s value type?

C++: utility::options::FileVectorOption::is_value(const std::string &) const –> bool

key(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) pyrosetta.rosetta.utility.options.FileVectorOptionKey

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::key() const –> const class utility::options::FileVectorOptionKey &

legal(*args, **kwargs)

Overloaded function.

  1. legal(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal(const class utility::file::FileName &) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. legal(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal() const –> bool

legal_check(*args, **kwargs)

Overloaded function.

  1. legal_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> None

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_check() const –> void

  1. legal_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.file.FileName) -> None

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_check(const class utility::file::FileName &) const –> void

legal_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_default() const –> bool

legal_default_check(*args, **kwargs)

Overloaded function.

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> None

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_default_check() const –> void

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.file.FileName) -> None

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_default_check(const class utility::file::FileName &) const –> void

legal_default_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_default_report() const –> bool

legal_default_size(*args, **kwargs)

Overloaded function.

  1. legal_default_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_default_size() const –> bool

  1. legal_default_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

Legal default value size?

C++: utility::options::VectorOption::legal_default_size() const –> bool

legal_default_value(*args, **kwargs)

Overloaded function.

  1. legal_default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_default_value() const –> bool

  1. legal_default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

Legal or inactive default value?

C++: utility::options::VectorOption::legal_default_value() const –> bool

legal_limits_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_limits_report() const –> bool

legal_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_report() const –> bool

legal_size(*args, **kwargs)

Overloaded function.

  1. legal_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_size() const –> bool

  1. legal_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

Legal value size?

C++: utility::options::VectorOption::legal_size() const –> bool

legal_size_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_size_report() const –> bool

legal_specs_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_specs_report() const –> bool

legal_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_string() const –> std::string

legal_value(*args, **kwargs)

Overloaded function.

  1. legal_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_value() const –> bool

  1. legal_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.file.FileName) -> bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::legal_value(const class utility::file::FileName &) const –> bool

  1. legal_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool

Legal value?

C++: utility::options::VectorOption::legal_value() const –> bool

lower(*args, **kwargs)

Overloaded function.

  1. lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::lower(const class utility::file::FileName &) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.Bound_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::lower() const –> const class utility::Bound<class utility::file::FileName> &

n(*args, **kwargs)

Overloaded function.

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::n(const unsigned long) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::n() const –> unsigned long

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption

Fixed number of values required assignment

C++: utility::options::VectorOption::n(const unsigned long) –> class utility::options::VectorOption &

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int

Fixed number of values required (zero if none)

C++: utility::options::VectorOption::n() const –> unsigned long

n_default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) int

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::n_default_value() const –> unsigned long

n_lower(*args, **kwargs)

Overloaded function.

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::n_lower(const unsigned long) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::n_lower() const –> unsigned long

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption

Lower number of values allowed assignment

C++: utility::options::VectorOption::n_lower(const unsigned long) –> class utility::options::VectorOption &

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int

Lower number of values allowed (zero if none)

C++: utility::options::VectorOption::n_lower() const –> unsigned long

n_upper(*args, **kwargs)

Overloaded function.

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::n_upper(const unsigned long) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::n_upper() const –> unsigned long

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption

Upper number of values allowed assignment

C++: utility::options::VectorOption::n_upper(const unsigned long) –> class utility::options::VectorOption &

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int

Upper number of values allowed (zero if none)

C++: utility::options::VectorOption::n_upper() const –> unsigned long

n_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) int

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::n_value() const –> unsigned long

name(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::name() const –> const std::string &

static print_error_message(message: str) None
Print an error message. As a separate function to keep stream handling

from being part of the header files.

C++: utility::options::Option::print_error_message(const std::string &) –> void

push_back(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.file.FileName) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::push_back(const class utility::file::FileName &) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

raw_default_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::raw_default_string() const –> std::string

raw_value_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::raw_value_string() const –> std::string

restrict_access(self: pyrosetta.rosetta.utility.options.Option, setting: bool) pyrosetta.rosetta.utility.options.Option

Restrict direct access to option for general use.

In the past, protocols were able to access the values of options in the option system directly. However this tied protocol behavior tightly to setting specific options on the command line, making it difficult to use Rosetta using other workflows. Now, options are accessed through the resource manager, which has control over which options are passed to which protocols.

basic::resource_manager::ResourceManager::get_instance()->get_option(key);

To incrementally deprectate direct usage of options, an option is set to have restricted access in basic/options/options_rosetta.py

C++: utility::options::Option::restrict_access(bool) –> class utility::options::Option &

set_accessed(self: pyrosetta.rosetta.utility.options.Option, setting: bool) None

C++: utility::options::Option::set_accessed(bool) const –> void

set_cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_str: str) None

C++: utility::options::VectorOption::set_cl_value(const std::string &) –> void

set_value(*args, **kwargs)

Overloaded function.

  1. set_value(self: pyrosetta.rosetta.utility.options.VectorOption, value_str: str) -> None

  2. set_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_str: str, reset: bool) -> None

Value assignemt from a command line string but without

a VectorOption & return type. This will separate arguments by whitespace and set the vector option accordingly. If reset is true, the current values will be cleared first.

C++: utility::options::VectorOption::set_value(const std::string &, bool) –> void

short_description(*args, **kwargs)

Overloaded function.

  1. short_description(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::short_description() const –> const std::string &

  1. short_description(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, sd: str) -> None

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::short_description(const std::string &) –> void

shortd(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, s: str) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::shortd(const std::string &) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) int

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::size() const –> unsigned long

size_constraint_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::size_constraint_string() const –> std::string

specified_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) None

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::specified_check() const –> void

specified_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::specified_report() const –> bool

strict_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.file.FileName) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::strict_lower(const class utility::file::FileName &) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

strict_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.file.FileName) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::strict_upper(const class utility::file::FileName &) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

to_default(*args, **kwargs)

Overloaded function.

  1. to_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::to_default() –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. to_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.options.VectorOption

Set to default value, if any

C++: utility::options::VectorOption::to_default() –> class utility::options::VectorOption &

type_string(self: pyrosetta.rosetta.utility.options.FileVectorOption) str

Option type code string representation

C++: utility::options::FileVectorOption::type_string() const –> std::string

upper(*args, **kwargs)

Overloaded function.

  1. upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::upper(const class utility::file::FileName &) –> class utility::options::VectorOption_T_<class utility::options::FileVectorOptionKey, class utility::file::FileName> &

  1. upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> pyrosetta.rosetta.utility.Bound_utility_file_FileName_t

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::upper() –> const class utility::Bound<class utility::file::FileName> &

user(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) bool

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::user() const –> bool

user_or(*args, **kwargs)

Overloaded function.

  1. user_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.vector1_utility_file_FileName) -> pyrosetta.rosetta.utility.vector1_utility_file_FileName

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::user_or(const class utility::vector1<class utility::file::FileName, class std::allocator<class utility::file::FileName> > &) const –> class utility::vector1<class utility::file::FileName, class std::allocator<class utility::file::FileName> >

  1. user_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i: int, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.file.FileName

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::user_or(const unsigned long, const class utility::file::FileName &) const –> class utility::file::FileName

value(*args, **kwargs)

Overloaded function.

  1. value(self: pyrosetta.rosetta.utility.options.FileVectorOption, i: int) -> pyrosetta.rosetta.utility.file.FileName

  2. value(self: pyrosetta.rosetta.utility.options.FileVectorOption) -> pyrosetta.rosetta.utility.vector1_utility_file_FileName

  3. value(self: pyrosetta.rosetta.utility.options.FileVectorOption, value_a: pyrosetta.rosetta.utility.vector1_utility_file_FileName) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

  4. value(self: pyrosetta.rosetta.utility.options.FileVectorOption, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t

  5. value(self: pyrosetta.rosetta.utility.options.FileVectorOption, value_a: str) -> pyrosetta.rosetta.utility.options.FileVectorOption

Value assignment

C++: utility::options::FileVectorOption::value(const std::string &) –> class utility::options::FileVectorOption &

value_or(*args, **kwargs)

Overloaded function.

  1. value_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a: pyrosetta.rosetta.utility.vector1_utility_file_FileName) -> pyrosetta.rosetta.utility.vector1_utility_file_FileName

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::value_or(const class utility::vector1<class utility::file::FileName, class std::allocator<class utility::file::FileName> > &) const –> class utility::vector1<class utility::file::FileName, class std::allocator<class utility::file::FileName> >

  1. value_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i: int, value_a: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.file.FileName

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::value_or(const unsigned long, const class utility::file::FileName &) const –> class utility::file::FileName

value_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) str

C++: utility::options::VectorOption_T_<utility::options::FileVectorOptionKey, utility::file::FileName>::value_string() const –> std::string

class pyrosetta.rosetta.utility.options.FileVectorOptionKey

Bases: pyrosetta.rosetta.utility.options.VectorOptionKey

Automatic hidden index key for file options

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: pyrosetta.rosetta.utility.options.FileVectorOptionKey, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.options.FileVectorOptionKey

Key assignment

C++: utility::options::FileVectorOptionKey::operator=(const class utility::keys::Key &) –> class utility::options::FileVectorOptionKey &

  1. assign(self: pyrosetta.rosetta.utility.options.FileVectorOptionKey, : pyrosetta.rosetta.utility.options.FileVectorOptionKey) -> pyrosetta.rosetta.utility.options.FileVectorOptionKey

C++: utility::options::FileVectorOptionKey::operator=(const class utility::options::FileVectorOptionKey &) –> class utility::options::FileVectorOptionKey &

clone(self: pyrosetta.rosetta.utility.options.FileVectorOptionKey) pyrosetta.rosetta.utility.options.FileVectorOptionKey

Clone this

C++: utility::options::FileVectorOptionKey::clone() const –> class utility::options::FileVectorOptionKey *

code(*args, **kwargs)

Overloaded function.

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Code

C++: utility::keys::Key::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const std::string &) –> class utility::keys::Key &

id(*args, **kwargs)

Overloaded function.

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

ID

C++: utility::keys::Key::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const std::string &) –> class utility::keys::Key &

identifier(*args, **kwargs)

Overloaded function.

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> class utility::keys::Key &

static n_key() int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

scalar(self: pyrosetta.rosetta.utility.options.VectorOptionKey) bool

Scalar option key?

C++: utility::options::VectorOptionKey::scalar() const –> bool

vector(self: pyrosetta.rosetta.utility.options.VectorOptionKey) bool

Vector option key?

C++: utility::options::VectorOptionKey::vector() const –> bool

class pyrosetta.rosetta.utility.options.IntegerOption

Bases: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

Program integer option class

activate(*args, **kwargs)

Overloaded function.

  1. activate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::activate() –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

  1. activate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Activate

C++: utility::options::ScalarOption::activate() –> class utility::options::ScalarOption &

active(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::active() const –> bool

assign(self: pyrosetta.rosetta.utility.options.IntegerOption, : pyrosetta.rosetta.utility.options.IntegerOption) pyrosetta.rosetta.utility.options.IntegerOption

C++: utility::options::IntegerOption::operator=(const class utility::options::IntegerOption &) –> class utility::options::IntegerOption &

been_accessed(self: pyrosetta.rosetta.utility.options.Option) None

Set access property to true.

C++: utility::options::Option::been_accessed() const –> void

can_hold_another(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::can_hold_another() const –> bool

check_restricted_access(self: pyrosetta.rosetta.utility.options.Option, do_check: bool) None

C++: utility::options::Option::check_restricted_access(bool) const –> void

cl_value(*args, **kwargs)

Overloaded function.

  1. cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_str: str) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::cl_value(const std::string &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

  1. cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_str: str) -> pyrosetta.rosetta.utility.options.ScalarOption

Value assignment from a command line string

C++: utility::options::ScalarOption::cl_value(const std::string &) –> class utility::options::ScalarOption &

clear(*args, **kwargs)

Overloaded function.

  1. clear(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::clear() –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

  1. clear(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Clear

C++: utility::options::ScalarOption::clear() –> class utility::options::ScalarOption &

clone(self: pyrosetta.rosetta.utility.options.IntegerOption) pyrosetta.rosetta.utility.options.IntegerOption

Clone this

C++: utility::options::IntegerOption::clone() const –> class utility::options::IntegerOption *

code(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::code() const –> const std::string &

copy_from(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, other: pyrosetta.rosetta.utility.options.Option) None

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::copy_from(const class utility::options::Option &) –> void

deactivate(*args, **kwargs)

Overloaded function.

  1. deactivate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::deactivate() –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

  1. deactivate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Deactivate

C++: utility::options::ScalarOption::deactivate() –> class utility::options::ScalarOption &

def(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::def(const int &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

default_active(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::default_active() const –> bool

default_inactive(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::default_inactive() const –> bool

default_size(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) int

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::default_size() const –> unsigned long

default_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::default_string() const –> std::string

default_to(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, option: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::default_to(const class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

default_value(*args, **kwargs)

Overloaded function.

  1. default_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::default_value(const int &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

  1. default_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::default_value() const –> const int &

description(*args, **kwargs)

Overloaded function.

  1. description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::description() const –> const std::string &

  1. description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, sd: str) -> None

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::description(const std::string &) –> void

equals_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::equals_string() const –> std::string

has_any_of_characters(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, str1: str, s: str) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::has_any_of_characters(const std::string &, const std::string &) const –> bool

has_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::has_default() const –> bool

id(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::id() const –> const std::string &

identifier(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::identifier() const –> const std::string &

is_been_accessed(self: pyrosetta.rosetta.utility.options.Option) bool

Return true if option value was anyhow accessed.

C++: utility::options::Option::is_been_accessed() const –> bool

is_cl_value(self: pyrosetta.rosetta.utility.options.IntegerOption, value_str: str) bool

Is a string readable as this option’s value type and a legal command line value?

C++: utility::options::IntegerOption::is_cl_value(const std::string &) const –> bool

is_group(*args, **kwargs)

Overloaded function.

  1. is_group(self: pyrosetta.rosetta.utility.options.Option, value: bool) -> pyrosetta.rosetta.utility.options.Option

C++: utility::options::Option::is_group(bool) –> class utility::options::Option &

  1. is_group(self: pyrosetta.rosetta.utility.options.Option) -> bool

Is this the synonymous option for an option group (e.g. -in:file:file)

C++: utility::options::Option::is_group() const –> bool

is_value(self: pyrosetta.rosetta.utility.options.IntegerOption, value_str: str) bool

Is a string readable as this option’s value type?

C++: utility::options::IntegerOption::is_value(const std::string &) const –> bool

key(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) pyrosetta.rosetta.utility.options.IntegerOptionKey

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::key() const –> const class utility::options::IntegerOptionKey &

legal(*args, **kwargs)

Overloaded function.

  1. legal(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal(const int &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

  1. legal(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal() const –> bool

legal_check(*args, **kwargs)

Overloaded function.

  1. legal_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> None

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_check() const –> void

  1. legal_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) -> None

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_check(const int &) const –> void

legal_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_default() const –> bool

legal_default_check(*args, **kwargs)

Overloaded function.

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> None

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_default_check() const –> void

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) -> None

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_default_check(const int &) const –> void

legal_default_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_default_report() const –> bool

legal_limits_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_limits_report() const –> bool

legal_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_report() const –> bool

legal_size_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_size_report() const –> bool

legal_specs_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_specs_report() const –> bool

legal_string(*args, **kwargs)

Overloaded function.

  1. legal_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, : bool) -> str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_string(const bool) const –> std::string

  1. legal_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_string() const –> std::string

legal_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::legal_value(const int &) const –> bool

lower(*args, **kwargs)

Overloaded function.

  1. lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::lower(const int &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

  1. lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> pyrosetta.rosetta.utility.Bound_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::lower() const –> const class utility::Bound<int> &

n_default_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) int

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::n_default_value() const –> unsigned long

n_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) int

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::n_value() const –> unsigned long

name(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::name() const –> const std::string &

static print_error_message(message: str) None
Print an error message. As a separate function to keep stream handling

from being part of the header files.

C++: utility::options::Option::print_error_message(const std::string &) –> void

raw_default_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::raw_default_string() const –> std::string

raw_value_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::raw_value_string() const –> std::string

restrict_access(self: pyrosetta.rosetta.utility.options.Option, setting: bool) pyrosetta.rosetta.utility.options.Option

Restrict direct access to option for general use.

In the past, protocols were able to access the values of options in the option system directly. However this tied protocol behavior tightly to setting specific options on the command line, making it difficult to use Rosetta using other workflows. Now, options are accessed through the resource manager, which has control over which options are passed to which protocols.

basic::resource_manager::ResourceManager::get_instance()->get_option(key);

To incrementally deprectate direct usage of options, an option is set to have restricted access in basic/options/options_rosetta.py

C++: utility::options::Option::restrict_access(bool) –> class utility::options::Option &

set_accessed(self: pyrosetta.rosetta.utility.options.Option, setting: bool) None

C++: utility::options::Option::set_accessed(bool) const –> void

set_cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_str: str) None
Value assignemt from a command line string but without

a ScalarOption & return type.

C++: utility::options::ScalarOption::set_cl_value(const std::string &) –> void

set_value(*args, **kwargs)

Overloaded function.

  1. set_value(self: pyrosetta.rosetta.utility.options.ScalarOption, value_str: str) -> None

  2. set_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_str: str, : bool) -> None

Value assignment from full string.

C++: utility::options::ScalarOption::set_value(const std::string &, bool) –> void

short_description(*args, **kwargs)

Overloaded function.

  1. short_description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::short_description() const –> const std::string &

  1. short_description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, sd: str) -> None

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::short_description(const std::string &) –> void

shortd(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, s: str) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::shortd(const std::string &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

size(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) int

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::size() const –> unsigned long

size_constraint_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::size_constraint_string() const –> std::string

specified_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) None

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::specified_check() const –> void

specified_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::specified_report() const –> bool

strict_lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::strict_lower(const int &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

strict_upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::strict_upper(const int &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

to_default(*args, **kwargs)

Overloaded function.

  1. to_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::to_default() –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

  1. to_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Set to default value, if any

C++: utility::options::ScalarOption::to_default() –> class utility::options::ScalarOption &

type_string(self: pyrosetta.rosetta.utility.options.IntegerOption) str

Option type code string representation

C++: utility::options::IntegerOption::type_string() const –> std::string

upper(*args, **kwargs)

Overloaded function.

  1. upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::upper(const int &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

  1. upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> pyrosetta.rosetta.utility.Bound_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::upper() –> const class utility::Bound<int> &

user(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) bool

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::user() const –> bool

user_or(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) int

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::user_or(const int &) const –> int

value(*args, **kwargs)

Overloaded function.

  1. value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::value(const int &) –> class utility::options::ScalarOption_T_<class utility::options::IntegerOptionKey, int> &

  1. value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::value() const –> const int &

value_or(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a: int) int

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::value_or(const int &) const –> int

value_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) str

C++: utility::options::ScalarOption_T_<utility::options::IntegerOptionKey, int>::value_string() const –> std::string

class pyrosetta.rosetta.utility.options.IntegerOptionKey

Bases: pyrosetta.rosetta.utility.options.ScalarOptionKey

Automatic hidden index key for integer options

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: pyrosetta.rosetta.utility.options.IntegerOptionKey, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.options.IntegerOptionKey

Key assignment

C++: utility::options::IntegerOptionKey::operator=(const class utility::keys::Key &) –> class utility::options::IntegerOptionKey &

  1. assign(self: pyrosetta.rosetta.utility.options.IntegerOptionKey, : pyrosetta.rosetta.utility.options.IntegerOptionKey) -> pyrosetta.rosetta.utility.options.IntegerOptionKey

C++: utility::options::IntegerOptionKey::operator=(const class utility::options::IntegerOptionKey &) –> class utility::options::IntegerOptionKey &

clone(self: pyrosetta.rosetta.utility.options.IntegerOptionKey) pyrosetta.rosetta.utility.options.IntegerOptionKey

Clone this

C++: utility::options::IntegerOptionKey::clone() const –> class utility::options::IntegerOptionKey *

code(*args, **kwargs)

Overloaded function.

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Code

C++: utility::keys::Key::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const std::string &) –> class utility::keys::Key &

id(*args, **kwargs)

Overloaded function.

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

ID

C++: utility::keys::Key::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const std::string &) –> class utility::keys::Key &

identifier(*args, **kwargs)

Overloaded function.

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> class utility::keys::Key &

static n_key() int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

scalar(self: pyrosetta.rosetta.utility.options.ScalarOptionKey) bool

Scalar option key?

C++: utility::options::ScalarOptionKey::scalar() const –> bool

vector(self: pyrosetta.rosetta.utility.options.ScalarOptionKey) bool

Vector option key?

C++: utility::options::ScalarOptionKey::vector() const –> bool

class pyrosetta.rosetta.utility.options.IntegerVectorOption

Bases: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

Program integer vector option class

activate(*args, **kwargs)

Overloaded function.

  1. activate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::activate() –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. activate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.options.VectorOption

Activate

C++: utility::options::VectorOption::activate() –> class utility::options::VectorOption &

active(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::active() const –> bool

assign(self: pyrosetta.rosetta.utility.options.IntegerVectorOption, : pyrosetta.rosetta.utility.options.IntegerVectorOption) pyrosetta.rosetta.utility.options.IntegerVectorOption

C++: utility::options::IntegerVectorOption::operator=(const class utility::options::IntegerVectorOption &) –> class utility::options::IntegerVectorOption &

been_accessed(self: pyrosetta.rosetta.utility.options.Option) None

Set access property to true.

C++: utility::options::Option::been_accessed() const –> void

begin(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) __gnu_cxx::__normal_iterator<int const*, std::vector<int, std::allocator<int> > >

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::begin() const –> class __gnu_cxx::__normal_iterator<const int *, class std::vector<int, class std::allocator<int> > >

can_hold_another(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::can_hold_another() const –> bool

check_restricted_access(self: pyrosetta.rosetta.utility.options.Option, do_check: bool) None

C++: utility::options::Option::check_restricted_access(bool) const –> void

cl_value(*args, **kwargs)

Overloaded function.

  1. cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_str: str) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::cl_value(const std::string &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_str: str) -> pyrosetta.rosetta.utility.options.VectorOption

Value assignment from a command line string

C++: utility::options::VectorOption::cl_value(const std::string &) –> class utility::options::VectorOption &

clear(*args, **kwargs)

Overloaded function.

  1. clear(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::clear() –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. clear(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.options.VectorOption

Clear

C++: utility::options::VectorOption::clear() –> class utility::options::VectorOption &

clone(self: pyrosetta.rosetta.utility.options.IntegerVectorOption) pyrosetta.rosetta.utility.options.IntegerVectorOption

Clone this

C++: utility::options::IntegerVectorOption::clone() const –> class utility::options::IntegerVectorOption *

code(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::code() const –> const std::string &

copy_from(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, other: pyrosetta.rosetta.utility.options.Option) None

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::copy_from(const class utility::options::Option &) –> void

deactivate(*args, **kwargs)

Overloaded function.

  1. deactivate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::deactivate() –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. deactivate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.options.VectorOption

Deactivate

C++: utility::options::VectorOption::deactivate() –> class utility::options::VectorOption &

def(*args, **kwargs)

Overloaded function.

  1. def(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::def(const int &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. def(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::def() –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. def(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: pyrosetta.rosetta.utility.vector1_int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::def(const class utility::vector1<int, class std::allocator<int> > &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

default_active(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::default_active() const –> bool

default_inactive(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::default_inactive() const –> bool

default_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::default_size() const –> unsigned long

default_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::default_string() const –> std::string

default_to(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, option: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::default_to(const class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

default_value(*args, **kwargs)

Overloaded function.

  1. default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::default_value(const int &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: pyrosetta.rosetta.utility.vector1_int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::default_value(const class utility::vector1<int, class std::allocator<int> > &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.vector1_int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::default_value() const –> const class utility::vector1<int, class std::allocator<int> > &

  1. default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i: int) -> int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::default_value(const unsigned long) const –> const int &

description(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::description() const –> const std::string &

end(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) __gnu_cxx::__normal_iterator<int const*, std::vector<int, std::allocator<int> > >

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::end() const –> class __gnu_cxx::__normal_iterator<const int *, class std::vector<int, class std::allocator<int> > >

equals_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::equals_string() const –> std::string

fixed_size(*args, **kwargs)

Overloaded function.

  1. fixed_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::fixed_size() const –> bool

  1. fixed_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

Fixed number of values required?

C++: utility::options::VectorOption::fixed_size() const –> bool

has_any_of_characters(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, str1: str, s: str) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::has_any_of_characters(const std::string &, const std::string &) const –> bool

has_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::has_default() const –> bool

has_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value: int) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::has_value(const int &) –> bool

id(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::id() const –> const std::string &

identifier(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::identifier() const –> const std::string &

is_been_accessed(self: pyrosetta.rosetta.utility.options.Option) bool

Return true if option value was anyhow accessed.

C++: utility::options::Option::is_been_accessed() const –> bool

is_cl_value(self: pyrosetta.rosetta.utility.options.IntegerVectorOption, value_str: str) bool

Is a string readable as this option’s value type and a legal command line value?

C++: utility::options::IntegerVectorOption::is_cl_value(const std::string &) const –> bool

is_group(*args, **kwargs)

Overloaded function.

  1. is_group(self: pyrosetta.rosetta.utility.options.Option, value: bool) -> pyrosetta.rosetta.utility.options.Option

C++: utility::options::Option::is_group(bool) –> class utility::options::Option &

  1. is_group(self: pyrosetta.rosetta.utility.options.Option) -> bool

Is this the synonymous option for an option group (e.g. -in:file:file)

C++: utility::options::Option::is_group() const –> bool

is_value(self: pyrosetta.rosetta.utility.options.IntegerVectorOption, value_str: str) bool

Is a string readable as this option’s value type?

C++: utility::options::IntegerVectorOption::is_value(const std::string &) const –> bool

key(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) pyrosetta.rosetta.utility.options.IntegerVectorOptionKey

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::key() const –> const class utility::options::IntegerVectorOptionKey &

legal(*args, **kwargs)

Overloaded function.

  1. legal(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal(const int &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. legal(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal() const –> bool

legal_check(*args, **kwargs)

Overloaded function.

  1. legal_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> None

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_check() const –> void

  1. legal_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) -> None

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_check(const int &) const –> void

legal_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_default() const –> bool

legal_default_check(*args, **kwargs)

Overloaded function.

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> None

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_default_check() const –> void

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) -> None

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_default_check(const int &) const –> void

legal_default_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_default_report() const –> bool

legal_default_size(*args, **kwargs)

Overloaded function.

  1. legal_default_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_default_size() const –> bool

  1. legal_default_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

Legal default value size?

C++: utility::options::VectorOption::legal_default_size() const –> bool

legal_default_value(*args, **kwargs)

Overloaded function.

  1. legal_default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_default_value() const –> bool

  1. legal_default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

Legal or inactive default value?

C++: utility::options::VectorOption::legal_default_value() const –> bool

legal_limits_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_limits_report() const –> bool

legal_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_report() const –> bool

legal_size(*args, **kwargs)

Overloaded function.

  1. legal_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_size() const –> bool

  1. legal_size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

Legal value size?

C++: utility::options::VectorOption::legal_size() const –> bool

legal_size_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_size_report() const –> bool

legal_specs_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_specs_report() const –> bool

legal_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_string() const –> std::string

legal_value(*args, **kwargs)

Overloaded function.

  1. legal_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_value() const –> bool

  1. legal_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) -> bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::legal_value(const int &) const –> bool

  1. legal_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool

Legal value?

C++: utility::options::VectorOption::legal_value() const –> bool

lower(*args, **kwargs)

Overloaded function.

  1. lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::lower(const int &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.Bound_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::lower() const –> const class utility::Bound<int> &

n(*args, **kwargs)

Overloaded function.

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::n(const unsigned long) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::n() const –> unsigned long

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption

Fixed number of values required assignment

C++: utility::options::VectorOption::n(const unsigned long) –> class utility::options::VectorOption &

  1. n(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int

Fixed number of values required (zero if none)

C++: utility::options::VectorOption::n() const –> unsigned long

n_default_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::n_default_value() const –> unsigned long

n_lower(*args, **kwargs)

Overloaded function.

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::n_lower(const unsigned long) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::n_lower() const –> unsigned long

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption

Lower number of values allowed assignment

C++: utility::options::VectorOption::n_lower(const unsigned long) –> class utility::options::VectorOption &

  1. n_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int

Lower number of values allowed (zero if none)

C++: utility::options::VectorOption::n_lower() const –> unsigned long

n_upper(*args, **kwargs)

Overloaded function.

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::n_upper(const unsigned long) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::n_upper() const –> unsigned long

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a: int) -> pyrosetta.rosetta.utility.options.VectorOption

Upper number of values allowed assignment

C++: utility::options::VectorOption::n_upper(const unsigned long) –> class utility::options::VectorOption &

  1. n_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int

Upper number of values allowed (zero if none)

C++: utility::options::VectorOption::n_upper() const –> unsigned long

n_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::n_value() const –> unsigned long

name(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::name() const –> const std::string &

static print_error_message(message: str) None
Print an error message. As a separate function to keep stream handling

from being part of the header files.

C++: utility::options::Option::print_error_message(const std::string &) –> void

push_back(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::push_back(const int &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

raw_default_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::raw_default_string() const –> std::string

raw_value_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::raw_value_string() const –> std::string

restrict_access(self: pyrosetta.rosetta.utility.options.Option, setting: bool) pyrosetta.rosetta.utility.options.Option

Restrict direct access to option for general use.

In the past, protocols were able to access the values of options in the option system directly. However this tied protocol behavior tightly to setting specific options on the command line, making it difficult to use Rosetta using other workflows. Now, options are accessed through the resource manager, which has control over which options are passed to which protocols.

basic::resource_manager::ResourceManager::get_instance()->get_option(key);

To incrementally deprectate direct usage of options, an option is set to have restricted access in basic/options/options_rosetta.py

C++: utility::options::Option::restrict_access(bool) –> class utility::options::Option &

set_accessed(self: pyrosetta.rosetta.utility.options.Option, setting: bool) None

C++: utility::options::Option::set_accessed(bool) const –> void

set_cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_str: str) None

C++: utility::options::VectorOption::set_cl_value(const std::string &) –> void

set_value(*args, **kwargs)

Overloaded function.

  1. set_value(self: pyrosetta.rosetta.utility.options.VectorOption, value_str: str) -> None

  2. set_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_str: str, reset: bool) -> None

Value assignemt from a command line string but without

a VectorOption & return type. This will separate arguments by whitespace and set the vector option accordingly. If reset is true, the current values will be cleared first.

C++: utility::options::VectorOption::set_value(const std::string &, bool) –> void

short_description(*args, **kwargs)

Overloaded function.

  1. short_description(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::short_description() const –> const std::string &

  1. short_description(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, sd: str) -> None

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::short_description(const std::string &) –> void

shortd(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, s: str) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::shortd(const std::string &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

size(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::size() const –> unsigned long

size_constraint_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::size_constraint_string() const –> std::string

specified_check(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) None

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::specified_check() const –> void

specified_report(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::specified_report() const –> bool

strict_lower(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::strict_lower(const int &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

strict_upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::strict_upper(const int &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

to_default(*args, **kwargs)

Overloaded function.

  1. to_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::to_default() –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. to_default(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.options.VectorOption

Set to default value, if any

C++: utility::options::VectorOption::to_default() –> class utility::options::VectorOption &

type_string(self: pyrosetta.rosetta.utility.options.IntegerVectorOption) str

Option type code string representation

C++: utility::options::IntegerVectorOption::type_string() const –> std::string

upper(*args, **kwargs)

Overloaded function.

  1. upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::upper(const int &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. upper(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.Bound_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::upper() –> const class utility::Bound<int> &

user(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) bool

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::user() const –> bool

user_or(*args, **kwargs)

Overloaded function.

  1. user_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: pyrosetta.rosetta.utility.vector1_int) -> pyrosetta.rosetta.utility.vector1_int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::user_or(const class utility::vector1<int, class std::allocator<int> > &) const –> class utility::vector1<int, class std::allocator<int> >

  1. user_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i: int, value_a: int) -> int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::user_or(const unsigned long, const int &) const –> int

value(*args, **kwargs)

Overloaded function.

  1. value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::value(const int &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: pyrosetta.rosetta.utility.vector1_int) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::value(const class utility::vector1<int, class std::allocator<int> > &) –> class utility::options::VectorOption_T_<class utility::options::IntegerVectorOptionKey, int> &

  1. value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> pyrosetta.rosetta.utility.vector1_int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::value() const –> const class utility::vector1<int, class std::allocator<int> > &

  1. value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i: int) -> int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::value(const unsigned long) const –> const int &

value_or(*args, **kwargs)

Overloaded function.

  1. value_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a: pyrosetta.rosetta.utility.vector1_int) -> pyrosetta.rosetta.utility.vector1_int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::value_or(const class utility::vector1<int, class std::allocator<int> > &) const –> class utility::vector1<int, class std::allocator<int> >

  1. value_or(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i: int, value_a: int) -> int

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::value_or(const unsigned long, const int &) const –> int

value_string(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) str

C++: utility::options::VectorOption_T_<utility::options::IntegerVectorOptionKey, int>::value_string() const –> std::string

class pyrosetta.rosetta.utility.options.IntegerVectorOptionKey

Bases: pyrosetta.rosetta.utility.options.VectorOptionKey

Automatic hidden index key for integer options

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.options.IntegerVectorOptionKey

Key assignment

C++: utility::options::IntegerVectorOptionKey::operator=(const class utility::keys::Key &) –> class utility::options::IntegerVectorOptionKey &

  1. assign(self: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey, : pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) -> pyrosetta.rosetta.utility.options.IntegerVectorOptionKey

C++: utility::options::IntegerVectorOptionKey::operator=(const class utility::options::IntegerVectorOptionKey &) –> class utility::options::IntegerVectorOptionKey &

clone(self: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) pyrosetta.rosetta.utility.options.IntegerVectorOptionKey

Clone this

C++: utility::options::IntegerVectorOptionKey::clone() const –> class utility::options::IntegerVectorOptionKey *

code(*args, **kwargs)

Overloaded function.

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Code

C++: utility::keys::Key::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const std::string &) –> class utility::keys::Key &

id(*args, **kwargs)

Overloaded function.

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

ID

C++: utility::keys::Key::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const std::string &) –> class utility::keys::Key &

identifier(*args, **kwargs)

Overloaded function.

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> class utility::keys::Key &

static n_key() int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

scalar(self: pyrosetta.rosetta.utility.options.VectorOptionKey) bool

Scalar option key?

C++: utility::options::VectorOptionKey::scalar() const –> bool

vector(self: pyrosetta.rosetta.utility.options.VectorOptionKey) bool

Vector option key?

C++: utility::options::VectorOptionKey::vector() const –> bool

class pyrosetta.rosetta.utility.options.Option

Bases: pybind11_builtins.pybind11_object

Program option interface class

activate(self: pyrosetta.rosetta.utility.options.Option) pyrosetta.rosetta.utility.options.Option

Activate

C++: utility::options::Option::activate() –> class utility::options::Option &

active(self: pyrosetta.rosetta.utility.options.Option) bool

Active? That is, the option has some value, either the default one or specified on the command line.

C++: utility::options::Option::active() const –> bool

been_accessed(self: pyrosetta.rosetta.utility.options.Option) None

Set access property to true.

C++: utility::options::Option::been_accessed() const –> void

can_hold_another(self: pyrosetta.rosetta.utility.options.Option) bool

Can another value be added and stay within any size constraints?

C++: utility::options::Option::can_hold_another() const –> bool

check_restricted_access(self: pyrosetta.rosetta.utility.options.Option, do_check: bool) None

C++: utility::options::Option::check_restricted_access(bool) const –> void

cl_value(self: pyrosetta.rosetta.utility.options.Option, value_str: str) pyrosetta.rosetta.utility.options.Option

Value assignment from a command line string

C++: utility::options::Option::cl_value(const std::string &) –> class utility::options::Option &

clear(self: pyrosetta.rosetta.utility.options.Option) pyrosetta.rosetta.utility.options.Option

Clear

C++: utility::options::Option::clear() –> class utility::options::Option &

clone(self: pyrosetta.rosetta.utility.options.Option) pyrosetta.rosetta.utility.options.Option

Clone this

C++: utility::options::Option::clone() const –> class utility::options::Option *

code(self: pyrosetta.rosetta.utility.options.Option) str

Code

C++: utility::options::Option::code() const –> const std::string &

copy_from(self: pyrosetta.rosetta.utility.options.Option, other: pyrosetta.rosetta.utility.options.Option) None

Copy operation – requires that other match the type of this.

C++: utility::options::Option::copy_from(const class utility::options::Option &) –> void

deactivate(self: pyrosetta.rosetta.utility.options.Option) pyrosetta.rosetta.utility.options.Option

Deactivate

C++: utility::options::Option::deactivate() –> class utility::options::Option &

default_active(self: pyrosetta.rosetta.utility.options.Option) bool

Default active?

C++: utility::options::Option::default_active() const –> bool

default_inactive(self: pyrosetta.rosetta.utility.options.Option) bool

Default inactive?

C++: utility::options::Option::default_inactive() const –> bool

default_size(self: pyrosetta.rosetta.utility.options.Option) int

Default size (number of default values)

C++: utility::options::Option::default_size() const –> unsigned long

default_string(self: pyrosetta.rosetta.utility.options.Option) str

Default value string representation

C++: utility::options::Option::default_string() const –> std::string

description(self: pyrosetta.rosetta.utility.options.Option) str

Description

C++: utility::options::Option::description() const –> const std::string &

equals_string(self: pyrosetta.rosetta.utility.options.Option) str

=Value string representation

C++: utility::options::Option::equals_string() const –> std::string

has_default(self: pyrosetta.rosetta.utility.options.Option) bool

Has a default?

C++: utility::options::Option::has_default() const –> bool

id(self: pyrosetta.rosetta.utility.options.Option) str

ID

C++: utility::options::Option::id() const –> const std::string &

identifier(self: pyrosetta.rosetta.utility.options.Option) str

Identifier

C++: utility::options::Option::identifier() const –> const std::string &

is_been_accessed(self: pyrosetta.rosetta.utility.options.Option) bool

Return true if option value was anyhow accessed.

C++: utility::options::Option::is_been_accessed() const –> bool

is_cl_value(self: pyrosetta.rosetta.utility.options.Option, value_str: str) bool

Is a string readable as this option’s value type and a legal command line value?

C++: utility::options::Option::is_cl_value(const std::string &) const –> bool

is_group(*args, **kwargs)

Overloaded function.

  1. is_group(self: pyrosetta.rosetta.utility.options.Option, value: bool) -> pyrosetta.rosetta.utility.options.Option

C++: utility::options::Option::is_group(bool) –> class utility::options::Option &

  1. is_group(self: pyrosetta.rosetta.utility.options.Option) -> bool

Is this the synonymous option for an option group (e.g. -in:file:file)

C++: utility::options::Option::is_group() const –> bool

is_value(self: pyrosetta.rosetta.utility.options.Option, value_str: str) bool

Is a string readable as this option’s value type?

C++: utility::options::Option::is_value(const std::string &) const –> bool

key(self: pyrosetta.rosetta.utility.options.Option) pyrosetta.rosetta.utility.options.OptionKey

Key

C++: utility::options::Option::key() const –> const class utility::options::OptionKey &

legal(self: pyrosetta.rosetta.utility.options.Option) bool

Legal value?

C++: utility::options::Option::legal() const –> bool

legal_check(self: pyrosetta.rosetta.utility.options.Option) None

Legal value check

C++: utility::options::Option::legal_check() const –> void

legal_default(self: pyrosetta.rosetta.utility.options.Option) bool

Legal or inactive default value?

C++: utility::options::Option::legal_default() const –> bool

legal_default_check(self: pyrosetta.rosetta.utility.options.Option) None

Legal default value check

C++: utility::options::Option::legal_default_check() const –> void

legal_default_report(self: pyrosetta.rosetta.utility.options.Option) bool

Legal default value check: Report and return error state

C++: utility::options::Option::legal_default_report() const –> bool

legal_limits_report(self: pyrosetta.rosetta.utility.options.Option) bool

Legal value limits check: Report and return error state

C++: utility::options::Option::legal_limits_report() const –> bool

legal_report(self: pyrosetta.rosetta.utility.options.Option) bool

Legal value check: Report and return error state

C++: utility::options::Option::legal_report() const –> bool

legal_size_report(self: pyrosetta.rosetta.utility.options.Option) bool

Legal size limits check: Report and return error state

C++: utility::options::Option::legal_size_report() const –> bool

legal_specs_report(self: pyrosetta.rosetta.utility.options.Option) bool

Legal specifications check: Report and return error state

C++: utility::options::Option::legal_specs_report() const –> bool

legal_string(self: pyrosetta.rosetta.utility.options.Option) str

Legal value string representation

C++: utility::options::Option::legal_string() const –> std::string

n_default_value(self: pyrosetta.rosetta.utility.options.Option) int

Number of default values (default size)

C++: utility::options::Option::n_default_value() const –> unsigned long

n_value(self: pyrosetta.rosetta.utility.options.Option) int

Number of values (size)

C++: utility::options::Option::n_value() const –> unsigned long

name(self: pyrosetta.rosetta.utility.options.Option) str

Name

C++: utility::options::Option::name() const –> const std::string &

static print_error_message(message: str) None
Print an error message. As a separate function to keep stream handling

from being part of the header files.

C++: utility::options::Option::print_error_message(const std::string &) –> void

raw_default_string(self: pyrosetta.rosetta.utility.options.Option) str

Default value string representation

C++: utility::options::Option::raw_default_string() const –> std::string

raw_value_string(self: pyrosetta.rosetta.utility.options.Option) str

Value string representation

C++: utility::options::Option::raw_value_string() const –> std::string

restrict_access(self: pyrosetta.rosetta.utility.options.Option, setting: bool) pyrosetta.rosetta.utility.options.Option

Restrict direct access to option for general use.

In the past, protocols were able to access the values of options in the option system directly. However this tied protocol behavior tightly to setting specific options on the command line, making it difficult to use Rosetta using other workflows. Now, options are accessed through the resource manager, which has control over which options are passed to which protocols.

basic::resource_manager::ResourceManager::get_instance()->get_option(key);

To incrementally deprectate direct usage of options, an option is set to have restricted access in basic/options/options_rosetta.py

C++: utility::options::Option::restrict_access(bool) –> class utility::options::Option &

set_accessed(self: pyrosetta.rosetta.utility.options.Option, setting: bool) None

C++: utility::options::Option::set_accessed(bool) const –> void

set_cl_value(self: pyrosetta.rosetta.utility.options.Option, value_str: str) None

Set the value of the option from a string from the commandline options.

The difference between set_value() and set_cl_value() is that set_cl_value() assumes that the options have been pre-vectorized by the commandline, and the string is being passed in (multiple) vectorized pieces. set_value(), in contrast, assumes that it’s being passed a pre-vectorized string.

C++: utility::options::Option::set_cl_value(const std::string &) –> void

set_value(*args, **kwargs)

Overloaded function.

  1. set_value(self: pyrosetta.rosetta.utility.options.Option, value_str: str) -> None

  2. set_value(self: pyrosetta.rosetta.utility.options.Option, value_str: str, reset: bool) -> None

Set the value of the option from a string.

The difference between set_value() and set_cl_value() is that set_cl_value() assumes that the options have been pre-vectorized by the commandline, and the string is being passed in (multiple) vectorized pieces. set_value(), in contrast, assumes that it’s being passed a pre-vectorized string. For scalar options, set_value() will set the value as-is, including any spaces. For vector options, it will split according to spaces. If reset is false, set_value() will act like multiple instances of the option on the commandline. If reset is true, vector options will be cleared before adding the new items.

C++: utility::options::Option::set_value(const std::string &, bool) –> void

short_description(self: pyrosetta.rosetta.utility.options.Option) str

short_Description

C++: utility::options::Option::short_description() const –> const std::string &

size(self: pyrosetta.rosetta.utility.options.Option) int

Size (number of values)

C++: utility::options::Option::size() const –> unsigned long

size_constraint_string(self: pyrosetta.rosetta.utility.options.Option) str

Size constraint string representation

C++: utility::options::Option::size_constraint_string() const –> std::string

specified_check(self: pyrosetta.rosetta.utility.options.Option) None

Required specified option check

C++: utility::options::Option::specified_check() const –> void

specified_report(self: pyrosetta.rosetta.utility.options.Option) bool

Required specified option check: Report and return error state

C++: utility::options::Option::specified_report() const –> bool

to_default(self: pyrosetta.rosetta.utility.options.Option) pyrosetta.rosetta.utility.options.Option

Set to default value, if any

C++: utility::options::Option::to_default() –> class utility::options::Option &

type_string(self: pyrosetta.rosetta.utility.options.Option) str

Option type code string representation

C++: utility::options::Option::type_string() const –> std::string

user(self: pyrosetta.rosetta.utility.options.Option) bool
User-specified? That is, the option value was specified on the command line.

You should probably use active() instead in almost all cases!

C++: utility::options::Option::user() const –> bool

value_string(self: pyrosetta.rosetta.utility.options.Option) str

Value string representation

C++: utility::options::Option::value_string() const –> std::string

class pyrosetta.rosetta.utility.options.OptionCollection

Bases: pybind11_builtins.pybind11_object

Program options collection

add(*args, **kwargs)

Overloaded function.

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.BooleanOptionKey, description: str) -> pyrosetta.rosetta.utility.options.BooleanOption

Add a BooleanOption

C++: utility::options::OptionCollection::add(const class utility::options::BooleanOptionKey &, const std::string &) –> class utility::options::BooleanOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.IntegerOptionKey, description: str) -> pyrosetta.rosetta.utility.options.IntegerOption

Add an IntegerOption

C++: utility::options::OptionCollection::add(const class utility::options::IntegerOptionKey &, const std::string &) –> class utility::options::IntegerOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.RealOptionKey, description: str) -> pyrosetta.rosetta.utility.options.RealOption

Add a RealOption

C++: utility::options::OptionCollection::add(const class utility::options::RealOptionKey &, const std::string &) –> class utility::options::RealOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.StringOptionKey, description: str) -> pyrosetta.rosetta.utility.options.StringOption

Add a StringOption

C++: utility::options::OptionCollection::add(const class utility::options::StringOptionKey &, const std::string &) –> class utility::options::StringOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.FileOptionKey, description: str) -> pyrosetta.rosetta.utility.options.FileOption

Add a FileOption

C++: utility::options::OptionCollection::add(const class utility::options::FileOptionKey &, const std::string &) –> class utility::options::FileOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.PathOptionKey, description: str) -> pyrosetta.rosetta.utility.options.PathOption

Add a PathOption

C++: utility::options::OptionCollection::add(const class utility::options::PathOptionKey &, const std::string &) –> class utility::options::PathOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey, description: str) -> pyrosetta.rosetta.utility.options.BooleanVectorOption

Add a BooleanVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::BooleanVectorOptionKey &, const std::string &) –> class utility::options::BooleanVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey, description: str) -> pyrosetta.rosetta.utility.options.IntegerVectorOption

Add an IntegerVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::IntegerVectorOptionKey &, const std::string &) –> class utility::options::IntegerVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey, description: str) -> pyrosetta.rosetta.utility.options.RealVectorOption

Add a RealVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::RealVectorOptionKey &, const std::string &) –> class utility::options::RealVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.ResidueChainVectorOptionKey, description: str) -> pyrosetta.rosetta.utility.options.ResidueChainVectorOption

Add an ResidueChainVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::ResidueChainVectorOptionKey &, const std::string &) –> class utility::options::ResidueChainVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey, description: str) -> pyrosetta.rosetta.utility.options.StringVectorOption

Add a StringVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::StringVectorOptionKey &, const std::string &) –> class utility::options::StringVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey, description: str) -> pyrosetta.rosetta.utility.options.FileVectorOption

Add a FileVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::FileVectorOptionKey &, const std::string &) –> class utility::options::FileVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey, description: str) -> pyrosetta.rosetta.utility.options.PathVectorOption

Add a PathVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::PathVectorOptionKey &, const std::string &) –> class utility::options::PathVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.BooleanOption) -> pyrosetta.rosetta.utility.options.BooleanOption

Add a BooleanOption

C++: utility::options::OptionCollection::add(const class utility::options::BooleanOption &) –> class utility::options::BooleanOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.IntegerOption) -> pyrosetta.rosetta.utility.options.IntegerOption

Add an IntegerOption

C++: utility::options::OptionCollection::add(const class utility::options::IntegerOption &) –> class utility::options::IntegerOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.RealOption) -> pyrosetta.rosetta.utility.options.RealOption

Add a RealOption

C++: utility::options::OptionCollection::add(const class utility::options::RealOption &) –> class utility::options::RealOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.StringOption) -> pyrosetta.rosetta.utility.options.StringOption

Add a StringOption

C++: utility::options::OptionCollection::add(const class utility::options::StringOption &) –> class utility::options::StringOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.FileOption) -> pyrosetta.rosetta.utility.options.FileOption

Add a FileOption

C++: utility::options::OptionCollection::add(const class utility::options::FileOption &) –> class utility::options::FileOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.PathOption) -> pyrosetta.rosetta.utility.options.PathOption

Add a PathOption

C++: utility::options::OptionCollection::add(const class utility::options::PathOption &) –> class utility::options::PathOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.BooleanVectorOption) -> pyrosetta.rosetta.utility.options.BooleanVectorOption

Add a BooleanVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::BooleanVectorOption &) –> class utility::options::BooleanVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.IntegerVectorOption) -> pyrosetta.rosetta.utility.options.IntegerVectorOption

Add an IntegerVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::IntegerVectorOption &) –> class utility::options::IntegerVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.RealVectorOption) -> pyrosetta.rosetta.utility.options.RealVectorOption

Add a RealVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::RealVectorOption &) –> class utility::options::RealVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.ResidueChainVectorOption) -> pyrosetta.rosetta.utility.options.ResidueChainVectorOption

Add an ResidueChainVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::ResidueChainVectorOption &) –> class utility::options::ResidueChainVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.StringVectorOption) -> pyrosetta.rosetta.utility.options.StringVectorOption

Add a StringVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::StringVectorOption &) –> class utility::options::StringVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.FileVectorOption) -> pyrosetta.rosetta.utility.options.FileVectorOption

Add a FileVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::FileVectorOption &) –> class utility::options::FileVectorOption &

  1. add(self: pyrosetta.rosetta.utility.options.OptionCollection, opt: pyrosetta.rosetta.utility.options.PathVectorOption) -> pyrosetta.rosetta.utility.options.PathVectorOption

Add a PathVectorOption

C++: utility::options::OptionCollection::add(const class utility::options::PathVectorOption &) –> class utility::options::PathVectorOption &

add_built_in_options(self: pyrosetta.rosetta.utility.options.OptionCollection) None

Add the built-in options

C++: utility::options::OptionCollection::add_built_in_options() –> void

static add_edits(items: pyrosetta.rosetta.std.set_std_string_t) None

Add to the set possible typos for a given word

These are strings with Levenshtein distance of 1 - Based off of the approach from http://norvig.com/spell-correct.html

C++: utility::options::OptionCollection::add_edits(class std::set<std::string, struct std::less<std::string >, class std::allocator<std::string > > &) –> void

add_relevant(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.OptionKey) None

add OptionKey to list of application relevant options

C++: utility::options::OptionCollection::add_relevant(const class utility::options::OptionKey &) –> void

assign(self: pyrosetta.rosetta.utility.options.OptionCollection, src: pyrosetta.rosetta.utility.options.OptionCollection) pyrosetta.rosetta.utility.options.OptionCollection

Copy assignment operator.

Needed because the mutext can’t be copied.

C++: utility::options::OptionCollection::operator=(const class utility::options::OptionCollection &) –> class utility::options::OptionCollection &

static check_key(*args, **kwargs)

Overloaded function.

  1. check_key(key: pyrosetta.rosetta.utility.options.OptionKey) -> None

Check that a key’s identifiers are legal

C++: utility::options::OptionCollection::check_key(const class utility::options::OptionKey &) –> void

  1. check_key(option: pyrosetta.rosetta.utility.options.Option) -> None

Check that an option’s identifiers are legal

C++: utility::options::OptionCollection::check_key(const class utility::options::Option &) –> void

check_specs(self: pyrosetta.rosetta.utility.options.OptionCollection) None

Check for problems in the option specifications

C++: utility::options::OptionCollection::check_specs() const –> void

check_values(self: pyrosetta.rosetta.utility.options.OptionCollection) None

Check for problems in the option values

C++: utility::options::OptionCollection::check_values() const –> void

static cleaned(s: str) str

Cleaned option id with repeat colons condensed

C++: utility::options::OptionCollection::cleaned(const std::string &) –> std::string

clone(self: pyrosetta.rosetta.utility.options.OptionCollection) pyrosetta.rosetta.utility.options.OptionCollection

C++: utility::options::OptionCollection::clone() const –> class std::shared_ptr<class utility::options::OptionCollection>

find_key_cl(self: pyrosetta.rosetta.utility.options.OptionCollection, key_string: str, cid: str, top: bool) str

Find a user-specified option key in a command line context

Searches up the context to find a match

C++: utility::options::OptionCollection::find_key_cl(const std::string &, const std::string &, const bool) –> std::string

static find_key_file(key_string: str, cid: str, top: bool) str

Find a user-specified option key in an indented context

Looks in the context to find a match

C++: utility::options::OptionCollection::find_key_file(const std::string &, const std::string &, const bool) –> std::string

get_argv(self: pyrosetta.rosetta.utility.options.OptionCollection) str
Returns a copy of the concatenated argv strings that were initialized

in load().

C++: utility::options::OptionCollection::get_argv() const –> std::string

has(*args, **kwargs)

Overloaded function.

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.BooleanOptionKey) -> bool

Is there an option with a BooleanOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::BooleanOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.IntegerOptionKey) -> bool

Is there an option with an IntegerOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::IntegerOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.RealOptionKey) -> bool

Is there an option with a RealOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::RealOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.StringOptionKey) -> bool

Is there an option with a StringOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::StringOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.FileOptionKey) -> bool

Is there an option with a FileOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::FileOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.PathOptionKey) -> bool

Is there an option with a PathOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::PathOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.AnyOptionKey) -> bool

Is there an option with an AnyOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::AnyOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) -> bool

Is there an option with a BooleanVectorOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::BooleanVectorOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) -> bool

Is there an option with an IntegerVectorOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::IntegerVectorOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey) -> bool

Is there an option with a RealVectorOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::RealVectorOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.ResidueChainVectorOptionKey) -> bool

Is there an option with an IntegerVectorOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::ResidueChainVectorOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey) -> bool

Is there an option with a StringVectorOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::StringVectorOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey) -> bool

Is there an option with a FileVectorOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::FileVectorOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey) -> bool

Is there an option with a PathVectorOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::PathVectorOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.AnyVectorOptionKey) -> bool

Is there an option with an AnyVectorOptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::AnyVectorOptionKey &) const –> bool

  1. has(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.OptionKey) -> bool

Is there an option with an OptionKey?

C++: utility::options::OptionCollection::has(const class utility::options::OptionKey &) const –> bool

is_relevant(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.OptionKey) bool

Checks if option has been registered as relevant.

C++: utility::options::OptionCollection::is_relevant(const class utility::options::OptionKey &) –> bool

load(*args, **kwargs)

Overloaded function.

  1. load(self: pyrosetta.rosetta.utility.options.OptionCollection, args: pyrosetta.rosetta.std.vector_std_string, free_args: bool) -> None

Load the user-specified option values

C++: utility::options::OptionCollection::load(const class std::vector<std::string, class std::allocator<std::string > > &, const bool) –> void

  1. load(self: pyrosetta.rosetta.utility.options.OptionCollection, executable_name: str, arg_strings: pyrosetta.rosetta.std.list_std_string_t, free_args: bool) -> None

Load the user-specified option values

C++: utility::options::OptionCollection::load(std::string, class std::list<std::string, class std::allocator<std::string > > &, const bool) –> void

load_options_from_file(*args, **kwargs)

Overloaded function.

  1. load_options_from_file(self: pyrosetta.rosetta.utility.options.OptionCollection, file_string: str) -> None

  2. load_options_from_file(self: pyrosetta.rosetta.utility.options.OptionCollection, file_string: str, cid: str) -> None

Load all options in a flags file

C++: utility::options::OptionCollection::load_options_from_file(const std::string &, const std::string &) –> void

load_options_from_file_exception(*args, **kwargs)

Overloaded function.

  1. load_options_from_file_exception(self: pyrosetta.rosetta.utility.options.OptionCollection, file_string: str) -> None

  2. load_options_from_file_exception(self: pyrosetta.rosetta.utility.options.OptionCollection, file_string: str, cid: str) -> None

same as load_options_from_file, but throws exception instead of call to std::exit

C++: utility::options::OptionCollection::load_options_from_file_exception(const std::string &, const std::string &) –> void

load_options_from_stream(*args, **kwargs)

Overloaded function.

  1. load_options_from_stream(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.istream) -> None

  2. load_options_from_stream(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.istream, file_string: str) -> None

  3. load_options_from_stream(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.istream, file_string: str, cid: str) -> None

  4. load_options_from_stream(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.istream, file_string: str, cid: str, print_lines: bool) -> None

Load all options in a flags file

C++: utility::options::OptionCollection::load_options_from_stream(std::istream &, const std::string &, const std::string &, bool) –> void

static lower_no_under(instring: str) str

Remove underscores and lowercase string

C++: utility::options::OptionCollection::lower_no_under(const std::string &) –> std::string

static merged(s: str, t: str) str

Merged option ids with the minimal suffix-prefix overlap, if any, removed

C++: utility::options::OptionCollection::merged(const std::string &, const std::string &) –> std::string

static n_part(s: str) int

Number of parts in an option id

C++: utility::options::OptionCollection::n_part(const std::string &) –> unsigned long

static n_part_prefix_match(s: str, t: str) int

Number of prefix parts of two ids that match

C++: utility::options::OptionCollection::n_part_prefix_match(const std::string &, const std::string &) –> unsigned long

option(*args, **kwargs)

Overloaded function.

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.BooleanOptionKey) -> pyrosetta.rosetta.utility.options.BooleanOption

Option by BooleanOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::BooleanOptionKey &) –> class utility::options::BooleanOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.IntegerOptionKey) -> pyrosetta.rosetta.utility.options.IntegerOption

Option by IntegerOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::IntegerOptionKey &) –> class utility::options::IntegerOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.RealOptionKey) -> pyrosetta.rosetta.utility.options.RealOption

Option by RealOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::RealOptionKey &) –> class utility::options::RealOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.StringOptionKey) -> pyrosetta.rosetta.utility.options.StringOption

Option by StringOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::StringOptionKey &) –> class utility::options::StringOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.FileOptionKey) -> pyrosetta.rosetta.utility.options.FileOption

Option by FileOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::FileOptionKey &) –> class utility::options::FileOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.PathOptionKey) -> pyrosetta.rosetta.utility.options.PathOption

Option by PathOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::PathOptionKey &) –> class utility::options::PathOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.AnyOptionKey) -> pyrosetta.rosetta.utility.options.Option

Option by AnyOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::AnyOptionKey &) –> class utility::options::Option &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.BooleanVectorOptionKey) -> pyrosetta.rosetta.utility.options.BooleanVectorOption

VectorOption by BooleanVectorOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::BooleanVectorOptionKey &) –> class utility::options::BooleanVectorOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.IntegerVectorOptionKey) -> pyrosetta.rosetta.utility.options.IntegerVectorOption

VectorOption by IntegerVectorOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::IntegerVectorOptionKey &) –> class utility::options::IntegerVectorOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.RealVectorOptionKey) -> pyrosetta.rosetta.utility.options.RealVectorOption

VectorOption by RealVectorOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::RealVectorOptionKey &) –> class utility::options::RealVectorOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.StringVectorOptionKey) -> pyrosetta.rosetta.utility.options.StringVectorOption

VectorOption by StringVectorOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::StringVectorOptionKey &) –> class utility::options::StringVectorOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.FileVectorOptionKey) -> pyrosetta.rosetta.utility.options.FileVectorOption

VectorOption by FileVectorOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::FileVectorOptionKey &) –> class utility::options::FileVectorOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.PathVectorOptionKey) -> pyrosetta.rosetta.utility.options.PathVectorOption

VectorOption by PathVectorOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::PathVectorOptionKey &) –> class utility::options::PathVectorOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.AnyVectorOptionKey) -> pyrosetta.rosetta.utility.options.VectorOption

VectorOption by AnyVectorOptionKey

C++: utility::options::OptionCollection::option(const class utility::options::AnyVectorOptionKey &) –> class utility::options::VectorOption &

  1. option(self: pyrosetta.rosetta.utility.options.OptionCollection, key: pyrosetta.rosetta.utility.options.OptionKey) -> pyrosetta.rosetta.utility.options.Option

Option by OptionKey

C++: utility::options::OptionCollection::option(const class utility::options::OptionKey &) –> class utility::options::Option &

static prefix(*args, **kwargs)

Overloaded function.

  1. prefix(s: str) -> str

  2. prefix(s: str, n: int) -> str

Prefix of an option id with a specified number of parts

C++: utility::options::OptionCollection::prefix(const std::string &, const int) –> std::string

set_show_accessed_options_flag(self: pyrosetta.rosetta.utility.options.OptionCollection, v: bool) None

modify ‘show_accessed_options’ flag;

C++: utility::options::OptionCollection::set_show_accessed_options_flag(bool) –> void

set_show_unused_options_flag(self: pyrosetta.rosetta.utility.options.OptionCollection, v: bool) None

modify ‘show_unused_options’ flag;

C++: utility::options::OptionCollection::set_show_unused_options_flag(bool) –> void

show_accessed_options(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.ostream) None

Show accessed list of options.

C++: utility::options::OptionCollection::show_accessed_options(std::ostream &) const –> void

show_all(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.ostream) None

Show all the options and their values

C++: utility::options::OptionCollection::show_all(std::ostream &) const –> void

show_all_hier(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.ostream) None

Show all the options and their values in a hierarchy format

C++: utility::options::OptionCollection::show_all_hier(std::ostream &) const –> void

show_help(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.ostream) None

Show all the options and their descriptions

C++: utility::options::OptionCollection::show_help(std::ostream &) –> void

show_help_hier(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.ostream) None

Show all the options and their descriptions in a hierarchy format

C++: utility::options::OptionCollection::show_help_hier(std::ostream &) –> void

show_inaccessed_user_options(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.ostream) None

Show inaccessed user-specified options

C++: utility::options::OptionCollection::show_inaccessed_user_options(std::ostream &) const –> void

show_option_help(self: pyrosetta.rosetta.utility.options.OptionCollection, : pyrosetta.rosetta.utility.options.OptionKey, group: str, stream: pyrosetta.rosetta.std.ostream) None

Show one option and it description

C++: utility::options::OptionCollection::show_option_help(const class utility::options::OptionKey &, std::string &, std::ostream &) –> void

show_option_help_hier(self: pyrosetta.rosetta.utility.options.OptionCollection, : pyrosetta.rosetta.utility.options.OptionKey, group: str, stream: pyrosetta.rosetta.std.ostream) None

Show one option and it description in a hierarchy format

C++: utility::options::OptionCollection::show_option_help_hier(const class utility::options::OptionKey &, std::string &, std::ostream &) –> void

show_table_Wiki(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.ostream) None

Show the options definitions table in Wiki format

C++: utility::options::OptionCollection::show_table_Wiki(std::ostream &) const –> void

show_table_text(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.ostream) None

Show the options definitions table in text format

C++: utility::options::OptionCollection::show_table_text(std::ostream &) const –> void

show_unused_options(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.ostream) None
Show options that were user-specified, but not yet accessed.

Differs from show_inaccessed_user_options() mainly by formatting And how the options are accessed. (This one should be destructor safe.)

C++: utility::options::OptionCollection::show_unused_options(std::ostream &) const –> void

show_user(self: pyrosetta.rosetta.utility.options.OptionCollection, stream: pyrosetta.rosetta.std.ostream) None

Show the user-specified options and their values

C++: utility::options::OptionCollection::show_user(std::ostream &) const –> void

static space_prefixed(*args, **kwargs)

Overloaded function.

  1. space_prefixed(s: str) -> str

  2. space_prefixed(s: str, n: int) -> str

Space-prefixed string except blank if string is empty

C++: utility::options::OptionCollection::space_prefixed(const std::string &, const int) –> std::string

static suffix(*args, **kwargs)

Overloaded function.

  1. suffix(s: str) -> str

  2. suffix(s: str, n: int) -> str

Suffix of an option id with a specified number of parts

C++: utility::options::OptionCollection::suffix(const std::string &, const int) –> std::string

static tab_prefixed(*args, **kwargs)

Overloaded function.

  1. tab_prefixed(s: str) -> str

  2. tab_prefixed(s: str, n: int) -> str

Tab-prefixed string except blank if string is empty

C++: utility::options::OptionCollection::tab_prefixed(const std::string &, const int) –> std::string

static trim(*args, **kwargs)

Overloaded function.

  1. trim(s: str) -> str

  2. trim(s: str, n: int) -> str

Trim a specified number of parts from the suffix of an option id

C++: utility::options::OptionCollection::trim(std::string &, const int) –> std::string &

static trimmed(*args, **kwargs)

Overloaded function.

  1. trimmed(s: str) -> str

  2. trimmed(s: str, n: int) -> str

Prefix of an option id with a specified number of suffix parts removed

C++: utility::options::OptionCollection::trimmed(const std::string &, const int) –> std::string

static wrapped(*args, **kwargs)

Overloaded function.

  1. wrapped(s: str) -> str

  2. wrapped(s: str, indent: int) -> str

  3. wrapped(s: str, indent: int, width: int) -> str

  4. wrapped(s: str, indent: int, width: int, header_for_extra_lines: str) -> str

String wrapped and indented

C++: utility::options::OptionCollection::wrapped(const std::string &, unsigned long, unsigned long, const std::string &) –> std::string

class pyrosetta.rosetta.utility.options.OptionKey

Bases: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

Abstract automatic hidden index key for options

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: pyrosetta.rosetta.utility.options.OptionKey, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.options.OptionKey

Key assignment

C++: utility::options::OptionKey::operator=(const class utility::keys::Key &) –> class utility::options::OptionKey &

  1. assign(self: pyrosetta.rosetta.utility.options.OptionKey, : pyrosetta.rosetta.utility.options.OptionKey) -> pyrosetta.rosetta.utility.options.OptionKey

C++: utility::options::OptionKey::operator=(const class utility::options::OptionKey &) –> class utility::options::OptionKey &

clone(self: pyrosetta.rosetta.utility.options.OptionKey) pyrosetta.rosetta.utility.options.OptionKey

Clone this

C++: utility::options::OptionKey::clone() const –> class utility::options::OptionKey *

code(*args, **kwargs)

Overloaded function.

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Code

C++: utility::keys::Key::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const std::string &) –> class utility::keys::Key &

id(*args, **kwargs)

Overloaded function.

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

ID

C++: utility::keys::Key::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const std::string &) –> class utility::keys::Key &

identifier(*args, **kwargs)

Overloaded function.

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> class utility::keys::Key &

static n_key() int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

scalar(self: pyrosetta.rosetta.utility.options.OptionKey) bool

Scalar option key?

C++: utility::options::OptionKey::scalar() const –> bool

vector(self: pyrosetta.rosetta.utility.options.OptionKey) bool

Vector option key?

C++: utility::options::OptionKey::vector() const –> bool

class pyrosetta.rosetta.utility.options.OptionTypes

Bases: pybind11_builtins.pybind11_object

Option types enumeration

Members:

UNKNOWN_OPTION

BOOLEAN_OPTION

INTEGER_OPTION

REAL_OPTION

STRING_OPTION

FILE_OPTION

PATH_OPTION

ANY_OPTION

BOOLEAN_VECTOR_OPTION

INTEGER_VECTOR_OPTION

REAL_VECTOR_OPTION

RESIDUE_CHAIN_VECTOR_OPTION

STRING_VECTOR_OPTION

FILE_VECTOR_OPTION

PATH_VECTOR_OPTION

ANY_VECTOR_OPTION

ANY_OPTION = <OptionTypes.ANY_OPTION: 7>
ANY_VECTOR_OPTION = <OptionTypes.ANY_VECTOR_OPTION: 15>
BOOLEAN_OPTION = <OptionTypes.BOOLEAN_OPTION: 1>
BOOLEAN_VECTOR_OPTION = <OptionTypes.BOOLEAN_VECTOR_OPTION: 8>
FILE_OPTION = <OptionTypes.FILE_OPTION: 5>
FILE_VECTOR_OPTION = <OptionTypes.FILE_VECTOR_OPTION: 13>
INTEGER_OPTION = <OptionTypes.INTEGER_OPTION: 2>
INTEGER_VECTOR_OPTION = <OptionTypes.INTEGER_VECTOR_OPTION: 9>
PATH_OPTION = <OptionTypes.PATH_OPTION: 6>
PATH_VECTOR_OPTION = <OptionTypes.PATH_VECTOR_OPTION: 14>
REAL_OPTION = <OptionTypes.REAL_OPTION: 3>
REAL_VECTOR_OPTION = <OptionTypes.REAL_VECTOR_OPTION: 10>
RESIDUE_CHAIN_VECTOR_OPTION = <OptionTypes.RESIDUE_CHAIN_VECTOR_OPTION: 11>
STRING_OPTION = <OptionTypes.STRING_OPTION: 4>
STRING_VECTOR_OPTION = <OptionTypes.STRING_VECTOR_OPTION: 12>
UNKNOWN_OPTION = <OptionTypes.UNKNOWN_OPTION: 0>
property name
class pyrosetta.rosetta.utility.options.PathOption

Bases: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

Program path option class

activate(*args, **kwargs)

Overloaded function.

  1. activate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::activate() –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

  1. activate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Activate

C++: utility::options::ScalarOption::activate() –> class utility::options::ScalarOption &

active(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::active() const –> bool

assign(self: pyrosetta.rosetta.utility.options.PathOption, : pyrosetta.rosetta.utility.options.PathOption) pyrosetta.rosetta.utility.options.PathOption

C++: utility::options::PathOption::operator=(const class utility::options::PathOption &) –> class utility::options::PathOption &

been_accessed(self: pyrosetta.rosetta.utility.options.Option) None

Set access property to true.

C++: utility::options::Option::been_accessed() const –> void

can_hold_another(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::can_hold_another() const –> bool

check_restricted_access(self: pyrosetta.rosetta.utility.options.Option, do_check: bool) None

C++: utility::options::Option::check_restricted_access(bool) const –> void

cl_value(*args, **kwargs)

Overloaded function.

  1. cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_str: str) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::cl_value(const std::string &) –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

  1. cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_str: str) -> pyrosetta.rosetta.utility.options.ScalarOption

Value assignment from a command line string

C++: utility::options::ScalarOption::cl_value(const std::string &) –> class utility::options::ScalarOption &

clear(*args, **kwargs)

Overloaded function.

  1. clear(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::clear() –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

  1. clear(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Clear

C++: utility::options::ScalarOption::clear() –> class utility::options::ScalarOption &

clone(self: pyrosetta.rosetta.utility.options.PathOption) pyrosetta.rosetta.utility.options.PathOption

Clone this

C++: utility::options::PathOption::clone() const –> class utility::options::PathOption *

code(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::code() const –> const std::string &

copy_from(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, other: pyrosetta.rosetta.utility.options.Option) None

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::copy_from(const class utility::options::Option &) –> void

deactivate(*args, **kwargs)

Overloaded function.

  1. deactivate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::deactivate() –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

  1. deactivate(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Deactivate

C++: utility::options::ScalarOption::deactivate() –> class utility::options::ScalarOption &

def(*args, **kwargs)

Overloaded function.

  1. def(self: pyrosetta.rosetta.utility.options.PathOption, value_a: pyrosetta.rosetta.utility.file.PathName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

  2. def(self: pyrosetta.rosetta.utility.options.PathOption, value_a: str) -> pyrosetta.rosetta.utility.options.PathOption

Default value assignment

C++: utility::options::PathOption::def(const std::string &) –> class utility::options::PathOption &

default_active(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::default_active() const –> bool

default_inactive(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::default_inactive() const –> bool

default_size(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) int

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::default_size() const –> unsigned long

default_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::default_string() const –> std::string

default_to(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, option: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::default_to(const class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &) –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

default_value(*args, **kwargs)

Overloaded function.

  1. default_value(self: pyrosetta.rosetta.utility.options.PathOption) -> pyrosetta.rosetta.utility.file.PathName

  2. default_value(self: pyrosetta.rosetta.utility.options.PathOption, value_a: pyrosetta.rosetta.utility.file.PathName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

  3. default_value(self: pyrosetta.rosetta.utility.options.PathOption, value_a: str) -> pyrosetta.rosetta.utility.options.PathOption

Default value assignment

C++: utility::options::PathOption::default_value(const std::string &) –> class utility::options::PathOption &

description(*args, **kwargs)

Overloaded function.

  1. description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::description() const –> const std::string &

  1. description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, sd: str) -> None

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::description(const std::string &) –> void

equals_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::equals_string() const –> std::string

has_any_of_characters(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, str1: str, s: str) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::has_any_of_characters(const std::string &, const std::string &) const –> bool

has_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::has_default() const –> bool

id(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::id() const –> const std::string &

identifier(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::identifier() const –> const std::string &

is_been_accessed(self: pyrosetta.rosetta.utility.options.Option) bool

Return true if option value was anyhow accessed.

C++: utility::options::Option::is_been_accessed() const –> bool

is_cl_value(self: pyrosetta.rosetta.utility.options.PathOption, value_str: str) bool

Is a string readable as this option’s value type and a legal command line value?

C++: utility::options::PathOption::is_cl_value(const std::string &) const –> bool

is_group(*args, **kwargs)

Overloaded function.

  1. is_group(self: pyrosetta.rosetta.utility.options.Option, value: bool) -> pyrosetta.rosetta.utility.options.Option

C++: utility::options::Option::is_group(bool) –> class utility::options::Option &

  1. is_group(self: pyrosetta.rosetta.utility.options.Option) -> bool

Is this the synonymous option for an option group (e.g. -in:file:file)

C++: utility::options::Option::is_group() const –> bool

is_value(self: pyrosetta.rosetta.utility.options.PathOption, : str) bool

Is a string readable as this option’s value type?

C++: utility::options::PathOption::is_value(const std::string &) const –> bool

key(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) pyrosetta.rosetta.utility.options.PathOptionKey

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::key() const –> const class utility::options::PathOptionKey &

legal(*args, **kwargs)

Overloaded function.

  1. legal(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a: utility::file::PathName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal(const class utility::file::PathName &) –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

  1. legal(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal() const –> bool

legal_check(*args, **kwargs)

Overloaded function.

  1. legal_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> None

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_check() const –> void

  1. legal_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a: utility::file::PathName) -> None

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_check(const class utility::file::PathName &) const –> void

legal_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_default() const –> bool

legal_default_check(*args, **kwargs)

Overloaded function.

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> None

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_default_check() const –> void

  1. legal_default_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a: utility::file::PathName) -> None

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_default_check(const class utility::file::PathName &) const –> void

legal_default_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_default_report() const –> bool

legal_limits_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_limits_report() const –> bool

legal_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_report() const –> bool

legal_size_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_size_report() const –> bool

legal_specs_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_specs_report() const –> bool

legal_string(*args, **kwargs)

Overloaded function.

  1. legal_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, : bool) -> str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_string(const bool) const –> std::string

  1. legal_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_string() const –> std::string

legal_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a: utility::file::PathName) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::legal_value(const class utility::file::PathName &) const –> bool

lower(*args, **kwargs)

Overloaded function.

  1. lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a: utility::file::PathName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::lower(const class utility::file::PathName &) –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

  1. lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.Bound_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::lower() const –> const class utility::Bound<class utility::file::PathName> &

n_default_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) int

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::n_default_value() const –> unsigned long

n_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) int

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::n_value() const –> unsigned long

name(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::name() const –> const std::string &

static print_error_message(message: str) None
Print an error message. As a separate function to keep stream handling

from being part of the header files.

C++: utility::options::Option::print_error_message(const std::string &) –> void

raw_default_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::raw_default_string() const –> std::string

raw_value_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::raw_value_string() const –> std::string

restrict_access(self: pyrosetta.rosetta.utility.options.Option, setting: bool) pyrosetta.rosetta.utility.options.Option

Restrict direct access to option for general use.

In the past, protocols were able to access the values of options in the option system directly. However this tied protocol behavior tightly to setting specific options on the command line, making it difficult to use Rosetta using other workflows. Now, options are accessed through the resource manager, which has control over which options are passed to which protocols.

basic::resource_manager::ResourceManager::get_instance()->get_option(key);

To incrementally deprectate direct usage of options, an option is set to have restricted access in basic/options/options_rosetta.py

C++: utility::options::Option::restrict_access(bool) –> class utility::options::Option &

set_accessed(self: pyrosetta.rosetta.utility.options.Option, setting: bool) None

C++: utility::options::Option::set_accessed(bool) const –> void

set_cl_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_str: str) None
Value assignemt from a command line string but without

a ScalarOption & return type.

C++: utility::options::ScalarOption::set_cl_value(const std::string &) –> void

set_value(*args, **kwargs)

Overloaded function.

  1. set_value(self: pyrosetta.rosetta.utility.options.ScalarOption, value_str: str) -> None

  2. set_value(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_str: str, : bool) -> None

Value assignment from full string.

C++: utility::options::ScalarOption::set_value(const std::string &, bool) –> void

short_description(*args, **kwargs)

Overloaded function.

  1. short_description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::short_description() const –> const std::string &

  1. short_description(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, sd: str) -> None

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::short_description(const std::string &) –> void

shortd(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, s: str) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::shortd(const std::string &) –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

size(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) int

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::size() const –> unsigned long

size_constraint_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::size_constraint_string() const –> std::string

specified_check(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) None

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::specified_check() const –> void

specified_report(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::specified_report() const –> bool

strict_lower(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a: utility::file::PathName) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::strict_lower(const class utility::file::PathName &) –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

strict_upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a: utility::file::PathName) pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::strict_upper(const class utility::file::PathName &) –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

to_default(*args, **kwargs)

Overloaded function.

  1. to_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::to_default() –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

  1. to_default(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.options.ScalarOption

Set to default value, if any

C++: utility::options::ScalarOption::to_default() –> class utility::options::ScalarOption &

type_string(self: pyrosetta.rosetta.utility.options.PathOption) str

Option type code string representation

C++: utility::options::PathOption::type_string() const –> std::string

upper(*args, **kwargs)

Overloaded function.

  1. upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a: utility::file::PathName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::upper(const class utility::file::PathName &) –> class utility::options::ScalarOption_T_<class utility::options::PathOptionKey, class utility::file::PathName> &

  1. upper(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.Bound_utility_file_PathName_t

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::upper() –> const class utility::Bound<class utility::file::PathName> &

user(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) bool

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::user() const –> bool

user_or(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a: utility::file::PathName) utility::file::PathName

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::user_or(const class utility::file::PathName &) const –> class utility::file::PathName

value(*args, **kwargs)

Overloaded function.

  1. value(self: pyrosetta.rosetta.utility.options.PathOption) -> pyrosetta.rosetta.utility.file.PathName

  2. value(self: pyrosetta.rosetta.utility.options.PathOption, value_a: pyrosetta.rosetta.utility.file.PathName) -> pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t

  3. value(self: pyrosetta.rosetta.utility.options.PathOption, value_a: str) -> pyrosetta.rosetta.utility.options.PathOption

Value assignment

C++: utility::options::PathOption::value(const std::string &) –> class utility::options::PathOption &

value_or(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a: utility::file::PathName) utility::file::PathName

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::value_or(const class utility::file::PathName &) const –> class utility::file::PathName

value_string(self: pyrosetta.rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) str

C++: utility::options::ScalarOption_T_<utility::options::PathOptionKey, utility::file::PathName>::value_string() const –> std::string

class pyrosetta.rosetta.utility.options.PathOptionKey

Bases: pyrosetta.rosetta.utility.options.ScalarOptionKey

Automatic hidden index key for path options

assign(*args, **kwargs)

Overloaded function.

  1. assign(self: pyrosetta.rosetta.utility.options.PathOptionKey, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.options.PathOptionKey

Key assignment

C++: utility::options::PathOptionKey::operator=(const class utility::keys::Key &) –> class utility::options::PathOptionKey &

  1. assign(self: pyrosetta.rosetta.utility.options.PathOptionKey, : pyrosetta.rosetta.utility.options.PathOptionKey) -> pyrosetta.rosetta.utility.options.PathOptionKey

C++: utility::options::PathOptionKey::operator=(const class utility::options::PathOptionKey &) –> class utility::options::PathOptionKey &

clone(self: pyrosetta.rosetta.utility.options.PathOptionKey) pyrosetta.rosetta.utility.options.PathOptionKey

Clone this

C++: utility::options::PathOptionKey::clone() const –> class utility::options::PathOptionKey *

code(*args, **kwargs)

Overloaded function.

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Code

C++: utility::keys::Key::code() –> std::string &

  1. code(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const std::string &) –> class utility::keys::Key &

id(*args, **kwargs)

Overloaded function.

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

ID

C++: utility::keys::Key::id() –> std::string &

  1. id(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const std::string &) –> class utility::keys::Key &

identifier(*args, **kwargs)

Overloaded function.

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

  1. identifier(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> class utility::keys::Key &

static n_key() int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

  1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

scalar(self: pyrosetta.rosetta.utility.options.ScalarOptionKey) bool

Scalar option key?

C++: utility::options::ScalarOptionKey::scalar() const –> bool

vector(self: pyrosetta.rosetta.utility.options.ScalarOptionKey) bool

Vector option key?

C++: utility::options::ScalarOptionKey::vector() const –> bool

class pyrosetta.rosetta.utility.options.PathVectorOption

Bases: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t

Program path vector option class

activate(*args, **kwargs)

Overloaded function.

  1. activate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t

C++: utility::options::VectorOption_T_<utility::options::PathVectorOptionKey, utility::file::PathName>::activate() –> class utility::options::VectorOption_T_<class utility::options::PathVectorOptionKey, class utility::file::PathName> &

  1. activate(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> pyrosetta.rosetta.utility.options.VectorOption

Activate

C++: utility::options::VectorOption::activate() –> class utility::options::VectorOption &

active(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) bool

C++: utility::options::VectorOption_T_<utility::options::PathVectorOptionKey, utility::file::PathName>::active() const –> bool

assign(self: pyrosetta.rosetta.utility.options.PathVectorOption, : pyrosetta.rosetta.utility.options.PathVectorOption) pyrosetta.rosetta.utility.options.PathVectorOption

C++: utility::options::PathVectorOption::operator=(const class utility::options::PathVectorOption &) –> class utility::options::PathVectorOption &

been_accessed(self: pyrosetta.rosetta.utility.options.Option) None

Set access property to true.

C++: utility::options::Option::been_accessed() const –> void

begin(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) __gnu_cxx::__normal_iterator<utility::file::PathName const*, std::vector<utility::file::PathName, std::allocator<utility::file::PathName> > >

C++: utility::options::VectorOption_T_<utility::options::PathVectorOptionKey, utility::file::PathName>::begin() const –> class __gnu_cxx::__normal_iterator<const class utility::file::PathName *, class std::vector<class utility::file::PathName, class std::allocator<class utility::file::PathName> > >

can_hold_another(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) bool

C++: utility::options::VectorOption_T_<utility::options::PathVectorOptionKey, utility::file::PathName>::can_hold_another() const –> bool

check_restricted_access(self: pyrosetta.rosetta.utility.options.Option, do_check: bool) None

C++: utility::options::Option::check_restricted_access(bool) const –> void

cl_value(*args, **kwargs)

Overloaded function.

  1. cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_str: str) -> pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t

C++: utility::options::VectorOption_T_<utility::options::PathVectorOptionKey, utility::file::PathName>::cl_value(const std::string &) –> class utility::options::VectorOption_T_<class utility::options::PathVectorOptionKey, class utility::file::PathName> &

  1. cl_value(self: pyrosetta.rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_str: str) -> pyrosetta.rosetta.utility.options.VectorOption

Value assignment from a command line string

C++: utility::options::VectorOption::cl_value(const std::string &) –> class utility::options::VectorOption &

clear(*args, **