Graph Execution Control

An application that uses the Executor SDK to execute a Bifrost graph is called the "host".

The Workspace class is the entry point and the central component when you want to execute a Bifrost graph with the Executor SDK within a host application. The Workspace encapsulates some centralized operations in Bifrost, like loading Bifrost resources.

The Workspace object is associated to a Library object where the Bifrost types (basic Amino types, Bifrost's Math types and any other custom type extensions), as well as nodes and graphs resources are loaded.

The Workspace also manages the GraphContainers. Each GraphContainer object is associated with a specific Bifrost graph to be executed. A GraphContainer object allows to compile a graph to determine if it contains any error and if it can be executed, and it manages a Job to execute such graph.

Through the Job object, you can set all Bifrost graph's input values and execute the graph, then retrieve the resulting graph's output values.

Class Diagram