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

Detailed Description

(Advanced) The arguments to the protected method DoGetGraphvizFragment().

This struct typically is only used by subclasses of LeafSystem that need to customize their Graphviz representation. These parameters constitute a polite request; a user's System's implementation of DoGetGraphvizFragment() is not strictly required to honor any of these parameters, but generally should attempt to honor as many as possible.

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

Public Attributes

int max_depth {}
 As per GetGraphvizString(). More...
 
std::map< std::string, std::string > options
 As per GetGraphvizString(). More...
 
std::string node_id
 The Graphviz ID to use for this node. More...
 
std::vector< std::string > header_lines
 The header line(s) to use for this Graphviz node's table. More...
 

Member Data Documentation

◆ header_lines

std::vector<std::string> header_lines

The header line(s) to use for this Graphviz node's table.

The strings in header_lines should not contain newlines; those are added automatically, along with <BR/> breaks between lines.

◆ max_depth

int max_depth {}

◆ node_id

std::string node_id

The Graphviz ID to use for this node.

◆ options

std::map<std::string, std::string> options

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