Package gromacs :: Package analysis :: Package plugins :: Module template_plugin :: Class TEMPLATEplugin
[hide private]
[frames] | no frames]

Class TEMPLATEplugin

source code

 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.

Nested Classes [hide private]
  worker_class
actual plugin :class:`gromacs.analysis.core.Worker` class (name with leading underscore)
Instance Methods [hide private]

Inherited from core.Plugin: __init__, register

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variables [hide private]

Inherited from core.Plugin: plugin_name, simulation, worker

Properties [hide private]

Inherited from object: __class__