Hermes DRS  6.0
reduction software
 All Classes Namespaces Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
hermes.pipeline.core.loggingfacility.LoggingFacility Class Reference

Defines a common log file structure for all programs. More...

Public Member Functions

def logPath
 
def logAndHistory
 
def logPrt
 log a string The handler send to the log file AND to the console. More...
 
def createLogWhenNeeded
 

Public Attributes

 logger
 When no name is given for the logger, no need to create a new one. More...
 

Detailed Description

Defines a common log file structure for all programs.

Logs in a file and on console.

PURPOSE:     Base Class for logging jobs.

            -    reads the DataOutput folder from the config files
            -    opens the log file

Member Function Documentation

def hermes.pipeline.core.loggingfacility.LoggingFacility.createLogWhenNeeded (   self,
  results 
)
PURPOSE: Initialize the standard File & Console Logger
def hermes.pipeline.core.loggingfacility.LoggingFacility.logAndHistory (   self,
  header,
  message,
  component = "component",
  level = "info" 
)
PURPOSE: write component name, date and time, message on specified level of log
adds the message to the header and to the log file
def hermes.pipeline.core.loggingfacility.LoggingFacility.logPrt (   self,
  severity,
  message 
)

log a string The handler send to the log file AND to the console.

self.logPrt ( "info", componentName, "shiftCases", shiftCases, anyOtherArgument, ... )

Member Data Documentation

hermes.pipeline.core.loggingfacility.LoggingFacility.logger

When no name is given for the logger, no need to create a new one.

This is the calling method for job parts. A stand-alone job should pass a name in order to initiate the logging system.


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