| |
- builtins.object
-
- Option
-
- ScalarOption
-
- ScalarOption_T__utility_options_BooleanOptionKey_bool_t
-
- BooleanOption
- ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
-
- FileOption
- ScalarOption_T__utility_options_IntegerOptionKey_int_t
-
- IntegerOption
- ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
-
- PathOption
- ScalarOption_T__utility_options_RealOptionKey_double_t
-
- RealOption
- ScalarOption_T__utility_options_StringOptionKey_std_string_t
-
- StringOption
- VectorOption
-
- VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
-
- BooleanVectorOption
- VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
-
- FileVectorOption
- VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
-
- IntegerVectorOption
- VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
-
- PathVectorOption
- VectorOption_T__utility_options_RealVectorOptionKey_double_t
-
- RealVectorOption
- VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
-
- ResidueChainVectorOption
- VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
-
- StringVectorOption
- OptionCollection
- OptionTypes
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t(rosetta.utility.keys.Key)
-
- OptionKey
-
- ScalarOptionKey
-
- AnyOptionKey
- BooleanOptionKey
- FileOptionKey
- IntegerOptionKey
- PathOptionKey
- RealOptionKey
- StringOptionKey
- VectorOptionKey
-
- AnyVectorOptionKey
- BooleanVectorOptionKey
- FileVectorOptionKey
- IntegerVectorOptionKey
- PathVectorOptionKey
- RealVectorOptionKey
- ResidueChainVectorOptionKey
- StringVectorOptionKey
class AnyOptionKey(ScalarOptionKey) |
|
Automatic hidden index key for any scalar-valued options |
|
- Method resolution order:
- AnyOptionKey
- ScalarOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.AnyOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.AnyOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.AnyOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.AnyOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.AnyOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.AnyOptionKey
Key assignment
2. assign(self : rosetta.utility.options.AnyOptionKey, : rosetta.utility.options.AnyOptionKey) -> rosetta.utility.options.AnyOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.AnyOptionKey) -> rosetta.utility.options.AnyOptionKey
Clone this
Methods inherited from ScalarOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.ScalarOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.ScalarOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class AnyVectorOptionKey(VectorOptionKey) |
|
Automatic hidden index key for any vector-valued options |
|
- Method resolution order:
- AnyVectorOptionKey
- VectorOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.AnyVectorOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.AnyVectorOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.AnyVectorOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.AnyVectorOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.AnyVectorOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.AnyVectorOptionKey
Key assignment
2. assign(self : rosetta.utility.options.AnyVectorOptionKey, : rosetta.utility.options.AnyVectorOptionKey) -> rosetta.utility.options.AnyVectorOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.AnyVectorOptionKey) -> rosetta.utility.options.AnyVectorOptionKey
Clone this
Methods inherited from VectorOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.VectorOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.VectorOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class BooleanOption(ScalarOption_T__utility_options_BooleanOptionKey_bool_t) |
|
Program boolean option class |
|
- Method resolution order:
- BooleanOption
- ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- NoDefault(...) from builtins.PyCapsule
- NoDefault(key_a : rosetta.utility.options.BooleanOptionKey, description_a : str) -> rosetta.utility.options.BooleanOption
Key + description no-default named constructor
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.BooleanOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.BooleanOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.BooleanOption, : rosetta.utility.options.BooleanOption) -> rosetta.utility.options.BooleanOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.BooleanOption) -> rosetta.utility.options.BooleanOption
Clone this
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.BooleanOption) -> str
Default value string representation
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.BooleanOption) -> str
=Value string representation
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.BooleanOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.BooleanOption, value_str : str) -> bool
Is a string readable as this option's value type?
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.BooleanOption) -> str
Legal value string representation
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.BooleanOption) -> str
Option type code string representation
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.BooleanOption) -> str
Value string representation
Methods inherited from ScalarOption_T__utility_options_BooleanOptionKey_bool_t:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. __call__(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> int
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, option : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. default_value(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, sd : str) -> NoneType
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.BooleanOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.Bound_bool_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.Bound_bool_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> bool
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. value(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> bool
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class BooleanOptionKey(ScalarOptionKey) |
|
Automatic hidden index key for boolean options |
|
- Method resolution order:
- BooleanOptionKey
- ScalarOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.BooleanOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.BooleanOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.BooleanOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.BooleanOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.BooleanOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.BooleanOptionKey
Key assignment
2. assign(self : rosetta.utility.options.BooleanOptionKey, : rosetta.utility.options.BooleanOptionKey) -> rosetta.utility.options.BooleanOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.BooleanOptionKey) -> rosetta.utility.options.BooleanOptionKey
Clone this
Methods inherited from ScalarOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.ScalarOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.ScalarOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class BooleanVectorOption(VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) |
|
Program boolean vector option class |
|
- Method resolution order:
- BooleanVectorOption
- VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.BooleanVectorOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.BooleanVectorOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.BooleanVectorOption, : rosetta.utility.options.BooleanVectorOption) -> rosetta.utility.options.BooleanVectorOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.BooleanVectorOption) -> rosetta.utility.options.BooleanVectorOption
Clone this
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.BooleanVectorOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.BooleanVectorOption, value_str : str) -> bool
Is a string readable as this option's value type?
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.BooleanVectorOption) -> str
Legal value string representation
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.BooleanVectorOption) -> str
Option type code string representation
Methods inherited from VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.vector1_bool
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int) -> bool
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int) -> bool
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, option : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.vector1_bool
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int) -> bool
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value : bool) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.BooleanVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.Bound_bool_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.Bound_bool_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.vector1_bool
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int, value_a : bool) -> bool
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.vector1_bool
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int) -> bool
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.vector1_bool
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int, value_a : bool) -> bool
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class BooleanVectorOptionKey(VectorOptionKey) |
|
Automatic hidden index key for boolean options |
|
- Method resolution order:
- BooleanVectorOptionKey
- VectorOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.BooleanVectorOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.BooleanVectorOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.BooleanVectorOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.BooleanVectorOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.BooleanVectorOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.BooleanVectorOptionKey
Key assignment
2. assign(self : rosetta.utility.options.BooleanVectorOptionKey, : rosetta.utility.options.BooleanVectorOptionKey) -> rosetta.utility.options.BooleanVectorOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.BooleanVectorOptionKey) -> rosetta.utility.options.BooleanVectorOptionKey
Clone this
Methods inherited from VectorOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.VectorOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.VectorOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class FileOption(ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) |
|
Program file option class |
|
- Method resolution order:
- FileOption
- ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(self : rosetta.utility.options.FileOption, value_a : str) -> rosetta.utility.options.FileOption
Value assignment
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.FileOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.FileOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.FileOption, : rosetta.utility.options.FileOption) -> rosetta.utility.options.FileOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.FileOption) -> rosetta.utility.options.FileOption
Clone this
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.FileOption, value_a : str) -> rosetta.utility.options.FileOption
Default value assignment
- default_value(...) from builtins.PyCapsule
- default_value(self : rosetta.utility.options.FileOption, value_a : str) -> rosetta.utility.options.FileOption
Default value assignment
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.FileOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.FileOption, : str) -> bool
Is a string readable as this option's value type?
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.FileOption) -> str
Option type code string representation
- value(...) from builtins.PyCapsule
- value(self : rosetta.utility.options.FileOption, value_a : str) -> rosetta.utility.options.FileOption
Value assignment
Methods inherited from ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t:
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, option : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.FileOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.Bound_utility_file_FileName_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.Bound_utility_file_FileName_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class FileOptionKey(ScalarOptionKey) |
|
Automatic hidden index key for file options |
|
- Method resolution order:
- FileOptionKey
- ScalarOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.FileOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.FileOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.FileOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.FileOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.FileOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.FileOptionKey
Key assignment
2. assign(self : rosetta.utility.options.FileOptionKey, : rosetta.utility.options.FileOptionKey) -> rosetta.utility.options.FileOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.FileOptionKey) -> rosetta.utility.options.FileOptionKey
Clone this
Methods inherited from ScalarOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.ScalarOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.ScalarOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class FileVectorOption(VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) |
|
Program file vector option class |
|
- Method resolution order:
- FileVectorOption
- VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(self : rosetta.utility.options.FileVectorOption, value_a : str) -> rosetta.utility.options.FileVectorOption
Value assignment
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.FileVectorOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.FileVectorOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.FileVectorOption, : rosetta.utility.options.FileVectorOption) -> rosetta.utility.options.FileVectorOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.FileVectorOption) -> rosetta.utility.options.FileVectorOption
Clone this
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.FileVectorOption, value_a : str) -> rosetta.utility.options.FileVectorOption
Default value assignment
- default_value(...) from builtins.PyCapsule
- default_value(self : rosetta.utility.options.FileVectorOption, value_a : str) -> rosetta.utility.options.FileVectorOption
Default value assignment
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.FileVectorOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.FileVectorOption, : str) -> bool
Is a string readable as this option's value type?
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.FileVectorOption) -> str
Option type code string representation
- value(...) from builtins.PyCapsule
- value(self : rosetta.utility.options.FileVectorOption, value_a : str) -> rosetta.utility.options.FileVectorOption
Value assignment
Methods inherited from VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t:
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i : int) -> rosetta.utility.file.FileName
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, option : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value : rosetta.utility.file.FileName) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.FileVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.Bound_utility_file_FileName_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.Bound_utility_file_FileName_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.vector1_utility_file_FileName) -> rosetta.utility.vector1_utility_file_FileName
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i : int, value_a : rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.vector1_utility_file_FileName) -> rosetta.utility.vector1_utility_file_FileName
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i : int, value_a : rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class FileVectorOptionKey(VectorOptionKey) |
|
Automatic hidden index key for file options |
|
- Method resolution order:
- FileVectorOptionKey
- VectorOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.FileVectorOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.FileVectorOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.FileVectorOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.FileVectorOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.FileVectorOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.FileVectorOptionKey
Key assignment
2. assign(self : rosetta.utility.options.FileVectorOptionKey, : rosetta.utility.options.FileVectorOptionKey) -> rosetta.utility.options.FileVectorOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.FileVectorOptionKey) -> rosetta.utility.options.FileVectorOptionKey
Clone this
Methods inherited from VectorOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.VectorOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.VectorOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class IntegerOption(ScalarOption_T__utility_options_IntegerOptionKey_int_t) |
|
Program integer option class |
|
- Method resolution order:
- IntegerOption
- ScalarOption_T__utility_options_IntegerOptionKey_int_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.IntegerOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.IntegerOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.IntegerOption, : rosetta.utility.options.IntegerOption) -> rosetta.utility.options.IntegerOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.IntegerOption) -> rosetta.utility.options.IntegerOption
Clone this
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.IntegerOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.IntegerOption, value_str : str) -> bool
Is a string readable as this option's value type?
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.IntegerOption) -> str
Option type code string representation
Methods inherited from ScalarOption_T__utility_options_IntegerOptionKey_int_t:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. __call__(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, option : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. default_value(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.IntegerOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.Bound_int_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.Bound_int_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> int
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. value(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> int
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class IntegerOptionKey(ScalarOptionKey) |
|
Automatic hidden index key for integer options |
|
- Method resolution order:
- IntegerOptionKey
- ScalarOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.IntegerOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.IntegerOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.IntegerOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.IntegerOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.IntegerOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.IntegerOptionKey
Key assignment
2. assign(self : rosetta.utility.options.IntegerOptionKey, : rosetta.utility.options.IntegerOptionKey) -> rosetta.utility.options.IntegerOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.IntegerOptionKey) -> rosetta.utility.options.IntegerOptionKey
Clone this
Methods inherited from ScalarOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.ScalarOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.ScalarOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class IntegerVectorOption(VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) |
|
Program integer vector option class |
|
- Method resolution order:
- IntegerVectorOption
- VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.IntegerVectorOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.IntegerVectorOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.IntegerVectorOption, : rosetta.utility.options.IntegerVectorOption) -> rosetta.utility.options.IntegerVectorOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.IntegerVectorOption) -> rosetta.utility.options.IntegerVectorOption
Clone this
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.IntegerVectorOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.IntegerVectorOption, value_str : str) -> bool
Is a string readable as this option's value type?
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.IntegerVectorOption) -> str
Option type code string representation
Methods inherited from VectorOption_T__utility_options_IntegerVectorOptionKey_int_t:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int) -> int
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int) -> int
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, option : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int) -> int
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value : int) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.IntegerVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.Bound_int_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.Bound_int_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.vector1_int
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int, value_a : int) -> int
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int) -> int
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.vector1_int
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int, value_a : int) -> int
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class IntegerVectorOptionKey(VectorOptionKey) |
|
Automatic hidden index key for integer options |
|
- Method resolution order:
- IntegerVectorOptionKey
- VectorOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.IntegerVectorOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.IntegerVectorOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.IntegerVectorOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.IntegerVectorOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.IntegerVectorOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.IntegerVectorOptionKey
Key assignment
2. assign(self : rosetta.utility.options.IntegerVectorOptionKey, : rosetta.utility.options.IntegerVectorOptionKey) -> rosetta.utility.options.IntegerVectorOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.IntegerVectorOptionKey) -> rosetta.utility.options.IntegerVectorOptionKey
Clone this
Methods inherited from VectorOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.VectorOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.VectorOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class Option(builtins.object) |
|
Program option interface class |
|
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(rosetta.utility.options.Option) -> rosetta.utility.options.Option
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.Option) -> bool
Active? That is, the option has some value, either the default one or specified on the command line.
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.Option) -> bool
Can another value be added and stay within any size constraints?
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- cl_value(...) from builtins.PyCapsule
- cl_value(self : rosetta.utility.options.Option, value_str : str) -> rosetta.utility.options.Option
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(rosetta.utility.options.Option) -> rosetta.utility.options.Option
Clear
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.Option) -> rosetta.utility.options.Option
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.Option) -> str
Code
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.Option, other : rosetta.utility.options.Option) -> NoneType
Copy operation -- requires that other match the type of this.
- deactivate(...) from builtins.PyCapsule
- deactivate(rosetta.utility.options.Option) -> rosetta.utility.options.Option
Deactivate
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.Option) -> bool
Default active?
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.Option) -> bool
Default inactive?
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.Option) -> int
Default size (number of default values)
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.Option) -> str
Default value string representation
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.Option) -> str
Description
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.Option) -> str
=Value string representation
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.Option) -> bool
Has a default?
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.Option) -> str
ID
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.Option) -> str
Identifier
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.Option) -> rosetta.utility.options.OptionKey
Key
- legal(...) from builtins.PyCapsule
- legal(rosetta.utility.options.Option) -> bool
Legal value?
- legal_check(...) from builtins.PyCapsule
- legal_check(rosetta.utility.options.Option) -> NoneType
Legal value check
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.Option) -> bool
Legal or inactive default value?
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(rosetta.utility.options.Option) -> NoneType
Legal default value check
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.Option) -> bool
Legal default value check: Report and return error state
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.Option) -> bool
Legal value limits check: Report and return error state
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.Option) -> bool
Legal value check: Report and return error state
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.Option) -> bool
Legal size limits check: Report and return error state
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.Option) -> bool
Legal specifications check: Report and return error state
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.Option) -> str
Legal value string representation
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.Option) -> int
Number of default values (default size)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.Option) -> int
Number of values (size)
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.Option) -> str
Name
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.Option) -> str
Default value string representation
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.Option) -> str
Value string representation
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.Option, value_str : str) -> NoneType
The base class deserves a setter. Why would it not have one?
- short_description(...) from builtins.PyCapsule
- short_description(rosetta.utility.options.Option) -> str
short_Description
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.Option) -> int
Size (number of values)
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.Option) -> str
Size constraint string representation
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.Option) -> NoneType
Required specified option check
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.Option) -> bool
Required specified option check: Report and return error state
- to_default(...) from builtins.PyCapsule
- to_default(rosetta.utility.options.Option) -> rosetta.utility.options.Option
Set to default value, if any
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
- user(...) from builtins.PyCapsule
- user(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!
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.Option) -> str
Value string representation
|
class OptionCollection(builtins.object) |
|
Program options collection |
|
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanOptionKey) -> rosetta.utility.options.BooleanOption
Option by BooleanOptionKey
2. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanOptionKey, check_restricted_access : bool) -> rosetta.utility.options.BooleanOption
Option by BooleanOptionKey
3. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanOptionKey) -> rosetta.utility.options.BooleanOption
Option by BooleanOptionKey
4. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanOptionKey, check_restricted_access : bool) -> rosetta.utility.options.BooleanOption
Option by BooleanOptionKey
5. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerOptionKey) -> rosetta.utility.options.IntegerOption
Option by IntegerOptionKey
6. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerOptionKey, check_restricted_access : bool) -> rosetta.utility.options.IntegerOption
Option by IntegerOptionKey
7. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerOptionKey) -> rosetta.utility.options.IntegerOption
Option by IntegerOptionKey
8. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerOptionKey, check_restricted_access : bool) -> rosetta.utility.options.IntegerOption
Option by IntegerOptionKey
9. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealOptionKey) -> rosetta.utility.options.RealOption
Option by RealOptionKey
10. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealOptionKey, check_restricted_access : bool) -> rosetta.utility.options.RealOption
Option by RealOptionKey
11. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealOptionKey) -> rosetta.utility.options.RealOption
Option by RealOptionKey
12. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealOptionKey, check_restricted_access : bool) -> rosetta.utility.options.RealOption
Option by RealOptionKey
13. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringOptionKey) -> rosetta.utility.options.StringOption
Option by StringOptionKey
14. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringOptionKey, check_restricted_access : bool) -> rosetta.utility.options.StringOption
Option by StringOptionKey
15. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringOptionKey) -> rosetta.utility.options.StringOption
Option by StringOptionKey
16. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringOptionKey, check_restricted_access : bool) -> rosetta.utility.options.StringOption
Option by StringOptionKey
17. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileOptionKey) -> rosetta.utility.options.FileOption
Option by FileOptionKey
18. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileOptionKey, check_restricted_access : bool) -> rosetta.utility.options.FileOption
Option by FileOptionKey
19. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileOptionKey) -> rosetta.utility.options.FileOption
Option by FileOptionKey
20. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileOptionKey, check_restricted_access : bool) -> rosetta.utility.options.FileOption
Option by FileOptionKey
21. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathOptionKey) -> rosetta.utility.options.PathOption
Option by PathOptionKey
22. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathOptionKey, check_restricted_access : bool) -> rosetta.utility.options.PathOption
Option by PathOptionKey
23. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathOptionKey) -> rosetta.utility.options.PathOption
Option by PathOptionKey
24. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathOptionKey, check_restricted_access : bool) -> rosetta.utility.options.PathOption
Option by PathOptionKey
25. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyOptionKey) -> rosetta.utility.options.Option
Option by AnyOptionKey
26. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyOptionKey, check_restricted_access : bool) -> rosetta.utility.options.Option
Option by AnyOptionKey
27. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyOptionKey) -> rosetta.utility.options.Option
Option by AnyOptionKey
28. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyOptionKey, check_restricted_access : bool) -> rosetta.utility.options.Option
Option by AnyOptionKey
29. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanVectorOptionKey) -> rosetta.utility.options.BooleanVectorOption
VectorOption by BooleanVectorOptionKey
30. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.BooleanVectorOption
VectorOption by BooleanVectorOptionKey
31. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanVectorOptionKey) -> rosetta.utility.options.BooleanVectorOption
VectorOption by BooleanVectorOptionKey
32. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.BooleanVectorOption
VectorOption by BooleanVectorOptionKey
33. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerVectorOptionKey) -> rosetta.utility.options.IntegerVectorOption
VectorOption by IntegerVectorOptionKey
34. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.IntegerVectorOption
VectorOption by IntegerVectorOptionKey
35. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerVectorOptionKey) -> rosetta.utility.options.IntegerVectorOption
VectorOption by IntegerVectorOptionKey
36. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.IntegerVectorOption
VectorOption by IntegerVectorOptionKey
37. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealVectorOptionKey) -> rosetta.utility.options.RealVectorOption
VectorOption by RealVectorOptionKey
38. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.RealVectorOption
VectorOption by RealVectorOptionKey
39. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealVectorOptionKey) -> rosetta.utility.options.RealVectorOption
VectorOption by RealVectorOptionKey
40. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.RealVectorOption
VectorOption by RealVectorOptionKey
41. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.ResidueChainVectorOptionKey) -> rosetta.utility.options.ResidueChainVectorOption
VectorOption by ResidueChainVectorOptionKey
42. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.ResidueChainVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.ResidueChainVectorOption
VectorOption by ResidueChainVectorOptionKey
43. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.ResidueChainVectorOptionKey) -> rosetta.utility.options.ResidueChainVectorOption
VectorOption by ResidueChainVectorOptionKey
44. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.ResidueChainVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.ResidueChainVectorOption
VectorOption by ResidueChainVectorOptionKey
45. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringVectorOptionKey) -> rosetta.utility.options.StringVectorOption
VectorOption by StringVectorOptionKey
46. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.StringVectorOption
VectorOption by StringVectorOptionKey
47. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringVectorOptionKey) -> rosetta.utility.options.StringVectorOption
VectorOption by StringVectorOptionKey
48. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.StringVectorOption
VectorOption by StringVectorOptionKey
49. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileVectorOptionKey) -> rosetta.utility.options.FileVectorOption
VectorOption by FileVectorOptionKey
50. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.FileVectorOption
VectorOption by FileVectorOptionKey
51. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileVectorOptionKey) -> rosetta.utility.options.FileVectorOption
VectorOption by FileVectorOptionKey
52. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.FileVectorOption
VectorOption by FileVectorOptionKey
53. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathVectorOptionKey) -> rosetta.utility.options.PathVectorOption
VectorOption by PathVectorOptionKey
54. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.PathVectorOption
VectorOption by PathVectorOptionKey
55. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathVectorOptionKey) -> rosetta.utility.options.PathVectorOption
VectorOption by PathVectorOptionKey
56. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.PathVectorOption
VectorOption by PathVectorOptionKey
57. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyVectorOptionKey) -> rosetta.utility.options.VectorOption
VectorOption by AnyVectorOptionKey
58. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.VectorOption
VectorOption by AnyVectorOptionKey
59. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyVectorOptionKey) -> rosetta.utility.options.VectorOption
VectorOption by AnyVectorOptionKey
60. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyVectorOptionKey, check_restricted_access : bool) -> rosetta.utility.options.VectorOption
VectorOption by AnyVectorOptionKey
61. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.OptionKey) -> rosetta.utility.options.Option
Option by OptionKey
62. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.OptionKey, check_restricted_access : bool) -> rosetta.utility.options.Option
Option by OptionKey
63. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.OptionKey) -> rosetta.utility.options.Option
Option by OptionKey
64. __call__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.OptionKey, check_restricted_access : bool) -> rosetta.utility.options.Option
Option by OptionKey
- __getitem__(...) from builtins.PyCapsule
- __getitem__(*args, **kwargs)
Overloaded function.
1. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanOptionKey) -> rosetta.utility.options.BooleanOption
OptionCollection[ BooleanOptionKey ]
2. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanOptionKey) -> rosetta.utility.options.BooleanOption
OptionCollection[ BooleanOptionKey ]
3. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerOptionKey) -> rosetta.utility.options.IntegerOption
OptionCollection[ IntegerOptionKey ]
4. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerOptionKey) -> rosetta.utility.options.IntegerOption
OptionCollection[ IntegerOptionKey ]
5. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealOptionKey) -> rosetta.utility.options.RealOption
OptionCollection[ RealOptionKey ]
6. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealOptionKey) -> rosetta.utility.options.RealOption
OptionCollection[ RealOptionKey ]
7. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringOptionKey) -> rosetta.utility.options.StringOption
OptionCollection[ StringOptionKey ]
8. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringOptionKey) -> rosetta.utility.options.StringOption
OptionCollection[ StringOptionKey ]
9. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileOptionKey) -> rosetta.utility.options.FileOption
OptionCollection[ FileOptionKey ]
10. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileOptionKey) -> rosetta.utility.options.FileOption
OptionCollection[ FileOptionKey ]
11. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathOptionKey) -> rosetta.utility.options.PathOption
OptionCollection[ PathOptionKey ]
12. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathOptionKey) -> rosetta.utility.options.PathOption
OptionCollection[ PathOptionKey ]
13. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyOptionKey) -> rosetta.utility.options.Option
OptionCollection[ AnyOptionKey ]
14. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyOptionKey) -> rosetta.utility.options.Option
OptionCollection[ AnyOptionKey ]
15. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanVectorOptionKey) -> rosetta.utility.options.BooleanVectorOption
OptionCollection[ BooleanVectorOptionKey ]
16. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanVectorOptionKey) -> rosetta.utility.options.BooleanVectorOption
OptionCollection[ BooleanVectorOptionKey ]
17. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerVectorOptionKey) -> rosetta.utility.options.IntegerVectorOption
OptionCollection[ IntegerVectorOptionKey ]
18. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerVectorOptionKey) -> rosetta.utility.options.IntegerVectorOption
OptionCollection[ IntegerVectorOptionKey ]
19. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealVectorOptionKey) -> rosetta.utility.options.RealVectorOption
OptionCollection[ RealVectorOptionKey ]
20. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealVectorOptionKey) -> rosetta.utility.options.RealVectorOption
OptionCollection[ RealVectorOptionKey ]
21. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.ResidueChainVectorOptionKey) -> rosetta.utility.options.ResidueChainVectorOption
OptionCollection[ ResidueChainVectorOptionKey ]
22. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.ResidueChainVectorOptionKey) -> rosetta.utility.options.ResidueChainVectorOption
OptionCollection[ ResidueChainVectorOptionKey ]
23. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringVectorOptionKey) -> rosetta.utility.options.StringVectorOption
OptionCollection[ StringVectorOptionKey ]
24. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringVectorOptionKey) -> rosetta.utility.options.StringVectorOption
OptionCollection[ StringVectorOptionKey ]
25. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileVectorOptionKey) -> rosetta.utility.options.FileVectorOption
OptionCollection[ FileVectorOptionKey ]
26. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileVectorOptionKey) -> rosetta.utility.options.FileVectorOption
OptionCollection[ FileVectorOptionKey ]
27. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathVectorOptionKey) -> rosetta.utility.options.PathVectorOption
OptionCollection[ PathVectorOptionKey ]
28. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathVectorOptionKey) -> rosetta.utility.options.PathVectorOption
OptionCollection[ PathVectorOptionKey ]
29. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyVectorOptionKey) -> rosetta.utility.options.VectorOption
OptionCollection[ AnyVectorOptionKey ]
30. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyVectorOptionKey) -> rosetta.utility.options.VectorOption
OptionCollection[ AnyVectorOptionKey ]
31. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.OptionKey) -> rosetta.utility.options.Option
OptionCollection[ OptionKey ]
32. __getitem__(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.OptionKey) -> rosetta.utility.options.Option
OptionCollection[ OptionKey ]
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(rosetta.utility.options.OptionCollection) -> NoneType
2. __init__(self : rosetta.utility.options.OptionCollection, : rosetta.utility.options.OptionCollection) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- __str__(...) from builtins.PyCapsule
- __str__(rosetta.utility.options.OptionCollection) -> str
- add(...) from builtins.PyCapsule
- add(*args, **kwargs)
Overloaded function.
1. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanOptionKey, description : str) -> rosetta.utility.options.BooleanOption
Add a BooleanOption
2. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerOptionKey, description : str) -> rosetta.utility.options.IntegerOption
Add an IntegerOption
3. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealOptionKey, description : str) -> rosetta.utility.options.RealOption
Add a RealOption
4. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringOptionKey, description : str) -> rosetta.utility.options.StringOption
Add a StringOption
5. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileOptionKey, description : str) -> rosetta.utility.options.FileOption
Add a FileOption
6. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathOptionKey, description : str) -> rosetta.utility.options.PathOption
Add a PathOption
7. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanVectorOptionKey, description : str) -> rosetta.utility.options.BooleanVectorOption
Add a BooleanVectorOption
8. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerVectorOptionKey, description : str) -> rosetta.utility.options.IntegerVectorOption
Add an IntegerVectorOption
9. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealVectorOptionKey, description : str) -> rosetta.utility.options.RealVectorOption
Add a RealVectorOption
10. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.ResidueChainVectorOptionKey, description : str) -> rosetta.utility.options.ResidueChainVectorOption
Add an ResidueChainVectorOption
11. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringVectorOptionKey, description : str) -> rosetta.utility.options.StringVectorOption
Add a StringVectorOption
12. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileVectorOptionKey, description : str) -> rosetta.utility.options.FileVectorOption
Add a FileVectorOption
13. add(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathVectorOptionKey, description : str) -> rosetta.utility.options.PathVectorOption
Add a PathVectorOption
14. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.BooleanOption) -> rosetta.utility.options.BooleanOption
Add a BooleanOption
15. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.IntegerOption) -> rosetta.utility.options.IntegerOption
Add an IntegerOption
16. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.RealOption) -> rosetta.utility.options.RealOption
Add a RealOption
17. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.StringOption) -> rosetta.utility.options.StringOption
Add a StringOption
18. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.FileOption) -> rosetta.utility.options.FileOption
Add a FileOption
19. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.PathOption) -> rosetta.utility.options.PathOption
Add a PathOption
20. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.BooleanVectorOption) -> rosetta.utility.options.BooleanVectorOption
Add a BooleanVectorOption
21. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.IntegerVectorOption) -> rosetta.utility.options.IntegerVectorOption
Add an IntegerVectorOption
22. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.RealVectorOption) -> rosetta.utility.options.RealVectorOption
Add a RealVectorOption
23. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.ResidueChainVectorOption) -> rosetta.utility.options.ResidueChainVectorOption
Add an ResidueChainVectorOption
24. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.StringVectorOption) -> rosetta.utility.options.StringVectorOption
Add a StringVectorOption
25. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.FileVectorOption) -> rosetta.utility.options.FileVectorOption
Add a FileVectorOption
26. add(self : rosetta.utility.options.OptionCollection, option : rosetta.utility.options.PathVectorOption) -> rosetta.utility.options.PathVectorOption
Add a PathVectorOption
- add_built_in_options(...) from builtins.PyCapsule
- add_built_in_options(rosetta.utility.options.OptionCollection) -> NoneType
Add the built-in options
- add_edits(...) from builtins.PyCapsule
- add_edits(items : rosetta.std.set_std_string_std_less_std_string_std_allocator_std_string_t) -> NoneType
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
- add_relevant(...) from builtins.PyCapsule
- add_relevant(key : rosetta.utility.options.OptionKey) -> NoneType
add OptionKey to list of application relevant options
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.OptionCollection, : rosetta.utility.options.OptionCollection) -> rosetta.utility.options.OptionCollection
- check_key(...) from builtins.PyCapsule
- check_key(*args, **kwargs)
Overloaded function.
1. check_key(key : rosetta.utility.options.OptionKey) -> NoneType
Check that a key's identifiers are legal
2. check_key(option : rosetta.utility.options.Option) -> NoneType
Check that an option's identifiers are legal
- check_specs(...) from builtins.PyCapsule
- check_specs(rosetta.utility.options.OptionCollection) -> NoneType
Check for problems in the option specifications
- check_values(...) from builtins.PyCapsule
- check_values(rosetta.utility.options.OptionCollection) -> NoneType
Check for problems in the option values
- cleaned(...) from builtins.PyCapsule
- cleaned(s : str) -> str
Cleaned option id with repeat colons condensed
- find_key_cl(...) from builtins.PyCapsule
- find_key_cl(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
- find_key_file(...) from builtins.PyCapsule
- 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
- get_argv(...) from builtins.PyCapsule
- get_argv(rosetta.utility.options.OptionCollection) -> str
Returns a copy of the concatenated argv strings that were initialized
in load().
- has(...) from builtins.PyCapsule
- has(*args, **kwargs)
Overloaded function.
1. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanOptionKey) -> bool
Is there an option with a BooleanOptionKey?
2. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerOptionKey) -> bool
Is there an option with an IntegerOptionKey?
3. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealOptionKey) -> bool
Is there an option with a RealOptionKey?
4. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringOptionKey) -> bool
Is there an option with a StringOptionKey?
5. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileOptionKey) -> bool
Is there an option with a FileOptionKey?
6. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathOptionKey) -> bool
Is there an option with a PathOptionKey?
7. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyOptionKey) -> bool
Is there an option with an AnyOptionKey?
8. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanVectorOptionKey) -> bool
Is there an option with a BooleanVectorOptionKey?
9. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerVectorOptionKey) -> bool
Is there an option with an IntegerVectorOptionKey?
10. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealVectorOptionKey) -> bool
Is there an option with a RealVectorOptionKey?
11. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.ResidueChainVectorOptionKey) -> bool
Is there an option with an IntegerVectorOptionKey?
12. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringVectorOptionKey) -> bool
Is there an option with a StringVectorOptionKey?
13. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileVectorOptionKey) -> bool
Is there an option with a FileVectorOptionKey?
14. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathVectorOptionKey) -> bool
Is there an option with a PathVectorOptionKey?
15. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyVectorOptionKey) -> bool
Is there an option with an AnyVectorOptionKey?
16. has(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.OptionKey) -> bool
Is there an option with an OptionKey?
- is_relevant(...) from builtins.PyCapsule
- is_relevant(key : rosetta.utility.options.OptionKey) -> bool
Checks if option has been registered as relevant.
- load(...) from builtins.PyCapsule
- load(*args, **kwargs)
Overloaded function.
1. load(self : rosetta.utility.options.OptionCollection, args : rosetta.std.vector_std_string, free_args : bool) -> NoneType
Load the user-specified option values
2. load(self : rosetta.utility.options.OptionCollection, executable_name : str, arg_strings : rosetta.std.list_std_string_std_allocator_std_string_t, free_args : bool) -> NoneType
Load the user-specified option values
- load_options_from_file(...) from builtins.PyCapsule
- load_options_from_file(*args, **kwargs)
Overloaded function.
1. load_options_from_file(self : rosetta.utility.options.OptionCollection, file_string : str) -> NoneType
Load all options in a flags file
2. load_options_from_file(self : rosetta.utility.options.OptionCollection, file_string : str, cid : str) -> NoneType
Load all options in a flags file
- load_options_from_file_exception(...) from builtins.PyCapsule
- load_options_from_file_exception(*args, **kwargs)
Overloaded function.
1. load_options_from_file_exception(self : rosetta.utility.options.OptionCollection, file_string : str) -> NoneType
same as load_options_from_file, but throws exception instead of call to std::exit
2. load_options_from_file_exception(self : rosetta.utility.options.OptionCollection, file_string : str, cid : str) -> NoneType
same as load_options_from_file, but throws exception instead of call to std::exit
- lower_no_under(...) from builtins.PyCapsule
- lower_no_under(instring : str) -> str
Remove underscores and lowercase string
- merged(...) from builtins.PyCapsule
- merged(s : str, t : str) -> str
Merged option ids with the minimal suffix-prefix overlap, if any, removed
- n_part(...) from builtins.PyCapsule
- n_part(s : str) -> int
Number of parts in an option id
- n_part_prefix_match(...) from builtins.PyCapsule
- n_part_prefix_match(s : str, t : str) -> int
Number of prefix parts of two ids that match
- option(...) from builtins.PyCapsule
- option(*args, **kwargs)
Overloaded function.
1. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanOptionKey) -> rosetta.utility.options.BooleanOption
Option by BooleanOptionKey
2. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanOptionKey) -> rosetta.utility.options.BooleanOption
Option by BooleanOptionKey
3. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerOptionKey) -> rosetta.utility.options.IntegerOption
Option by IntegerOptionKey
4. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerOptionKey) -> rosetta.utility.options.IntegerOption
Option by IntegerOptionKey
5. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealOptionKey) -> rosetta.utility.options.RealOption
Option by RealOptionKey
6. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealOptionKey) -> rosetta.utility.options.RealOption
Option by RealOptionKey
7. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringOptionKey) -> rosetta.utility.options.StringOption
Option by StringOptionKey
8. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringOptionKey) -> rosetta.utility.options.StringOption
Option by StringOptionKey
9. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileOptionKey) -> rosetta.utility.options.FileOption
Option by FileOptionKey
10. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileOptionKey) -> rosetta.utility.options.FileOption
Option by FileOptionKey
11. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathOptionKey) -> rosetta.utility.options.PathOption
Option by PathOptionKey
12. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathOptionKey) -> rosetta.utility.options.PathOption
Option by PathOptionKey
13. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyOptionKey) -> rosetta.utility.options.Option
Option by AnyOptionKey
14. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyOptionKey) -> rosetta.utility.options.Option
Option by AnyOptionKey
15. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanVectorOptionKey) -> rosetta.utility.options.BooleanVectorOption
VectorOption by BooleanVectorOptionKey
16. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.BooleanVectorOptionKey) -> rosetta.utility.options.BooleanVectorOption
VectorOption by BooleanVectorOptionKey
17. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerVectorOptionKey) -> rosetta.utility.options.IntegerVectorOption
VectorOption by IntegerVectorOptionKey
18. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.IntegerVectorOptionKey) -> rosetta.utility.options.IntegerVectorOption
VectorOption by IntegerVectorOptionKey
19. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealVectorOptionKey) -> rosetta.utility.options.RealVectorOption
VectorOption by RealVectorOptionKey
20. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.RealVectorOptionKey) -> rosetta.utility.options.RealVectorOption
VectorOption by RealVectorOptionKey
21. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringVectorOptionKey) -> rosetta.utility.options.StringVectorOption
VectorOption by StringVectorOptionKey
22. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.StringVectorOptionKey) -> rosetta.utility.options.StringVectorOption
VectorOption by StringVectorOptionKey
23. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileVectorOptionKey) -> rosetta.utility.options.FileVectorOption
VectorOption by FileVectorOptionKey
24. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.FileVectorOptionKey) -> rosetta.utility.options.FileVectorOption
VectorOption by FileVectorOptionKey
25. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathVectorOptionKey) -> rosetta.utility.options.PathVectorOption
VectorOption by PathVectorOptionKey
26. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.PathVectorOptionKey) -> rosetta.utility.options.PathVectorOption
VectorOption by PathVectorOptionKey
27. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyVectorOptionKey) -> rosetta.utility.options.VectorOption
VectorOption by AnyVectorOptionKey
28. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.AnyVectorOptionKey) -> rosetta.utility.options.VectorOption
VectorOption by AnyVectorOptionKey
29. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.OptionKey) -> rosetta.utility.options.Option
Option by OptionKey
30. option(self : rosetta.utility.options.OptionCollection, key : rosetta.utility.options.OptionKey) -> rosetta.utility.options.Option
Option by OptionKey
- prefix(...) from builtins.PyCapsule
- prefix(*args, **kwargs)
Overloaded function.
1. prefix(s : str) -> str
Prefix of an option id with a specified number of parts
2. prefix(s : str, n : int) -> str
Prefix of an option id with a specified number of parts
- set_show_accessed_options_flag(...) from builtins.PyCapsule
- set_show_accessed_options_flag(v : bool) -> NoneType
modify 'show_accessed_options' flag;
- set_show_unused_options_flag(...) from builtins.PyCapsule
- set_show_unused_options_flag(v : bool) -> NoneType
modify 'show_unused_options' flag;
- space_prefixed(...) from builtins.PyCapsule
- space_prefixed(*args, **kwargs)
Overloaded function.
1. space_prefixed(s : str) -> str
Space-prefixed string except blank if string is empty
2. space_prefixed(s : str, n : int) -> str
Space-prefixed string except blank if string is empty
- suffix(...) from builtins.PyCapsule
- suffix(*args, **kwargs)
Overloaded function.
1. suffix(s : str) -> str
Suffix of an option id with a specified number of parts
2. suffix(s : str, n : int) -> str
Suffix of an option id with a specified number of parts
- tab_prefixed(...) from builtins.PyCapsule
- tab_prefixed(*args, **kwargs)
Overloaded function.
1. tab_prefixed(s : str) -> str
Tab-prefixed string except blank if string is empty
2. tab_prefixed(s : str, n : int) -> str
Tab-prefixed string except blank if string is empty
- trim(...) from builtins.PyCapsule
- trim(*args, **kwargs)
Overloaded function.
1. trim(s : str) -> str
Trim a specified number of parts from the suffix of an option id
2. trim(s : str, n : int) -> str
Trim a specified number of parts from the suffix of an option id
- trimmed(...) from builtins.PyCapsule
- trimmed(*args, **kwargs)
Overloaded function.
1. trimmed(s : str) -> str
Prefix of an option id with a specified number of suffix parts removed
2. trimmed(s : str, n : int) -> str
Prefix of an option id with a specified number of suffix parts removed
- wrapped(...) from builtins.PyCapsule
- wrapped(*args, **kwargs)
Overloaded function.
1. wrapped(s : str) -> str
String wrapped and indented
2. wrapped(s : str, indent : int) -> str
String wrapped and indented
3. wrapped(s : str, indent : int, width : int) -> str
String wrapped and indented
4. wrapped(s : str, indent : int, width : int, header_for_extra_lines : str) -> str
String wrapped and indented
|
class OptionKey(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) |
|
Abstract automatic hidden index key for options |
|
- Method resolution order:
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.OptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.OptionKey
Key assignment
2. assign(self : rosetta.utility.options.OptionKey, : rosetta.utility.options.OptionKey) -> rosetta.utility.options.OptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.OptionKey) -> rosetta.utility.options.OptionKey
Clone this
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.OptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.OptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class OptionTypes(builtins.object) |
|
Option types enumeration |
|
Methods defined here:
- __eq__(...) from builtins.PyCapsule
- __eq__(rosetta.utility.options.OptionTypes, rosetta.utility.options.OptionTypes) -> bool
- __hash__(...) from builtins.PyCapsule
- __hash__(rosetta.utility.options.OptionTypes) -> int
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(rosetta.utility.options.OptionTypes, int) -> NoneType
2. __init__(rosetta.utility.options.OptionTypes, int) -> NoneType
- __int__(...) from builtins.PyCapsule
- __int__(rosetta.utility.options.OptionTypes) -> int
- __ne__(...) from builtins.PyCapsule
- __ne__(rosetta.utility.options.OptionTypes, rosetta.utility.options.OptionTypes) -> bool
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- __repr__(...) from builtins.PyCapsule
- __repr__(rosetta.utility.options.OptionTypes) -> str
Data and other attributes defined here:
- ANY_OPTION = OptionTypes.ANY_OPTION
- ANY_VECTOR_OPTION = OptionTypes.ANY_VECTOR_OPTION
- BOOLEAN_OPTION = OptionTypes.BOOLEAN_OPTION
- BOOLEAN_VECTOR_OPTION = OptionTypes.BOOLEAN_VECTOR_OPTION
- FILE_OPTION = OptionTypes.FILE_OPTION
- FILE_VECTOR_OPTION = OptionTypes.FILE_VECTOR_OPTION
- INTEGER_OPTION = OptionTypes.INTEGER_OPTION
- INTEGER_VECTOR_OPTION = OptionTypes.INTEGER_VECTOR_OPTION
- PATH_OPTION = OptionTypes.PATH_OPTION
- PATH_VECTOR_OPTION = OptionTypes.PATH_VECTOR_OPTION
- REAL_OPTION = OptionTypes.REAL_OPTION
- REAL_VECTOR_OPTION = OptionTypes.REAL_VECTOR_OPTION
- RESIDUE_CHAIN_VECTOR_OPTION = OptionTypes.RESIDUE_CHAIN_VECTOR_OPTION
- STRING_OPTION = OptionTypes.STRING_OPTION
- STRING_VECTOR_OPTION = OptionTypes.STRING_VECTOR_OPTION
- UNKNOWN_OPTION = OptionTypes.UNKNOWN_OPTION
|
class PathOption(ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) |
|
Program path option class |
|
- Method resolution order:
- PathOption
- ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(self : rosetta.utility.options.PathOption, value_a : str) -> rosetta.utility.options.PathOption
Value assignment
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.PathOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.PathOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.PathOption, : rosetta.utility.options.PathOption) -> rosetta.utility.options.PathOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.PathOption) -> rosetta.utility.options.PathOption
Clone this
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.PathOption, value_a : str) -> rosetta.utility.options.PathOption
Default value assignment
- default_value(...) from builtins.PyCapsule
- default_value(self : rosetta.utility.options.PathOption, value_a : str) -> rosetta.utility.options.PathOption
Default value assignment
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.PathOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.PathOption, : str) -> bool
Is a string readable as this option's value type?
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.PathOption) -> str
Option type code string representation
- value(...) from builtins.PyCapsule
- value(self : rosetta.utility.options.PathOption, value_a : str) -> rosetta.utility.options.PathOption
Value assignment
Methods inherited from ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t:
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, option : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.PathOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.Bound_utility_file_PathName_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.Bound_utility_file_PathName_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class PathOptionKey(ScalarOptionKey) |
|
Automatic hidden index key for path options |
|
- Method resolution order:
- PathOptionKey
- ScalarOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.PathOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.PathOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.PathOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.PathOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.PathOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.PathOptionKey
Key assignment
2. assign(self : rosetta.utility.options.PathOptionKey, : rosetta.utility.options.PathOptionKey) -> rosetta.utility.options.PathOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.PathOptionKey) -> rosetta.utility.options.PathOptionKey
Clone this
Methods inherited from ScalarOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.ScalarOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.ScalarOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class PathVectorOption(VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) |
|
Program path vector option class |
|
- Method resolution order:
- PathVectorOption
- VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(self : rosetta.utility.options.PathVectorOption, value_a : str) -> rosetta.utility.options.PathVectorOption
Value assignment
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.PathVectorOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.PathVectorOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.PathVectorOption, : rosetta.utility.options.PathVectorOption) -> rosetta.utility.options.PathVectorOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.PathVectorOption) -> rosetta.utility.options.PathVectorOption
Clone this
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.PathVectorOption, value_a : str) -> rosetta.utility.options.PathVectorOption
Default value assignment
- default_value(...) from builtins.PyCapsule
- default_value(self : rosetta.utility.options.PathVectorOption, value_a : str) -> rosetta.utility.options.PathVectorOption
Default value assignment
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.PathVectorOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.PathVectorOption, : str) -> bool
Is a string readable as this option's value type?
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.PathVectorOption) -> str
Option type code string representation
- value(...) from builtins.PyCapsule
- value(self : rosetta.utility.options.PathVectorOption, value_a : str) -> rosetta.utility.options.PathVectorOption
Value assignment
Methods inherited from VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t:
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, i : int) -> rosetta.utility.file.PathName
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, option : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value : rosetta.utility.file.PathName) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.PathVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.Bound_utility_file_PathName_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.Bound_utility_file_PathName_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.vector1_utility_file_PathName) -> rosetta.utility.vector1_utility_file_PathName
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, i : int, value_a : rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.vector1_utility_file_PathName) -> rosetta.utility.vector1_utility_file_PathName
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, i : int, value_a : rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class PathVectorOptionKey(VectorOptionKey) |
|
Automatic hidden index key for path options |
|
- Method resolution order:
- PathVectorOptionKey
- VectorOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.PathVectorOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.PathVectorOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.PathVectorOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.PathVectorOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.PathVectorOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.PathVectorOptionKey
Key assignment
2. assign(self : rosetta.utility.options.PathVectorOptionKey, : rosetta.utility.options.PathVectorOptionKey) -> rosetta.utility.options.PathVectorOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.PathVectorOptionKey) -> rosetta.utility.options.PathVectorOptionKey
Clone this
Methods inherited from VectorOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.VectorOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.VectorOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class RealOption(ScalarOption_T__utility_options_RealOptionKey_double_t) |
|
Program real option class |
|
- Method resolution order:
- RealOption
- ScalarOption_T__utility_options_RealOptionKey_double_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.RealOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.RealOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.RealOption, : rosetta.utility.options.RealOption) -> rosetta.utility.options.RealOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.RealOption) -> rosetta.utility.options.RealOption
Clone this
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.RealOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.RealOption, value_str : str) -> bool
Is a string readable as this option's value type?
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.RealOption) -> str
Option type code string representation
Methods inherited from ScalarOption_T__utility_options_RealOptionKey_double_t:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. __call__(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> float
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, option : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. default_value(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> float
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.RealOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.Bound_double_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.Bound_double_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> float
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. value(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> float
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> float
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class RealOptionKey(ScalarOptionKey) |
|
Automatic hidden index key for real options |
|
- Method resolution order:
- RealOptionKey
- ScalarOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.RealOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.RealOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.RealOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.RealOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.RealOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.RealOptionKey
Key assignment
2. assign(self : rosetta.utility.options.RealOptionKey, : rosetta.utility.options.RealOptionKey) -> rosetta.utility.options.RealOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.RealOptionKey) -> rosetta.utility.options.RealOptionKey
Clone this
Methods inherited from ScalarOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.ScalarOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.ScalarOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class RealVectorOption(VectorOption_T__utility_options_RealVectorOptionKey_double_t) |
|
Program real vector option class |
|
- Method resolution order:
- RealVectorOption
- VectorOption_T__utility_options_RealVectorOptionKey_double_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.RealVectorOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.RealVectorOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.RealVectorOption, : rosetta.utility.options.RealVectorOption) -> rosetta.utility.options.RealVectorOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.RealVectorOption) -> rosetta.utility.options.RealVectorOption
Clone this
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.RealVectorOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.RealVectorOption, value_str : str) -> bool
Is a string readable as this option's value type?
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.RealVectorOption) -> str
Option type code string representation
Methods inherited from VectorOption_T__utility_options_RealVectorOptionKey_double_t:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.vector1_double
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int) -> float
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int) -> float
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, option : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.vector1_double
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int) -> float
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value : float) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.RealVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.Bound_double_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.Bound_double_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.vector1_double
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int, value_a : float) -> float
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.vector1_double
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int) -> float
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.vector1_double
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int, value_a : float) -> float
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class RealVectorOptionKey(VectorOptionKey) |
|
Automatic hidden index key for real options |
|
- Method resolution order:
- RealVectorOptionKey
- VectorOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.RealVectorOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.RealVectorOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.RealVectorOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.RealVectorOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.RealVectorOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.RealVectorOptionKey
Key assignment
2. assign(self : rosetta.utility.options.RealVectorOptionKey, : rosetta.utility.options.RealVectorOptionKey) -> rosetta.utility.options.RealVectorOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.RealVectorOptionKey) -> rosetta.utility.options.RealVectorOptionKey
Clone this
Methods inherited from VectorOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.VectorOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.VectorOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class ResidueChainVectorOption(VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) |
|
Program integer vector option class |
|
- Method resolution order:
- ResidueChainVectorOption
- VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.ResidueChainVectorOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.ResidueChainVectorOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.ResidueChainVectorOption, : rosetta.utility.options.ResidueChainVectorOption) -> rosetta.utility.options.ResidueChainVectorOption
- cl_value(...) from builtins.PyCapsule
- cl_value(self : rosetta.utility.options.ResidueChainVectorOption, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.ResidueChainVectorOption) -> rosetta.utility.options.ResidueChainVectorOption
Clone this
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ResidueChainVectorOption, other : rosetta.utility.options.Option) -> NoneType
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.ResidueChainVectorOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.ResidueChainVectorOption, : str) -> bool
Is a string readable as this option's value type?
- resnum_and_chain(...) from builtins.PyCapsule
- resnum_and_chain(rosetta.utility.options.ResidueChainVectorOption) -> (rosetta.utility.vector1_int, rosetta.utility.vector1_char)
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.ResidueChainVectorOption) -> str
Option type code string representation
Methods inherited from VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int) -> int
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int) -> int
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, option : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int) -> int
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value : int) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.ResidueChainVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.Bound_int_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.Bound_int_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.vector1_int
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int, value_a : int) -> int
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int) -> int
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.vector1_int
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int, value_a : int) -> int
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class ResidueChainVectorOptionKey(VectorOptionKey) |
|
Automatic hidden index key for integer options |
|
- Method resolution order:
- ResidueChainVectorOptionKey
- VectorOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.ResidueChainVectorOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.ResidueChainVectorOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.ResidueChainVectorOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.ResidueChainVectorOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.ResidueChainVectorOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.ResidueChainVectorOptionKey
Key assignment
2. assign(self : rosetta.utility.options.ResidueChainVectorOptionKey, : rosetta.utility.options.ResidueChainVectorOptionKey) -> rosetta.utility.options.ResidueChainVectorOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.ResidueChainVectorOptionKey) -> rosetta.utility.options.ResidueChainVectorOptionKey
Clone this
Methods inherited from VectorOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.VectorOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.VectorOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class ScalarOption(Option) |
|
Program scalar-valued option interface class |
|
- Method resolution order:
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- cl_value(...) from builtins.PyCapsule
- cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clone this
- deactivate(...) from builtins.PyCapsule
- deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- to_default(...) from builtins.PyCapsule
- to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
Methods inherited from Option:
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.Option) -> bool
Active? That is, the option has some value, either the default one or specified on the command line.
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.Option) -> bool
Can another value be added and stay within any size constraints?
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.Option) -> str
Code
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.Option, other : rosetta.utility.options.Option) -> NoneType
Copy operation -- requires that other match the type of this.
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.Option) -> bool
Default active?
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.Option) -> bool
Default inactive?
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.Option) -> int
Default size (number of default values)
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.Option) -> str
Default value string representation
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.Option) -> str
Description
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.Option) -> str
=Value string representation
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.Option) -> bool
Has a default?
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.Option) -> str
ID
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.Option) -> str
Identifier
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.Option) -> rosetta.utility.options.OptionKey
Key
- legal(...) from builtins.PyCapsule
- legal(rosetta.utility.options.Option) -> bool
Legal value?
- legal_check(...) from builtins.PyCapsule
- legal_check(rosetta.utility.options.Option) -> NoneType
Legal value check
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.Option) -> bool
Legal or inactive default value?
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(rosetta.utility.options.Option) -> NoneType
Legal default value check
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.Option) -> bool
Legal default value check: Report and return error state
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.Option) -> bool
Legal value limits check: Report and return error state
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.Option) -> bool
Legal value check: Report and return error state
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.Option) -> bool
Legal size limits check: Report and return error state
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.Option) -> bool
Legal specifications check: Report and return error state
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.Option) -> str
Legal value string representation
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.Option) -> int
Number of default values (default size)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.Option) -> int
Number of values (size)
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.Option) -> str
Name
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.Option) -> str
Default value string representation
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.Option) -> str
Value string representation
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- short_description(...) from builtins.PyCapsule
- short_description(rosetta.utility.options.Option) -> str
short_Description
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.Option) -> int
Size (number of values)
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.Option) -> str
Size constraint string representation
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.Option) -> NoneType
Required specified option check
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.Option) -> bool
Required specified option check: Report and return error state
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
- user(...) from builtins.PyCapsule
- user(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!
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.Option) -> str
Value string representation
|
class ScalarOptionKey(OptionKey) |
|
Abstract automatic hidden index key for scalar-valued options |
|
- Method resolution order:
- ScalarOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.ScalarOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.ScalarOptionKey
Key assignment
2. assign(self : rosetta.utility.options.ScalarOptionKey, : rosetta.utility.options.ScalarOptionKey) -> rosetta.utility.options.ScalarOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.ScalarOptionKey) -> rosetta.utility.options.ScalarOptionKey
Clone this
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.ScalarOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.ScalarOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class ScalarOption_T__utility_options_BooleanOptionKey_bool_t(ScalarOption) |
| |
- Method resolution order:
- ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. __call__(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. clone(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, option : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. default_value(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.BooleanOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.Bound_bool_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> rosetta.utility.Bound_bool_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> bool
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t
2. value(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> bool
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t, value_a : bool) -> bool
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_BooleanOptionKey_bool_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t(ScalarOption) |
| |
- Method resolution order:
- ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. __call__(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.file.FileName
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. clone(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, option : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. default_value(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.file.FileName
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.FileOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.Bound_utility_file_FileName_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.Bound_utility_file_FileName_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t
2. value(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> rosetta.utility.file.FileName
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_FileOptionKey_utility_file_FileName_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class ScalarOption_T__utility_options_IntegerOptionKey_int_t(ScalarOption) |
| |
- Method resolution order:
- ScalarOption_T__utility_options_IntegerOptionKey_int_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. __call__(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. clone(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, option : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. default_value(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.IntegerOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.Bound_int_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> rosetta.utility.Bound_int_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> int
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t
2. value(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> int
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t, value_a : int) -> int
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_IntegerOptionKey_int_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t(ScalarOption) |
| |
- Method resolution order:
- ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. __call__(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.file.PathName
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. clone(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, option : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. default_value(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.file.PathName
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.PathOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.Bound_utility_file_PathName_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.Bound_utility_file_PathName_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t
2. value(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> rosetta.utility.file.PathName
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_PathOptionKey_utility_file_PathName_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class ScalarOption_T__utility_options_RealOptionKey_double_t(ScalarOption) |
| |
- Method resolution order:
- ScalarOption_T__utility_options_RealOptionKey_double_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. __call__(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> float
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. clone(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, option : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. default_value(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> float
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.RealOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.Bound_double_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> rosetta.utility.Bound_double_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> float
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t
2. value(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> float
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t, value_a : float) -> float
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_RealOptionKey_double_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class ScalarOption_T__utility_options_StringOptionKey_std_string_t(ScalarOption) |
| |
- Method resolution order:
- ScalarOption_T__utility_options_StringOptionKey_std_string_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. __call__(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. clone(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, option : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. default_value(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.StringOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.Bound_std_string_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.Bound_std_string_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> str
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. value(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> str
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class StringOption(ScalarOption_T__utility_options_StringOptionKey_std_string_t) |
|
Program string option class |
|
- Method resolution order:
- StringOption
- ScalarOption_T__utility_options_StringOptionKey_std_string_t
- ScalarOption
- Option
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.StringOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.StringOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.StringOption, : rosetta.utility.options.StringOption) -> rosetta.utility.options.StringOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.StringOption) -> rosetta.utility.options.StringOption
Clone this
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.StringOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.StringOption, : str) -> bool
Is a string readable as this option's value type?
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.StringOption) -> str
Option type code string representation
Methods inherited from ScalarOption_T__utility_options_StringOptionKey_std_string_t:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. __call__(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. activate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_str : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> rosetta.utility.options.ScalarOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. clear(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. deactivate(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Deactivate
- def(...) from builtins.PyCapsule
- def(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, option : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. default_value(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- description(...) from builtins.PyCapsule
- description(*args, **kwargs)
Overloaded function.
1. description(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
2. description(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, sd : str) -> NoneType
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.StringOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. legal(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> NoneType
2. legal_check(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> bool
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. lower(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.Bound_std_string_t
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> int
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.ScalarOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a ScalarOption & return type.
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
2. short_description(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, s : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. to_default(rosetta.utility.options.ScalarOption) -> rosetta.utility.options.ScalarOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. upper(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> rosetta.utility.Bound_std_string_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> str
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t
2. value(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
- value_or(...) from builtins.PyCapsule
- value_or(self : rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t, value_a : str) -> str
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.ScalarOption_T__utility_options_StringOptionKey_std_string_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class StringOptionKey(ScalarOptionKey) |
|
Automatic hidden index key for string options |
|
- Method resolution order:
- StringOptionKey
- ScalarOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.StringOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.StringOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.StringOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.StringOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.StringOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.StringOptionKey
Key assignment
2. assign(self : rosetta.utility.options.StringOptionKey, : rosetta.utility.options.StringOptionKey) -> rosetta.utility.options.StringOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.StringOptionKey) -> rosetta.utility.options.StringOptionKey
Clone this
Methods inherited from ScalarOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.ScalarOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.ScalarOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class StringVectorOption(VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) |
|
Program string option class |
|
- Method resolution order:
- StringVectorOption
- VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(self : handle, key_a : rosetta.utility.options.StringVectorOptionKey, description_a : str) -> NoneType
3. __init__(handle, rosetta.utility.options.StringVectorOption) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.options.StringVectorOption, : rosetta.utility.options.StringVectorOption) -> rosetta.utility.options.StringVectorOption
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.StringVectorOption) -> rosetta.utility.options.StringVectorOption
Clone this
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.StringVectorOption, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.StringVectorOption, : str) -> bool
Is a string readable as this option's value type?
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.StringVectorOption) -> str
Option type code string representation
Methods inherited from VectorOption_T__utility_options_StringVectorOptionKey_std_string_t:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.vector1_std_string
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int) -> str
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int) -> str
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, option : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.vector1_std_string
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int) -> str
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value : str) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.StringVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.Bound_std_string_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.Bound_std_string_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.vector1_std_string
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int, value_a : str) -> str
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.vector1_std_string
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int) -> str
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.vector1_std_string
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int, value_a : str) -> str
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
|
class StringVectorOptionKey(VectorOptionKey) |
|
Automatic hidden index key for string options |
|
- Method resolution order:
- StringVectorOptionKey
- VectorOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, rosetta.utility.options.StringVectorOptionKey, str) -> NoneType
doc
3. __init__(handle, rosetta.utility.options.StringVectorOptionKey, str, str) -> NoneType
doc
4. __init__(self : handle, key : rosetta.utility.options.StringVectorOptionKey, id_a : str, identifier_a : str, code_a : str) -> NoneType
5. __init__(self : handle, key : rosetta.utility.keys.Key) -> NoneType
6. __init__(handle, rosetta.utility.keys.Key, str) -> NoneType
doc
7. __init__(handle, rosetta.utility.keys.Key, str, str) -> NoneType
doc
8. __init__(self : handle, key : rosetta.utility.keys.Key, id_a : str, identifier_a : str, code_a : str) -> NoneType
9. __init__(handle, str) -> NoneType
doc
10. __init__(handle, str, str) -> NoneType
doc
11. __init__(self : handle, id_a : str, identifier_a : str, code_a : str) -> NoneType
12. __init__(handle, rosetta.utility.options.StringVectorOptionKey) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.StringVectorOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.StringVectorOptionKey
Key assignment
2. assign(self : rosetta.utility.options.StringVectorOptionKey, : rosetta.utility.options.StringVectorOptionKey) -> rosetta.utility.options.StringVectorOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.StringVectorOptionKey) -> rosetta.utility.options.StringVectorOptionKey
Clone this
Methods inherited from VectorOptionKey:
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.VectorOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.VectorOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class VectorOption(Option) |
|
Program vector-valued option interface class |
|
- Method resolution order:
- VectorOption
- Option
- builtins.object
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- cl_value(...) from builtins.PyCapsule
- cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clone this
- deactivate(...) from builtins.PyCapsule
- deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- fixed_size(...) from builtins.PyCapsule
- fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_size(...) from builtins.PyCapsule
- legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_value(...) from builtins.PyCapsule
- legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
2. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
2. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
2. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- to_default(...) from builtins.PyCapsule
- to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
Methods inherited from Option:
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.Option) -> bool
Active? That is, the option has some value, either the default one or specified on the command line.
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.Option) -> bool
Can another value be added and stay within any size constraints?
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.Option) -> str
Code
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.Option, other : rosetta.utility.options.Option) -> NoneType
Copy operation -- requires that other match the type of this.
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.Option) -> bool
Default active?
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.Option) -> bool
Default inactive?
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.Option) -> int
Default size (number of default values)
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.Option) -> str
Default value string representation
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.Option) -> str
Description
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.Option) -> str
=Value string representation
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.Option) -> bool
Has a default?
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.Option) -> str
ID
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.Option) -> str
Identifier
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.Option) -> rosetta.utility.options.OptionKey
Key
- legal(...) from builtins.PyCapsule
- legal(rosetta.utility.options.Option) -> bool
Legal value?
- legal_check(...) from builtins.PyCapsule
- legal_check(rosetta.utility.options.Option) -> NoneType
Legal value check
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.Option) -> bool
Legal or inactive default value?
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(rosetta.utility.options.Option) -> NoneType
Legal default value check
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.Option) -> bool
Legal default value check: Report and return error state
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.Option) -> bool
Legal value limits check: Report and return error state
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.Option) -> bool
Legal value check: Report and return error state
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.Option) -> bool
Legal size limits check: Report and return error state
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.Option) -> bool
Legal specifications check: Report and return error state
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.Option) -> str
Legal value string representation
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.Option) -> int
Number of default values (default size)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.Option) -> int
Number of values (size)
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.Option) -> str
Name
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.Option) -> str
Default value string representation
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.Option) -> str
Value string representation
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- short_description(...) from builtins.PyCapsule
- short_description(rosetta.utility.options.Option) -> str
short_Description
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.Option) -> int
Size (number of values)
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.Option) -> str
Size constraint string representation
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.Option) -> NoneType
Required specified option check
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.Option) -> bool
Required specified option check: Report and return error state
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
- user(...) from builtins.PyCapsule
- user(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!
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.Option) -> str
Value string representation
|
class VectorOptionKey(OptionKey) |
|
Abstract automatic hidden index key for vector-valued options |
|
- Method resolution order:
- VectorOptionKey
- OptionKey
- rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
- rosetta.utility.keys.Key
- builtins.object
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(*args, **kwargs)
Overloaded function.
1. assign(self : rosetta.utility.options.VectorOptionKey, key : rosetta.utility.keys.Key) -> rosetta.utility.options.VectorOptionKey
Key assignment
2. assign(self : rosetta.utility.options.VectorOptionKey, : rosetta.utility.options.VectorOptionKey) -> rosetta.utility.options.VectorOptionKey
- clone(...) from builtins.PyCapsule
- clone(rosetta.utility.options.VectorOptionKey) -> rosetta.utility.options.VectorOptionKey
Clone this
- scalar(...) from builtins.PyCapsule
- scalar(rosetta.utility.options.VectorOptionKey) -> bool
Scalar option key?
- vector(...) from builtins.PyCapsule
- vector(rosetta.utility.options.VectorOptionKey) -> bool
Vector option key?
Methods inherited from rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t:
- code(...) from builtins.PyCapsule
- code(*args, **kwargs)
Overloaded function.
1. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. code(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. code(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, code_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. code(rosetta.utility.keys.Key) -> str
Code
5. code(rosetta.utility.keys.Key) -> str
Code
6. code(self : rosetta.utility.keys.Key, code_a : str) -> rosetta.utility.keys.Key
Code assignment
- id(...) from builtins.PyCapsule
- id(*args, **kwargs)
Overloaded function.
1. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. id(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. id(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, id_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. id(rosetta.utility.keys.Key) -> str
ID
5. id(rosetta.utility.keys.Key) -> str
ID
6. id(self : rosetta.utility.keys.Key, id_a : str) -> rosetta.utility.keys.Key
ID assignment
- identifier(...) from builtins.PyCapsule
- identifier(*args, **kwargs)
Overloaded function.
1. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
2. identifier(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> str
3. identifier(self : rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, identifier_a : str) -> rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t
4. identifier(rosetta.utility.keys.Key) -> str
Identifier
5. identifier(rosetta.utility.keys.Key) -> str
Identifier
6. identifier(self : rosetta.utility.keys.Key, identifier_a : str) -> rosetta.utility.keys.Key
Identifier assignment
- n_key(...) from builtins.PyCapsule
- n_key() -> int
- private_index(...) from builtins.PyCapsule
- private_index(*args, **kwargs)
Overloaded function.
1. private_index(rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int
2. private_index(rosetta.utility.keys.Key) -> int
Index
Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!
|
class VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t(VectorOption) |
| |
- Method resolution order:
- VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.vector1_bool
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int) -> bool
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int) -> bool
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. clone(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, option : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.vector1_bool
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int) -> bool
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value : bool) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.BooleanVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.Bound_bool_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.Bound_bool_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.vector1_bool
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int, value_a : bool) -> bool
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> rosetta.utility.vector1_bool
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int) -> bool
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, value_a : rosetta.utility.vector1_bool) -> rosetta.utility.vector1_bool
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t, i : int, value_a : bool) -> bool
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_BooleanVectorOptionKey_bool_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t(VectorOption) |
| |
- Method resolution order:
- VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.vector1_utility_file_FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.vector1_utility_file_FileName
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i : int) -> rosetta.utility.file.FileName
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i : int) -> rosetta.utility.file.FileName
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. clone(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.vector1_utility_file_FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, option : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.vector1_utility_file_FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.vector1_utility_file_FileName
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i : int) -> rosetta.utility.file.FileName
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value : rosetta.utility.file.FileName) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.FileVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.Bound_utility_file_FileName_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.Bound_utility_file_FileName_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.vector1_utility_file_FileName) -> rosetta.utility.vector1_utility_file_FileName
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i : int, value_a : rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.file.FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.vector1_utility_file_FileName) -> rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> rosetta.utility.vector1_utility_file_FileName
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i : int) -> rosetta.utility.file.FileName
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, value_a : rosetta.utility.vector1_utility_file_FileName) -> rosetta.utility.vector1_utility_file_FileName
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t, i : int, value_a : rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_FileVectorOptionKey_utility_file_FileName_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class VectorOption_T__utility_options_IntegerVectorOptionKey_int_t(VectorOption) |
| |
- Method resolution order:
- VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int) -> int
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int) -> int
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. clone(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, option : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int) -> int
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value : int) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.IntegerVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.Bound_int_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.Bound_int_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.vector1_int
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int, value_a : int) -> int
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int) -> int
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.vector1_int
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t, i : int, value_a : int) -> int
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_IntegerVectorOptionKey_int_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t(VectorOption) |
| |
- Method resolution order:
- VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.vector1_utility_file_PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.vector1_utility_file_PathName
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, i : int) -> rosetta.utility.file.PathName
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, i : int) -> rosetta.utility.file.PathName
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. clone(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.vector1_utility_file_PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, option : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.vector1_utility_file_PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.vector1_utility_file_PathName
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, i : int) -> rosetta.utility.file.PathName
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value : rosetta.utility.file.PathName) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.PathVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.Bound_utility_file_PathName_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.Bound_utility_file_PathName_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.vector1_utility_file_PathName) -> rosetta.utility.vector1_utility_file_PathName
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, i : int, value_a : rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.file.PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.vector1_utility_file_PathName) -> rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> rosetta.utility.vector1_utility_file_PathName
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, i : int) -> rosetta.utility.file.PathName
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, value_a : rosetta.utility.vector1_utility_file_PathName) -> rosetta.utility.vector1_utility_file_PathName
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t, i : int, value_a : rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_PathVectorOptionKey_utility_file_PathName_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class VectorOption_T__utility_options_RealVectorOptionKey_double_t(VectorOption) |
| |
- Method resolution order:
- VectorOption_T__utility_options_RealVectorOptionKey_double_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.vector1_double
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int) -> float
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int) -> float
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. clone(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, option : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.vector1_double
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int) -> float
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value : float) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.RealVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.Bound_double_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.Bound_double_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.vector1_double
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int, value_a : float) -> float
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : float) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> rosetta.utility.vector1_double
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int) -> float
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, value_a : rosetta.utility.vector1_double) -> rosetta.utility.vector1_double
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t, i : int, value_a : float) -> float
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_RealVectorOptionKey_double_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t(VectorOption) |
| |
- Method resolution order:
- VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int) -> int
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int) -> int
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. clone(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, option : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int) -> int
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value : int) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.ResidueChainVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.Bound_int_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.Bound_int_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.vector1_int
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int, value_a : int) -> int
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> rosetta.utility.vector1_int
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int) -> int
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, value_a : rosetta.utility.vector1_int) -> rosetta.utility.vector1_int
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t, i : int, value_a : int) -> int
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_ResidueChainVectorOptionKey_int_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
|
class VectorOption_T__utility_options_StringVectorOptionKey_std_string_t(VectorOption) |
| |
- Method resolution order:
- VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- VectorOption
- Option
- builtins.object
Methods defined here:
- __call__(...) from builtins.PyCapsule
- __call__(*args, **kwargs)
Overloaded function.
1. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
3. __call__(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.vector1_std_string
4. __call__(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int) -> str
- __getitem__(...) from builtins.PyCapsule
- __getitem__(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int) -> str
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- activate(...) from builtins.PyCapsule
- activate(*args, **kwargs)
Overloaded function.
1. activate(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. activate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Activate
- active(...) from builtins.PyCapsule
- active(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- can_hold_another(...) from builtins.PyCapsule
- can_hold_another(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- cl_value(...) from builtins.PyCapsule
- cl_value(*args, **kwargs)
Overloaded function.
1. cl_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_str : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> rosetta.utility.options.VectorOption
Value assignment from a command line string
- clear(...) from builtins.PyCapsule
- clear(*args, **kwargs)
Overloaded function.
1. clear(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. clear(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clear
- clone(...) from builtins.PyCapsule
- clone(*args, **kwargs)
Overloaded function.
1. clone(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. clone(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Clone this
- code(...) from builtins.PyCapsule
- code(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- copy_from(...) from builtins.PyCapsule
- copy_from(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, other : rosetta.utility.options.Option) -> NoneType
- deactivate(...) from builtins.PyCapsule
- deactivate(*args, **kwargs)
Overloaded function.
1. deactivate(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. deactivate(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Deactivate
- def(...) from builtins.PyCapsule
- def(*args, **kwargs)
Overloaded function.
1. def(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. def(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
3. def(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- default_active(...) from builtins.PyCapsule
- default_active(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- default_inactive(...) from builtins.PyCapsule
- default_inactive(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- default_size(...) from builtins.PyCapsule
- default_size(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
- default_string(...) from builtins.PyCapsule
- default_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- default_to(...) from builtins.PyCapsule
- default_to(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, option : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- default_value(...) from builtins.PyCapsule
- default_value(*args, **kwargs)
Overloaded function.
1. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
3. default_value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.vector1_std_string
4. default_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int) -> str
- description(...) from builtins.PyCapsule
- description(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- equals_string(...) from builtins.PyCapsule
- equals_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- fixed_size(...) from builtins.PyCapsule
- fixed_size(*args, **kwargs)
Overloaded function.
1. fixed_size(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
2. fixed_size(rosetta.utility.options.VectorOption) -> bool
Fixed number of values required?
- has_any_of_characters(...) from builtins.PyCapsule
- has_any_of_characters(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, str_ : str, s : str) -> bool
- has_default(...) from builtins.PyCapsule
- has_default(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- has_value(...) from builtins.PyCapsule
- has_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value : str) -> bool
- id(...) from builtins.PyCapsule
- id(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- identifier(...) from builtins.PyCapsule
- identifier(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- key(...) from builtins.PyCapsule
- key(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.StringVectorOptionKey
- legal(...) from builtins.PyCapsule
- legal(*args, **kwargs)
Overloaded function.
1. legal(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. legal(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_check(...) from builtins.PyCapsule
- legal_check(*args, **kwargs)
Overloaded function.
1. legal_check(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> NoneType
2. legal_check(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> NoneType
- legal_default(...) from builtins.PyCapsule
- legal_default(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_default_check(...) from builtins.PyCapsule
- legal_default_check(*args, **kwargs)
Overloaded function.
1. legal_default_check(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> NoneType
2. legal_default_check(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> NoneType
- legal_default_report(...) from builtins.PyCapsule
- legal_default_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_default_size(...) from builtins.PyCapsule
- legal_default_size(*args, **kwargs)
Overloaded function.
1. legal_default_size(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
2. legal_default_size(rosetta.utility.options.VectorOption) -> bool
Legal default value size?
- legal_default_value(...) from builtins.PyCapsule
- legal_default_value(*args, **kwargs)
Overloaded function.
1. legal_default_value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
2. legal_default_value(rosetta.utility.options.VectorOption) -> bool
Legal or inactive default value?
- legal_limits_report(...) from builtins.PyCapsule
- legal_limits_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_report(...) from builtins.PyCapsule
- legal_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_size(...) from builtins.PyCapsule
- legal_size(*args, **kwargs)
Overloaded function.
1. legal_size(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
2. legal_size(rosetta.utility.options.VectorOption) -> bool
Legal value size?
- legal_size_report(...) from builtins.PyCapsule
- legal_size_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_specs_report(...) from builtins.PyCapsule
- legal_specs_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- legal_string(...) from builtins.PyCapsule
- legal_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- legal_value(...) from builtins.PyCapsule
- legal_value(*args, **kwargs)
Overloaded function.
1. legal_value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
2. legal_value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> bool
3. legal_value(rosetta.utility.options.VectorOption) -> bool
Legal value?
- lower(...) from builtins.PyCapsule
- lower(*args, **kwargs)
Overloaded function.
1. lower(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. lower(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.Bound_std_string_t
- n(...) from builtins.PyCapsule
- n(*args, **kwargs)
Overloaded function.
1. n(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. n(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
3. n(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Fixed number of values required assignment
4. n(rosetta.utility.options.VectorOption) -> int
Fixed number of values required (zero if none)
- n_default_value(...) from builtins.PyCapsule
- n_default_value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
- n_lower(...) from builtins.PyCapsule
- n_lower(*args, **kwargs)
Overloaded function.
1. n_lower(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. n_lower(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
3. n_lower(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Lower number of values allowed assignment
4. n_lower(rosetta.utility.options.VectorOption) -> int
Lower number of values allowed (zero if none)
- n_upper(...) from builtins.PyCapsule
- n_upper(*args, **kwargs)
Overloaded function.
1. n_upper(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, n_a : int) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. n_upper(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
3. n_upper(self : rosetta.utility.options.VectorOption, n_a : int) -> rosetta.utility.options.VectorOption
Upper number of values allowed assignment
4. n_upper(rosetta.utility.options.VectorOption) -> int
Upper number of values allowed (zero if none)
- n_value(...) from builtins.PyCapsule
- n_value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
- name(...) from builtins.PyCapsule
- name(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- push_back(...) from builtins.PyCapsule
- push_back(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- raw_default_string(...) from builtins.PyCapsule
- raw_default_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- raw_value_string(...) from builtins.PyCapsule
- raw_value_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- set_cl_value(...) from builtins.PyCapsule
- set_cl_value(self : rosetta.utility.options.VectorOption, value_str : str) -> NoneType
Value assignemt from a command line string but without
a VectorOption & return type. This will separate arguments into
blocks grouped by quotes, and then separate the non-quote-delimited
arguments by whitespace
- short_description(...) from builtins.PyCapsule
- short_description(*args, **kwargs)
Overloaded function.
1. short_description(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
2. short_description(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, sd : str) -> NoneType
- shortd(...) from builtins.PyCapsule
- shortd(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, s : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- size(...) from builtins.PyCapsule
- size(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> int
- size_constraint_string(...) from builtins.PyCapsule
- size_constraint_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
- specified_check(...) from builtins.PyCapsule
- specified_check(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> NoneType
- specified_report(...) from builtins.PyCapsule
- specified_report(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- strict_lower(...) from builtins.PyCapsule
- strict_lower(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- strict_upper(...) from builtins.PyCapsule
- strict_upper(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
- to_default(...) from builtins.PyCapsule
- to_default(*args, **kwargs)
Overloaded function.
1. to_default(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. to_default(rosetta.utility.options.VectorOption) -> rosetta.utility.options.VectorOption
Set to default value, if any
- upper(...) from builtins.PyCapsule
- upper(*args, **kwargs)
Overloaded function.
1. upper(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. upper(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.Bound_std_string_t
- user(...) from builtins.PyCapsule
- user(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> bool
- user_or(...) from builtins.PyCapsule
- user_or(*args, **kwargs)
Overloaded function.
1. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.vector1_std_string
2. user_or(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int, value_a : str) -> str
- value(...) from builtins.PyCapsule
- value(*args, **kwargs)
Overloaded function.
1. value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : str) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
2. value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t
3. value(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> rosetta.utility.vector1_std_string
4. value(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int) -> str
- value_or(...) from builtins.PyCapsule
- value_or(*args, **kwargs)
Overloaded function.
1. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, value_a : rosetta.utility.vector1_std_string) -> rosetta.utility.vector1_std_string
2. value_or(self : rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t, i : int, value_a : str) -> str
- value_string(...) from builtins.PyCapsule
- value_string(rosetta.utility.options.VectorOption_T__utility_options_StringVectorOptionKey_std_string_t) -> str
Methods inherited from Option:
- been_accessed(...) from builtins.PyCapsule
- been_accessed(rosetta.utility.options.Option) -> NoneType
Set access property to true.
- check_restricted_access(...) from builtins.PyCapsule
- check_restricted_access(self : rosetta.utility.options.Option, do_check : bool) -> NoneType
- is_been_accessed(...) from builtins.PyCapsule
- is_been_accessed(rosetta.utility.options.Option) -> bool
Return true if option value was anyhow accessed.
- is_cl_value(...) from builtins.PyCapsule
- is_cl_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type and a legal command line value?
- is_group(...) from builtins.PyCapsule
- is_group(*args, **kwargs)
Overloaded function.
1. is_group(self : rosetta.utility.options.Option, value : bool) -> rosetta.utility.options.Option
2. is_group(rosetta.utility.options.Option) -> bool
Is this the synonymous option for an option group (e.g. -in:file:file)
- is_value(...) from builtins.PyCapsule
- is_value(self : rosetta.utility.options.Option, value_str : str) -> bool
Is a string readable as this option's value type?
- restrict_access(...) from builtins.PyCapsule
- restrict_access(self : rosetta.utility.options.Option, setting : bool) -> 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
- set_accessed(...) from builtins.PyCapsule
- set_accessed(self : rosetta.utility.options.Option, setting : bool) -> NoneType
- type_string(...) from builtins.PyCapsule
- type_string(rosetta.utility.options.Option) -> str
Option type code string representation
| |