| Trees | Indices | Help |
|
|---|
|
|
object --+
|
core.Plugin --+
|
TEMPLATEplugin
*TEMPLATE* plugin.
Describe the plugin in detail here. This is what the user will
see. Add citations etc.
# explicitly describe the call/init signature of the plugin here;
# note that *all* arguments are technically keyword arguments
# (this is a requirement of the API) but if there are required
# parameters feel free to write them without square brackets in
# the call signature as done for parameter_1 below.
#
# The name and simulation parameters are always present.
.. class:: TEMPLATEplugin(parameter_1[, kwparameter_2[, name[, simulation]]])
:Arguments:
*parameter_1*
required, otherwise the plugin won't be able to do anything
*kwparameter_2*
this optional parameter tunes the frobbnification
*name* : string
plugin name (used to access it)
*simulation* : instance
The :class:`gromacs.analysis.Simulation` instance that owns the plugin.
|
|||
|
worker_class actual plugin :class:`gromacs.analysis.core.Worker` class (name with leading underscore) |
|||
|
|||
|
Inherited from Inherited from |
|||
|
|||
|
Inherited from |
|||
|
|||
|
Inherited from |
|||
| Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Sat Jun 12 15:59:35 2010 | http://epydoc.sourceforge.net |