Tulip  5.1.0
Large graphs analysis and drawing
tlp::AlgorithmContext Class Reference

#include <PluginContext.h>

+ Inheritance diagram for tlp::AlgorithmContext:
+ Collaboration diagram for tlp::AlgorithmContext:

Public Member Functions

 AlgorithmContext (tlp::Graph *graph=NULL, tlp::DataSet *dataSet=NULL, tlp::PluginProgress *progress=NULL)
 

Public Attributes

DataSetdataSet
 
Graphgraph
 
PluginProgresspluginProgress
 

Detailed Description

Parameters structure for a tlp::Algorithm.

This class contains data required for a tlp::Algorithm to run. Each of its member is copied into a protected member at the object construction.

Definition at line 51 of file PluginContext.h.

Member Data Documentation

DataSet* tlp::AlgorithmContext::dataSet

Input parameters set by the user when running the plugin.

See also
tlp::DataSet
tlp::WithDependency

Definition at line 63 of file PluginContext.h.

Graph* tlp::AlgorithmContext::graph

The pointer to the tlp::Graph on which the algorithm will be run.

Definition at line 56 of file PluginContext.h.

PluginProgress* tlp::AlgorithmContext::pluginProgress

A progress handler to notify the user about the progress state of the algorithm when run.

See also
tlp::PluginProgress

Definition at line 69 of file PluginContext.h.