palmmeteo.plugins.Plugin(3)

NAME
palmmeteo.plugins.Plugin

SYNOPSIS

Inherits metaclass, and palmmeteo.plugins.PluginMeta.

Inherited by palmmeteo.plugins.HInterpPluginMixin, palmmeteo.plugins.ImportPluginMixin, palmmeteo.plugins.SetupPluginMixin, palmmeteo.plugins.VInterpPluginMixin, palmmeteo.plugins.WritePluginMixin, and palmmeteo_stdplugins.meteo.RequiresMeteoPluginMixin.

  Public Member Functions
def __init__ (self, *args, **kwargs)
def check_config (self, *args, **kwargs)

  Public Attributes
cfg
rt

Detailed Description

Base class for plugins
Expects to receive configuration object in cfg argument.

Constructor & Destructor Documentation

  def palmmeteo.plugins.Plugin.__init__ ( self, * args, ** kwargs)

Reimplemented in palmmeteo_stdplugins.meteo.RequiresMeteoPluginMixin.

Member Function Documentation

  def palmmeteo.plugins.Plugin.check_config ( self, * args, ** kwargs)

Validate plugin-related configuration.
Any plugin can optinally implement the check_config method for
validating configuration. It is not required, so the method is not
abstract. It has to be stateless, runtime data are not stored to disk.

Reimplemented in palmmeteo_stdplugins.aladin.AladinPlugin, palmmeteo_stdplugins.icon.IconPlugin, and palmmeteo_stdplugins.wrf.WRFPlugin.

Member Data Documentation

  palmmeteo.plugins.Plugin.cfg

  palmmeteo.plugins.Plugin.rt

Author

Generated automatically by Doxygen for PALM-meteo from the source code.