EDNA Plugin: EDPlugin

Name:EDPlugin
Project:kernel
Path:kernel/src/EDPlugin.py
Author:Marie-Francoise Incardona, Olof Svensson, Jérôme Kieffer
Date:
Copyright:European Synchrotron Radiation Facility, Grenoble, France
License:LGPLv3+
Module doc:
Class doc:This is the EDNA plugin main class
An EDNA plugin class:
- is a configurable entity
- has a base name (<date>-<random number>-<base name>)
- handles input/output data (setter, getter, checker)
- has warning and error messages
- has a base and a working directory (both are configurable)
The working directory is the folder from which the plugin is launched
and should contain all associated files with the plugin execution (edna xml input/output, 3rd party output files)
The base directory is the parent directory of the working directory.
Example: the working directory of a control plugin is the base directory of the plugins that it invokes,
i.e. the plugins working directories has the control plugin working directory as parent.
- defines the method that generates an executive summary (user-related output summary) that sub-classes should implement