Holds all the data about a plugin (either analysis or output).
Purpose: Holds the data collected about a Plugin, which can be
either an Analysis or Output Plugin.
Used By: AnalysisPlugins,
OutputPlugins
Uses: None
Attributes: None
SRS Refs: 3.2.1.8, 4.3.3.2, 4.3.3.3, 5.2.3
Author: caedwa
Date: 27/7/02
|
Methods
|
|
__init__
canDisableItems
getId
getName
getType
isSelected
run
setSelected
|
|
|
__init__
|
__init__ (
self,
name="No Name",
callback=None,
ptype=None,
id=None,
)
Purpose: Creates a new instance of the Plugin class, given
its name to be displayed (default to "No Name"), its
callback function, type and id (all default to
None). Used by: AnalysisPlugins, OutputPlugins
Uses: None
Input: name : string,
callback : function/method,
ptype : integer,
id : integer
Output: None
Preconditions: None
Postconditions: None
SRS Refs: 4.3.3.2, 4.3.3.3
Author: caedwa
Date: 27/7/02
|
Exceptions
|
|
CustomError, "Error in input to Plugin: integer needed"
CustomError, "Error in input to Plugin: string needed"
|
|
|
|
canDisableItems
|
canDisableItems ( self )
Purpose: Needed by Selector class to tell it if this class
can cause other items to be disabled.
Returns 0 always, since all output and analysis
plugins are applicable to all data and stream types.
This is an interface needed
by Selector. Used by: Selector
Uses: None
Input: None
Output: canDisableItems : 0 or 1
Preconditions: None
Postconditions: None
SRS Refs: None
Author: caedwa
Date: 27/7/02
|
|
|
getId
|
getId ( self )
Purpose: Returns the plugin's id number
Used by: Selector
Uses: None
Input: None
Output: getId : integer or None
Preconditions: None
Postconditions: None
SRS Refs: 3.2.1.8, 4.3.3.2, 4.3.3.3
Author: caedwa
Date: 27/7/02
|
|
|
getName
|
getName ( self )
Purpose: Returns the name of the plugin to be displayed to
the user in an understandable form. Used by: Selector
Uses: None
Input: None
Output: getName : string
Preconditions: None
Postconditions: None
SRS Refs: 3.2.1.8, 4.3.3.2, 4.3.3.3
Author: caedwa
Date: 27/7/02
|
|
|
getType
|
getType ( self )
Purpose: Returns an integer corresponding to the
type of plugin. Used by: None
Uses: None
Input: None
Output: getType : integer
Preconditions: None
Postconditions: None
SRS Refs: 3.2.1.8, 4.3.3.2, 4.3.3.3
Author: caedwa
Date: 27/7/02
|
|
|
isSelected
|
isSelected ( self )
Purpose: Returns whether the plugin is selected (1) or not
selected (0) on screen.
This is an interface needed by Selector. Used by: Selector
Uses: None
Input: None
Output: isSelected : integer (0 or 1)
Preconditions: None
Postconditions: None
SRS Refs: 5.2.3
Author: mayadm
Date: 28/10/02
|
|
|
run
|
run ( self, table )
Purpose: Runs the plugin on the data contained in
Table. Used by: AnalysisPlugins, OutputPlugins
Uses: None
Input: table : Table
Output: run : Table or None
Preconditions: None
Postconditions: None
SRS Refs: 3.2.1.8, 4.3.3.2, 4.3.3.3
Author: caedwa
Date: 27/7/02
|
|
|
setSelected
|
setSelected ( self, sel )
Purpose: Returns whether the plugin is selected (1) or not
selected (0) on screen.
This is an interface needed by Selector. Used by: Selector
Uses: None
Input: None
Output: isSelected : integer (0 or 1)
Preconditions: None
Postconditions: None
SRS Refs: 5.2.3
Author: mayadm
Date: 28/10/02
|
|