Drake
Drake C++ Documentation
SystemBase::GraphvizFragment Struct Reference

Detailed Description

(Advanced) The return type of GetGraphvizFragment().

#include <drake/systems/framework/system_base.h>

Public Attributes

std::vector< std::string > input_ports
 The Graphviz IDs for this System's input ports, to be used for adding Graphviz edges. More...
 
std::vector< std::string > output_ports
 The Graphviz IDs for this System's output ports, to be used for adding Graphviz edges. More...
 
std::vector< std::string > fragments
 The Graphviz content for this System. More...
 

Member Data Documentation

◆ fragments

std::vector<std::string> fragments

The Graphviz content for this System.

The fragments must be a valid Graphviz figure when concatenated and then wrapped in a digraph { … } or subgraph { … } stanza. During concatenation, no extra newlines or any other kind of whitespace should be inserted. (This is a list of strings, rather than a single string, to avoid redundant string concatenation until the last moment when we return the final GetGraphvizString().)

◆ input_ports

std::vector<std::string> input_ports

The Graphviz IDs for this System's input ports, to be used for adding Graphviz edges.

The i'th element is the ID for get_input_port(i). For a typical LeafSystem these will look like "s123:u0", "s123:u1", … but for diagrams and other special cases they might vary.

◆ output_ports

std::vector<std::string> output_ports

The Graphviz IDs for this System's output ports, to be used for adding Graphviz edges.

The i'th element is the ID for get_output_port(i). For a typical LeafSystem these will look like "s123:y0", "s123:y1", … but for diagrams and other special cases they might vary.


The documentation for this struct was generated from the following file: