mflowgen
stable

Contents

  • Quick Start
  • Reference: Graph-Building API
    • Class Graph
    • Class Step
    • Class Edge
  • User Guide
  • Common Library Reference
  • Frequently Asked Questions
mflowgen
  • Reference: Graph-Building API
  • Edit on GitHub

Reference: Graph-Building API

mflowgen provides a Python library for building graphs in the construct.py for your design. In general, you will only use methods from the Graph and Step classes. The Edge class is used internally when you call the various methods that make connections between steps in your graph.

Contents:

  • Class Graph
    • Graph
    • ADK-related
    • Adding Steps
    • Connecting Steps Together
    • Parameter System
    • Advanced Graph-Building
  • Class Step
    • clone()
    • get_input_handle()
    • get_output_handle()
    • i()
    • o()
    • all_input_handles()
    • all_output_handles()
    • extend_inputs()
    • extend_outputs()
    • pre_extend_commands()
    • extend_outputs()
    • extend_preconditions()
    • extend_postconditions()
    • set_name()
    • get_name()
    • set_param()
    • get_param()
    • update_params()
    • params()
    • expand_params()
    • escape_dollars()
    • all_inputs()
    • all_outputs()
    • all_outputs_execute()
    • all_outputs_tagged()
    • all_outputs_untagged()
    • get_dir()
    • get_commands()
    • get_debug_commands()
    • dump_yaml()
    • set_sandbox()
    • get_sandbox()
  • Class Edge
    • get_src()
    • get_dst()
Previous Next

© Copyright 2020, Christopher Torng. Revision c9747a32.

Built with Sphinx using a theme provided by Read the Docs.