Class: Plugin

This class represents a data plugin in Kst. It can be instantiated to create a new instance of a plugin in the Kst data collection.

Inherits: DataObject

Collection class: PluginCollection

Constructors:

Plugin ( [module] )

Methods:

setInput ( index, input )
validate ( )

Properties:

Plugin ( [PluginModule module] )

PluginModule module - The plugin module to use for this plugin. [OPTIONAL]

Main constructor for the Plugin class. New plugins are typically invalid until various properties have been set.

void setInput ( number index, Object input )

number index - or name of the input argument to be set.
Object input - argument.

Sets the input argument at the specified index or name.

void validate ( )

Validates the plugin.

PluginModule module

The library or module that is used for data processing by this plugin object.

string lastError [Read-Only]

A string containing details of the last error that occurred while running the plugin.

boolean valid [Read-Only]

True if this plugin object is valid. If false, there is probably an invalid setting somewhere that needs to be corrected before it can be used. Some errors include invalid inputs or outputs, or an invalid or missing PluginModule.