Skip to content

Commit

Permalink
Add input instruction to planning problem
Browse files Browse the repository at this point in the history
  • Loading branch information
Levi-Armstrong committed Sep 29, 2023
1 parent 1a19448 commit 5f650fb
Show file tree
Hide file tree
Showing 20 changed files with 1,457 additions and 1,082 deletions.
25 changes: 22 additions & 3 deletions tesseract_task_composer/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,22 @@ Yaml Config:
Task Composer Task Plugins
--------------------------

Task
^^^^

All tasks have the following config entries available.

.. code-block:: yaml
ErrorTask:
class: ErrorTaskFactory
config:
conditional: false
trigger_abort: true # default for task is false
inputs: [input_data]
outputs: [output_data]
Graph Task
^^^^^^^^^^

Expand Down Expand Up @@ -182,6 +198,8 @@ When using a perviously defined task it is referenced using `task:` instead of `

Also in most case the tasks inputs and sometimes the outputs must be renamed. This accomplished by leveraging the `input_remapping:` and `output_remapping:`.

Also you can indicate that it should abort if a terminal is reached by specifying the terminal index `abort_terminal:`. If set to anything less than zero it will set all terminal tasks trigger abort to `false`.

.. code-block:: yaml
UsePreviouslyDefinedTaskPipeline:
Expand All @@ -199,10 +217,11 @@ Also in most case the tasks inputs and sometimes the outputs must be renamed. Th
CartesianPipelineTask:
task: CartesianPipeline
config:
conditional: false
input_remapping:
conditional: false # Optional
abort_terminal: 0 # Optional
input_remapping: # Optional
input_data: output_data
output_remapping:
output_remapping: # Optional
output_data: output_data
edges:
- source: MinLengthTask
Expand Down
Loading

0 comments on commit 5f650fb

Please sign in to comment.