Tulip  4.3.0
Better Visualization Through Research
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Groups Pages
tlp::LayoutAlgorithm Class Reference

#include <PropertyAlgorithm.h>

Inherits tlp::TemplateAlgorithm< tlp::LayoutProperty >.

Public Member Functions

virtual std::string category () const
 
- Public Member Functions inherited from tlp::TemplateAlgorithm< tlp::LayoutProperty >
 TemplateAlgorithm (const tlp::PluginContext *context)
 
- Public Member Functions inherited from tlp::PropertyAlgorithm
 PropertyAlgorithm (const tlp::PluginContext *context)
 
- Public Member Functions inherited from tlp::Algorithm
 Algorithm (const PluginContext *context)
 
virtual bool check (std::string &)
 
std::string icon () const
 
virtual bool run ()=0
 
- Public Member Functions inherited from tlp::Plugin
virtual std::string author () const =0
 
virtual std::string date () const =0
 
virtual std::string group () const =0
 
virtual int id () const
 
virtual std::string info () const =0
 
virtual std::string major () const
 
virtual std::string minor () const
 
virtual std::string name () const =0
 
virtual std::string programmingLanguage () const
 
virtual std::string release () const =0
 
virtual std::string tulipMajor () const
 
virtual std::string tulipMinor () const
 
virtual std::string tulipRelease () const =0
 
- Public Member Functions inherited from tlp::WithParameter
template<typename T >
void addInOutParameter (const std::string &name, const std::string &help=std::string(), const std::string &defaultValue=std::string(), bool isMandatory=true)
 
template<typename T >
void addInParameter (const std::string &name, const std::string &help, const std::string &defaultValue, bool isMandatory=true)
 
template<typename T >
void addOutParameter (const std::string &name, const std::string &help=std::string(), const std::string &defaultValue=std::string(), bool isMandatory=true)
 
template<typename T >
void addParameter (const std::string &name, const std::string &help=std::string(), const std::string &defaultValue=std::string(), bool isMandatory=true)
 
const
tlp::ParameterDescriptionList
getParameters () const
 
bool inputRequired () const
 
- Public Member Functions inherited from tlp::WithDependency
void addDependency (const char *name, const char *release)
 
const std::list< Dependency > & dependencies () const
 

Protected Member Functions

 LayoutAlgorithm (const tlp::PluginContext *)
 

Additional Inherited Members

- Public Attributes inherited from tlp::TemplateAlgorithm< tlp::LayoutProperty >
tlp::LayoutPropertyresult
 
- Protected Attributes inherited from tlp::WithParameter
ParameterDescriptionList parameters
 
- Protected Attributes inherited from tlp::WithDependency
std::list< Dependency_dependencies
 

Detailed Description

The layout algorithm takes a graph as input and output its results as a tlp::LayoutProperty.

Definition at line 102 of file PropertyAlgorithm.h.

Member Function Documentation

virtual std::string tlp::LayoutAlgorithm::category ( ) const
inlinevirtual

A string identifier for a plugin used for categorization purposes.

Returns
std::string the category of the plugin.

Reimplemented from tlp::PropertyAlgorithm.

Definition at line 107 of file PropertyAlgorithm.h.