Goby3 3.7.0
2026.11.12
Loading...
Searching...
No Matches
goby::middleware::tool::interface::DiagramView Class Reference

What a diagram draws of a resolved deployment, shared by the DOT and D2 writers. More...

#include <goby/middleware/tool/interface/resolve.h>

Public Member Functions

 DiagramView (const Deployment &deployment, const Resolution &resolution, ViewFilter filter, bool omit_disconnected)
 
const ViewFilter & filter () const
 
bool collapsed (const Application &app) const
 
bool folded (const Application &app) const
 
std::string container_label (const std::string &name, const Module &module) const
 The container's name, with any gobyd folded into it.
 
bool drawn (const Connection &c) const
 
bool drawn_unsubscribed (const Unmatched &u) const
 
bool drawn_unpublished (const Unmatched &u) const
 An unmet required subscription is drawn even when the rest are left out.
 
bool thread_drawn (const Application &app, const Thread &thread) const
 Goby's own threads within a project's application (such as its portal's forwarder) are drawn only when something is drawn to them.
 

Detailed Description

What a diagram draws of a resolved deployment, shared by the DOT and D2 writers.

Definition at line 307 of file resolve.h.

Constructor & Destructor Documentation

◆ DiagramView()

goby::middleware::tool::interface::DiagramView::DiagramView ( const Deployment &  deployment,
const Resolution &  resolution,
ViewFilter  filter,
bool  omit_disconnected 
)
inline

Definition at line 310 of file resolve.h.

Member Function Documentation

◆ collapsed()

bool goby::middleware::tool::interface::DiagramView::collapsed ( const Application &  app) const
inline

Definition at line 364 of file resolve.h.

◆ container_label()

std::string goby::middleware::tool::interface::DiagramView::container_label ( const std::string &  name,
const Module &  module 
) const
inline

The container's name, with any gobyd folded into it.

Definition at line 372 of file resolve.h.

◆ drawn()

bool goby::middleware::tool::interface::DiagramView::drawn ( const Connection &  c) const
inline

Definition at line 382 of file resolve.h.

◆ drawn_unpublished()

bool goby::middleware::tool::interface::DiagramView::drawn_unpublished ( const Unmatched &  u) const
inline

An unmet required subscription is drawn even when the rest are left out.

Definition at line 396 of file resolve.h.

◆ drawn_unsubscribed()

bool goby::middleware::tool::interface::DiagramView::drawn_unsubscribed ( const Unmatched &  u) const
inline

Definition at line 389 of file resolve.h.

◆ filter()

const ViewFilter & goby::middleware::tool::interface::DiagramView::filter ( ) const
inline

Definition at line 362 of file resolve.h.

◆ folded()

bool goby::middleware::tool::interface::DiagramView::folded ( const Application &  app) const
inline

Definition at line 369 of file resolve.h.

◆ thread_drawn()

bool goby::middleware::tool::interface::DiagramView::thread_drawn ( const Application &  app,
const Thread &  thread 
) const
inline

Goby's own threads within a project's application (such as its portal's forwarder) are drawn only when something is drawn to them.

Definition at line 409 of file resolve.h.


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