tlp::AlgorithmContext Class Reference

#include <PluginContext.h>

Inheritance diagram for tlp::AlgorithmContext:

Collaboration diagram for tlp::AlgorithmContext:

Public Member Functions
	AlgorithmContext (tlp::Graph *graph=nullptr, tlp::DataSet *dataSet=nullptr, tlp::PluginProgress *progress=nullptr)

Public Attributes
DataSet *	dataSet
Graph *	graph
PluginProgress *	pluginProgress

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 55 of file PluginContext.h.

Member Data Documentation

dataSet

DataSet* tlp::AlgorithmContext::dataSet

Input parameters set by the user when running the plugin.

See also

tlp::DataSet

tlp::WithDependency

Definition at line 67 of file PluginContext.h.

graph

Graph* tlp::AlgorithmContext::graph

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

Definition at line 60 of file PluginContext.h.

pluginProgress

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 74 of file PluginContext.h.