cli::builtin::Dot Class Reference

#include <Dot.h>

Static Public Member Functions
static void	dot (const std::string &data, bool runsInBackground)
static void	dot2 (const std::string &data)
static void	dot (const std::string &data, std::string outputType, const std::string &outputFile)

Static Protected Member Functions
static void	run (const std::string &data, const std::string &outputType, const std::optional< std::string > &outputFile, bool runInBackground)

Static Protected Attributes
static std::vector< std::string >	allowedOutputTypes { "dot", "xdot", "ps", "pdf", "svg", "svgz", "fig", "png", "gif", "jpg", "jpeg", "json", "imap", "cmapx" }

Detailed Description

Dot visualisation executioner.

Member Function Documentation

dot() [1/2]

void cli::builtin::Dot::dot ( const std::string &  data, bool  runsInBackground  )

static

Cli builtin command for DOT format visualization. Runs dot -Tx11.

Parameters

dot	a string containing dot data
runsInBackground	specify whether run in background and not block CLI input

Here is the call graph for this function:

Here is the caller graph for this function:

dot() [2/2]

void cli::builtin::Dot::dot ( const std::string &  data, std::string  outputType, const std::string &  outputFile  )

static

Cli builtin command for DOT format visualization. Runs dot -T<outputType> -o <outputFile> and blocks until done.

Parameters

data	a string containing dot data
outputType	the type of dot created image
outputFile	the destination file name

Here is the call graph for this function:

dot2()

void cli::builtin::Dot::dot2 ( const std::string &  data )

static

Cli builtin command for DOT format visualization. Runs dot -Tx11 and does not block.

Parameters

dot	a string containing dot data

Here is the call graph for this function:

run()

void cli::builtin::Dot::run ( const std::string &  data, const std::string &  outputType, const std::optional< std::string > &  outputFile, bool  runInBackground  )

staticprotected

Here is the caller graph for this function:

Field Documentation

allowedOutputTypes

std::vector< std::string > cli::builtin::Dot::allowedOutputTypes { "dot", "xdot", "ps", "pdf", "svg", "svgz", "fig", "png", "gif", "jpg", "jpeg", "json", "imap", "cmapx" }

staticprotected

Allowed output types

---

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

• alib2cli/src/builtin/Dot.h
• alib2cli/src/builtin/Dot.cpp