ProtocolPath¶
-
class
openff.evaluator.workflow.utils.
ProtocolPath
(property_name='', *protocol_ids)[source]¶ Represents a pointer to the output of another protocol.
Methods
__init__
([property_name])Constructs a new ProtocolPath object.
append_uuid
(uuid)Appends a uuid to each of the protocol id’s in the path
copy
()Returns a copy of this path.
from_string
(existing_path_string)Pops and then returns the leading protocol id from the path.
prepend_protocol_id
(id_to_prepend)Prepend a new protocol id onto the front of the path.
replace_protocol
(old_id, new_id)Redirect the input to point at a new protocol.
Attributes
The full path referenced by this object.
is_global
The end protocol id of the path.
path_separator
The property name pointed to by the path.
property_separator
The ids of the protocols referenced by this object.
The full path referenced by this object excluding the property name.
The leading protocol id of the path.
-
property
protocol_ids
¶ The ids of the protocols referenced by this object.
- Type
tuple of str
-
property
protocol_path
¶ The full path referenced by this object excluding the property name.
- Type
-
prepend_protocol_id
(id_to_prepend)[source]¶ Prepend a new protocol id onto the front of the path.
- Parameters
id_to_prepend (str) – The protocol id to prepend to the path
-
pop_next_in_path
()[source]¶ Pops and then returns the leading protocol id from the path.
- Returns
The previously leading protocol id.
- Return type
-
append_uuid
(uuid)[source]¶ Appends a uuid to each of the protocol id’s in the path
- Parameters
uuid (str) – The uuid to append.
-
property