hermes.pipeline.core.pipelinejob.PipelineJob Class Reference

Defines a common structure for the components. More...

Inheritance diagram for hermes.pipeline.core.pipelinejob.PipelineJob:

Public Member Functions
def	readBlackListWhenNeeded
def	__call__
def	validateArguments

Detailed Description

Defines a common structure for the components.

PURPOSE:        Base Class for chain jobs.

    -       Load the blacklists.
    -       opens the hermes.log file in the reduced folder
    -       Provide global write routines

Member Function Documentation

def hermes.pipeline.core.pipelinejob.PipelineJob.__call__	(		self,
			resultDict,
			instrumentModel
	)

PURPOSE: make it callable (overrides the "()"). This function should be overloaded
        by the child class.

def hermes.pipeline.core.pipelinejob.PipelineJob.readBlackListWhenNeeded	(		self,
			results
	)

PURPOSE: Initialize the PipelineJob with a blacklist and a file-and-screen logger.

INPUT:   loggerFolder : string containing the name of the logger. Default is "hermes.log"
 blackList    : an already loaded blacklist. No need to load it twice !
 results      : a resultdict to efficiently point to the "Nights" folder, where the global blacklist should be.

OUTPUT : a Blacklist read from both global and personal reject files lists (or the one passed as input).
 a logger handler

def hermes.pipeline.core.pipelinejob.PipelineJob.validateArguments	(		self,
			optionDict
	)

PURPOSE: Check whether the given arguments are valid options. his function should be
        overloaded by the child class.

---

The documentation for this class was generated from the following file:

• pipeline/core/pipelinejob.py