This base class describes plug-ins who only modify one property, e.g. selection.
More...
Public Member Functions |
| PropertyAlgorithm (const tlp::PropertyContext &context) |
| Builds a new plug-in that modifies a single property.
|
virtual | ~PropertyAlgorithm () |
virtual bool | run () |
| Runs the algorithm. It is a good practice to report progress through the PluginProgress, Even if your algorithm is very fast. Keep in mind that Tulip can handle very large graphs. The PluginProgress should also be used to report errors, if any.
|
virtual bool | check (std::string &errorMessage) |
| Checks whether the algorithm can ru on this Graph or not. If not, the reason why should be reported through the PluginProgress.
|
bool | preservePropertyUpdates (PropertyInterface *prop) |
const
tlp::ParameterDescriptionList & | getParameters () |
| Retrieves the parameters.
|
template<typename T > |
void | addInParameter (const char *str, const char *inHelp=0, const char *inDefValue=0, bool isMandatory=true) |
| Adds an IN parameter to the plug-in.
|
template<typename T > |
void | addOutParameter (const char *str, const char *inHelp=0, const char *inDefValue=0, bool isMandatory=true) |
| Adds an OUT parameter to the plug-in.
|
template<typename T > |
void | addInOutParameter (const char *str, const char *inHelp=0, const char *inDefValue=0, bool isMandatory=true) |
| Adds an INOUT parameter to the plug-in.
|
template<typename T > |
void | addParameter (const char *parameterName, const char *help=NULL, const char *defaultValue=NULL, bool isMandatory=true) |
| Adds an IN parameter to the plug-in (deprecated)
|
std::list< Dependency > | getDependencies () |
| Gets the list of Dependencies of this plug-in.
|
template<typename Ty > |
void | addDependency (const char *name, const char *release) |
| Adds a dependency upon another plug-in. The parameters should be null-terminated strings, or NULL.
|
This base class describes plug-ins who only modify one property, e.g. selection.