aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
gum::dot::CausalDotStyle Struct Reference

The style of a causal model (section causal): nodeBgColor and nodeFgColor are the ones of the observed variables. More...

#include <dotStyle.h>

Inheritance diagram for gum::dot::CausalDotStyle:
[legend]
Collaboration diagram for gum::dot::CausalDotStyle:
[legend]

Static Public Member Functions

static CausalDotStyle read ()
static DotStyle readCredalNet ()
 the style of the credal networks : the colors of the nodes are the ones of the section credalnet

Public Attributes

std::string latentBgColor
std::string latentFgColor
bool showLatentNames {false}
 show the names of the latent variables
std::string size
 graphviz size of the graph, in inches (5, or 12! for an exact size)
std::string rankDir
 direction of the layout : TB (top-bottom) or LR (left-right)
std::string layout
 graphviz layout engine (dot, neato...)
std::string arcColor
 color of the arcs and edges, and of the border of the nodes
std::string nodeBgColor
 background color of the nodes
std::string nodeFgColor
 font color of the nodes

Detailed Description

The style of a causal model (section causal): nodeBgColor and nodeFgColor are the ones of the observed variables.

Definition at line 153 of file dotStyle.h.

Member Function Documentation

◆ read()

CausalDotStyle gum::dot::CausalDotStyle::read ( )
static

Definition at line 155 of file dotStyle.cpp.

155 {
156 CausalDotStyle style;
157 static_cast< DotStyle& >(style) = _notebook_();
158 style.size = _str_("causal", "graphSize");
159 style.nodeBgColor = _str_("causal", "nodeBgColor");
160 style.nodeFgColor = configFgColor("causal", "nodeFgColor");
161
162 style.latentBgColor = _str_("causal", "latentBgColor");
163 style.latentFgColor = configFgColor("causal", "latentFgColor");
164 style.showLatentNames = _typed_< bool >("causal", "showLatentNames");
165 return style;
166 }
std::string configFgColor(std::string_view section, std::string_view key)
A font color of the configuration, resolved against the background color which goes with it.
Definition dotStyle.cpp:78

References gum::dot::configFgColor(), latentBgColor, latentFgColor, gum::dot::DotStyle::nodeBgColor, gum::dot::DotStyle::nodeFgColor, showLatentNames, and gum::dot::DotStyle::size.

Referenced by gum::CausalModel< GUM_SCALAR >::toDot(), and gum::CausalModel< GUM_SCALAR >::toDot().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readCredalNet()

DotStyle gum::dot::DotStyle::readCredalNet ( )
staticinherited

the style of the credal networks : the colors of the nodes are the ones of the section credalnet

Definition at line 91 of file dotStyle.cpp.

91 {
92 DotStyle style = _notebook_();
93 style.nodeBgColor = _str_("credalnet", "nodeBgColor");
94 style.nodeFgColor = configFgColor("credalnet", "nodeFgColor");
95 return style;
96 }

References gum::dot::configFgColor(), nodeBgColor, and nodeFgColor.

Referenced by gum::credal::CredalNet< GUM_SCALAR >::toDot().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ arcColor

std::string gum::dot::DotStyle::arcColor
inherited

color of the arcs and edges, and of the border of the nodes

Definition at line 84 of file dotStyle.h.

Referenced by gum::CausalModel< GUM_SCALAR >::_toDot_(), gum::dot::nodeAttributes(), gum::dot::FactorGraphDotStyle::read(), and gum::dot::writePreamble().

◆ latentBgColor

std::string gum::dot::CausalDotStyle::latentBgColor

Definition at line 154 of file dotStyle.h.

Referenced by gum::CausalModel< GUM_SCALAR >::_toDot_(), and read().

◆ latentFgColor

std::string gum::dot::CausalDotStyle::latentFgColor

Definition at line 155 of file dotStyle.h.

Referenced by gum::CausalModel< GUM_SCALAR >::_toDot_(), and read().

◆ layout

std::string gum::dot::DotStyle::layout
inherited

graphviz layout engine (dot, neato...)

Definition at line 82 of file dotStyle.h.

Referenced by gum::dot::FactorGraphDotStyle::read(), and gum::dot::writePreamble().

◆ nodeBgColor

◆ nodeFgColor

std::string gum::dot::DotStyle::nodeFgColor
inherited

font color of the nodes

Definition at line 88 of file dotStyle.h.

Referenced by gum::dot::CausalDotStyle::read(), gum::dot::FactorGraphDotStyle::read(), readCredalNet(), and gum::dot::writePreamble().

◆ rankDir

std::string gum::dot::DotStyle::rankDir
inherited

direction of the layout : TB (top-bottom) or LR (left-right)

Definition at line 80 of file dotStyle.h.

Referenced by gum::dot::writePreamble().

◆ showLatentNames

bool gum::dot::CausalDotStyle::showLatentNames {false}

show the names of the latent variables

Definition at line 157 of file dotStyle.h.

Referenced by gum::CausalModel< GUM_SCALAR >::_toDot_(), and read().

◆ size

std::string gum::dot::DotStyle::size
inherited

graphviz size of the graph, in inches (5, or 12! for an exact size)

Definition at line 78 of file dotStyle.h.

Referenced by gum::dot::CausalDotStyle::read(), gum::dot::DynamicBNDotStyle::read(), gum::dot::InfluenceDiagramDotStyle::read(), gum::dot::JunctionTreeDotStyle::read(), and gum::dot::writePreamble().


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