#This file was created by <gug> Wed Mar 14 11:02:02 2001
#LyX 0.12 (C) 1995-1998 Matthias Ettrich and the LyX Team
\lyxformat 2.15
\textclass article
\begin_preamble
\def\D0{D\O}  \def\d0{D\O}
\def\mtl{{\tt\~\relax}}
\usepackage{a4}
\usepackage{makeidx}
\newcommand{\mynote}[1]{\begin{flushright}\vspace{-3.0cm}
{\small #1} \vspace{2.5cm} \end{flushright}}
\newcommand{\mytwonotes}[2]{\begin{flushright}\vspace{-3.0cm}
{\small #1 \ #2} \vspace{1.1cm} \end{flushright}}  
\makeindex
\end_preamble
\language default
\inputencoding default
\fontscheme default
\graphics default
\paperfontsize 12
\spacing single 
\papersize Default
\paperpackage a4
\use_geometry 0
\use_amsmath 0
\paperorientation portrait
\secnumdepth 5
\tocdepth 5
\paragraph_separation indent
\defskip medskip
\quotes_language english
\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle headings

\layout Title

DLSAM Implementation Document
\layout Author

Gerald Guglielmo
\begin_float footnote 
\layout Standard

gug@fnal.gov
\end_float 
,
\protected_separator 
Maarten Litmaath
\begin_float footnote 
\layout Standard

litmaath@fnal.gov
\end_float 
,
\protected_separator 
 
\newline 
Carmenita Moore
\begin_float footnote 
\layout Standard

carmenita@fnal.gov
\end_float 
,
\protected_separator 
 
\newline 

\newline 

\size small 
\emph on 
(FNAL CD/ODS/OSP)
\layout Date

Wed Mar 14 10:50:43 2001
\layout Standard
\align center 
Version 2.0
\layout Abstract

This is an automatically generated implementation document for the dlsam
 package.
\latex latex 

\backslash 
clearpage
\layout Standard


\begin_inset LatexCommand \tableofcontents

\end_inset 


\latex latex 

\backslash 
clearpage
\layout Standard

\layout Standard

\layout Section


\emph on 
bufferSetManager.py
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Class: bufferSetManager
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager}

\end_inset 


\layout Standard

  Manages the bufferSet information and resources and handles   disk resource
 management for dlsam.
\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.__init__
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for bufferSetManager Class.
 
\layout Description

Parameter: name ==  Name to give the thread
\layout Standard

\layout Description

Parameter: conf ==  Configuration containing dictionaries of parameters.
\layout Standard

\layout Description

Parameter: inQueue ==  Input work queue for processing external requests
\layout Standard

\layout Description

Parameter: outQueue ==  Output work queue for requests to external managers
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.dynamicDefaults
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!dynamicDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  can be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.staticDefaults
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!staticDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  cannot be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.setSamProcessID
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!setSamProcessID}

\end_inset 


\layout Standard

  Function for storing the SAM process ID for use in fixing the meta   data
 files.
\layout Description

Parameter: id ==  SAM process ID 
\layout Standard

\layout Description

Returns: None
\layout Standard

     
\layout Subsubsection


\emph on 
Class Method: bufferSetManager.stop
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!stop}

\end_inset 


\layout Standard

  Function for setting a flag which will stop the internal thread.
\layout Description

Returns: None
\layout Standard

     
\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.run
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!run}

\end_inset 


\layout Standard

  Main loop for the class which is started by calling the inherited   start()
 method.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.doNothing
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!doNothing}

\end_inset 


\layout Standard

  Function for doing nothing but a print at the moment.
\layout Description

Parameter: name ==  Name of method invoking call
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.initBufferSet
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!initBufferSet}

\end_inset 


\layout Standard

  Function for generating a new buffer set and adding it for management.
\layout Description

Parameter: location ==  Buffer location
\layout Standard

\layout Description

Parameter: idname ==  ID name for buffer set
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.addBufferSet
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!addBufferSet}

\end_inset 


\layout Standard

  Function for adding a buffer set to be managed.
 
\layout Description

Parameter: info ==  Instance of dlsamStates.bufferSet 
\layout Standard

\layout Description

Returns: 1 if idname is unique and bufferSet is added, else 0.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.insertBufferSet
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!insertBufferSet}

\end_inset 


\layout Standard

  Function for inserting an old buffer state for management during recovery
   stage of startup.
 Use initBufferSet for adding new buffer sets.
\layout Description

Parameter: info ==  Instance of dlsamStates.bufferSet 
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.poleForList
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!poleForList}

\end_inset 


\layout Standard

  Poles for responses for files associated with info in fileList.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.queueReadyFiles
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!queueReadyFiles}

\end_inset 


\layout Standard

Will request that files are queued if they are closed and ready and  move
 them to a Queued area.
 Will set Files Queued flag if on a later  call there are no more files
 to queue.
\layout Description

Parameter: buffSet ==  Buffer set 
\layout Standard

\layout Description

Returns: None on suscess
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.monitorBufferSpace
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!monitorBufferSpace}

\end_inset 


\layout Standard

  Monitors the buffer space available on a disk and returns  a value if
 files should be queued.
\layout Description

Parameter: buffSet ==  Buffer set 
\layout Standard

\layout Description

Returns: None on suscess
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.moveToDone
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!moveToDone}

\end_inset 


\layout Standard

  Actually moves raw data, metadata and catalog files to the Done area 
  from the Transfered area and call copy or delete request methods.
   Request that the raw data file name be tagged for deletion and   the
 meta and catalog be tagged for copy.
 The  location must be the buffer location not the Transfered subdir.
\layout Description

Parameter: name ==  Name of the raw file of the log set
\layout Standard

\layout Description

Parameter: location ==  Logging directory of the log set
\layout Standard

\layout Description

Parameter: mflag ==  Meta data store status flag 
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.deleteFileRequest
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!deleteFileRequest}

\end_inset 


\layout Standard

  Request that the raw data file name be tagged for deletion.
 The   location must be the buffer location not the Transfered subdir.
\layout Description

Parameter: name ==  Name of the raw file of the log set to be deleted
\layout Standard

\layout Description

Parameter: location ==  Logging directory of the log set to be deleted
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.copyFileRequest
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!copyFileRequest}

\end_inset 


\layout Standard

Request that a metadata or catalog files associated the raw file   be tagged
 for copy from the Done area to an Archive area.
 The   location must be the buffer location not the Done subdir.
\layout Description

Parameter: name ==  Name of file.
\layout Standard

\layout Description

Parameter: location ==  Logging directory of the log set
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.freeSpace
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!freeSpace}

\end_inset 


\layout Standard

  Requests that files be removed if in Done area.
 Delete raw files  move meta and catalog files.
\layout Description

Parameter: buffSet ==  Buffer set for which space will be freed
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.cleanBufferSet
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!cleanBufferSet}

\end_inset 


\layout Standard

  Checks to see if bufferSet is ready for deletion.
 Returns None if  ready.
 
\layout Description

Parameter: buffSet ==  Buffer set to check 
\layout Standard

\layout Description

Returns: None if ready for cleanup
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.numberFreeBuffers
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!numberFreeBuffers}

\end_inset 


\layout Standard

Returns number of buffers not marked HIGH, TIMEOUT for the   bufferSet (if
 FULL is set then HIGH is also set).
\layout Description

Parameter: buffSet ==  Buffer set 
\layout Standard

\layout Description

Returns: Number of buffers not marked FULL in the buffer set
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.deleteBufferSet
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!deleteBufferSet}

\end_inset 


\layout Standard

  Requests that the bufferSet buffSet be deleted.
 Assumes that   logic has already determined that this set is obsolete and
 ready  for cleanup.
 Also assumes caller has passed in a valid bufferSet to  delete.
\layout Description

Parameter: buffSet ==  Buffer set 
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.invalidWorkOrder
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!invalidWorkOrder}

\end_inset 


\layout Standard

  Dump information on invalid work order request.
\layout Description

Parameter: request ==  Invalid work order 
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.processWorkQueue
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!processWorkQueue}

\end_inset 


\layout Standard

  Process work orders on the input Queue.
  Currently supported actions     moveToDone     initBufferSet     insertBufferS
et     setSamProcessID     dropBufferSet     setRecoveryComplete     resetConf
     dynamicValue     flushTimeoutFile
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.editMetaFiles
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!editMetaFiles}

\end_inset 


\layout Standard

  Monitors the buffer areas for partial meta files and adds final  entries
 and renames files.
 Entries are sizeK, pid and run_id.
\layout Description

Parameter: buffSet ==  Buffer set 
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.checkQueueArea
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!checkQueueArea}

\end_inset 


\layout Standard

  Function for checking queue area for raw files, cleaning up .pyc   files
 and reseting files queued flag if raw files have been moved from  queued
 area.
\layout Description

Parameter: buffSet ==  Buffer set 
\layout Standard

\layout Description

Returns: None if no raw, meta or catalog files present
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.countRawFiles
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!countRawFiles}

\end_inset 


\layout Standard

  Counts number of raw data files at location and returns count.
  
\layout Description

Parameter: location ==  Location to check.
\layout Standard

\layout Description

Returns: Number of raw files found.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.updateRawCountFile
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!updateRawCountFile}

\end_inset 


\layout Standard

  Updates the count of raw files in the raw count file for the buffer.
  
\layout Description

Parameter: buffSet ==  Buffer set that buffer belongs to.
\layout Standard

\layout Description

Returns: Number of raw files.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.updateDiskLists
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!updateDiskLists}

\end_inset 


\layout Standard

Updates empty and partially empty disk/buffer file listings
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.sizeSortPairList
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!sizeSortPairList}

\end_inset 


\layout Standard

  Sorts by size returning pairs with largest integer value of first member
 of  pair first.
\layout Description

Parameter: pairList ==  List of pairs of size and another attribute.
\layout Standard

\layout Description

Returns: Sized sorted pairs.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.dropBufferSet
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!dropBufferSet}

\end_inset 


\layout Standard

  Requests that the bufferSet with id of idname be dropped (deleted) from
   the list of managed buffers.
 This is only for emergency situations or when  absolutely necessary.
 Operator will have to manually transfer files to SAM  and Enstore if a
 buffer is dropped while files still remain.
 Provided as a  means for removing a sick disk from the list without having
 to stop the  program.
 
\layout Description

Parameter: idname ==  IDName of the bufferSet to drop.
 
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.setRecoveryComplete
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!setRecoveryComplete}

\end_inset 


\layout Standard

  Sets recovery as complete so normal processing can begin.
\layout Description

Returns: None
\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.getRecoveryComplete
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!getRecoveryComplete}

\end_inset 


\layout Standard

  Sets recovery as complete so normal processing can begin.
\layout Description

Returns: 1 if recovery is complete, else 0.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.locationRecovery
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!locationRecovery}

\end_inset 


\layout Standard

  Recovers buffer set state for location and returns work ticket   for adding
 buffer set state for management
\layout Description

Parameter: mainName ==  Name of manager calling this method.
 
\layout Standard

\layout Description

Parameter: idname ==  IDName of the bufferSet.
 
\layout Standard

\layout Description

Parameter: location ==  Location.
 
\layout Standard

\layout Description

Parameter: dummyState ==  Template bufferSet state in file format.
\layout Standard

\layout Description

Returns: Ticket for initializing or inserting bufferSet state.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.buildArchivePath
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!buildArchivePath}

\end_inset 


\layout Standard

  Creates missing subdirectories if in archive path.
\layout Description

Parameter: path ==  Archive path.
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.archiveMdFile
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!archiveMdFile}

\end_inset 


\layout Standard

  Move md file to archive area and make a copy of the cat file.
\layout Description

Parameter: mdname ==  Absolute path for md file.
\layout Standard

\layout Description

Parameter: fname ==  File name of md file.
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.setConf
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!setConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.dynamicConf
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!dynamicConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  can
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.dynamicValue
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!dynamicValue}

\end_inset 


\layout Standard

  Set dynamic parameter via interface.
\layout Description

Parameter: name ==  name of dynamic parameter.
\layout Standard

\layout Description

Parameter: value ==  New value.
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.staticConf
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!staticConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  cannot
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.resetConf
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!resetConf}

\end_inset 


\layout Standard

  Set configuration based on original configuration read from file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.checkDiskTime
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!checkDiskTime}

\end_inset 


\layout Standard

  Function for checking disk to determine time out condition on logger 
 files.
\layout Description

Parameter: buffSet ==  Buffer set 
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.monitorTimeout
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!monitorTimeout}

\end_inset 


\layout Standard

  Function for monitoring disk to determine time out condition to determine
  if all log sets get completed (md files appear) before a secondary   timeout
 occurs and an alarm raised.
\layout Description

Parameter: buffSet ==  Buffer set 
\layout Standard

\layout Description

Returns: 1 if complete, 0 if awaiting complete, -1 if alarm.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.expireTimeout
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!expireTimeout}

\end_inset 


\layout Standard

  Checks to see if timeout can be expired and if so does it.
 
\layout Description

Parameter: buffSet ==  Buffer set to check 
\layout Standard

\layout Description

Returns: None if expired 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.getSpace
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!getSpace}

\end_inset 


\layout Standard

  Determines the buffer space available on a disk and returns  value if
 successful.
\layout Description

Parameter: location ==  Location to determine free space for
\layout Standard

\layout Description

Returns: Number of MBytes of space available at location, else -1
\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.updateMainDiskList
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!updateMainDiskList}

\end_inset 


\layout Standard

  Updates main disk/buffer file listing
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.checkTimeoutFile
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!checkTimeoutFile}

\end_inset 


\layout Standard

  Function for checking and for an entry in the timeout file.
\layout Description

Parameter: location ==  Location of files
\layout Standard

\layout Description

Parameter: mname ==  Meta file name to check for
\layout Description

Returns: 1 if found, else -1
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.updateTimeoutFile
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!updateTimeoutFile}

\end_inset 


\layout Standard

  Function for removing an entry from the timeout file.
\layout Description

Parameter: location ==  Location of files
\layout Standard

\layout Description

Parameter: mname ==  Meta file name to remove
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.updateStatistics
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!updateStatistics}

\end_inset 


\layout Standard

  Generates a string containing statistics info based on fileList.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.getStatistics
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!getStatistics}

\end_inset 


\layout Standard

  Returns a string containing statistics info.
\layout Description

Returns: Current statistics string.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.flushTimeoutFile
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!flushTimeoutFile}

\end_inset 


\layout Standard

Function for removing all file entries from the timeout file.
  This allows for incomplete log sets to be cleared out.
 Timeout  will proceed as if those entries were never in file so removal
 of  timeout flag file will not happen until all other conditions for  a
 normal timeout expiration are meet.
\layout Description

Parameter: location ==  Location of files
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSetManager.getName
\emph toggle 

\begin_inset LatexCommand \index{bufferSetManager.py!bufferSetManager!getName}

\end_inset 


\layout Standard

  Return name for the threaded manager.
\layout Description

Returns: Name
\layout Standard

\layout Standard

\layout Section


\emph on 
configure.py
\emph toggle 

\begin_inset LatexCommand \index{configure.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Lock Instance:  priRLock 
\emph toggle 

\begin_inset LatexCommand \index{configure.py!priRLock}

\end_inset 


\layout Standard

  A recursive blocking lock for use in configure module for  thread safety.
\layout Standard

\layout Subsection


\emph on 
Class: configure
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure}

\end_inset 


\layout Standard

  Allows for placing requests on a work queue in a consistent format
\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.__init__
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for configure Class.
 
\layout Description

Parameter: fileName ==  Name of configuration dictionary file.
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.setConfig
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!setConfig}

\end_inset 


\layout Standard

  Set or reset the name of the configuration file and import the   configuration
 dictionary if it exists.
 Otherwise leaves old   configuration and file in place.
 
\layout Description

Parameter: name ==  Name of the configuration file.
\layout Standard

\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.setParameters
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!setParameters}

\end_inset 


\layout Standard

  Set or reset the configuration parameters based on the configuration 
 dictionary.
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getHistoryParam
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getHistoryParam}

\end_inset 


\layout Standard

  Get configuration file history parameter by name based on the   configuration
 dictionary.
\layout Description

Parameter: name ==  Name configuration parameter to get value for.
\layout Standard

\layout Description

Returns: Value of configuration parameter if it exists, else None.
 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getMainParam
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getMainParam}

\end_inset 


\layout Standard

  Get main parameter by name based on the configuration  dictionary.
\layout Description

Parameter: name ==  Name configuration parameter to get value for.
\layout Standard

\layout Description

Returns: Value of configuration parameter if it exists, else None.
 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getBuffSetMgrParam
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getBuffSetMgrParam}

\end_inset 


\layout Standard

  Get buffer set manager parameter by name based on the configuration  dictionar
y.
\layout Description

Parameter: name ==  Name configuration parameter to get value for.
\layout Standard

\layout Description

Returns: Value of configuration parameter if it exists, else None.
 
\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getFileMgrParam
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getFileMgrParam}

\end_inset 


\layout Standard

  Get file manager parameter by name based on the configuration  dictionary.
\layout Description

Parameter: name ==  Name configuration parameter to get value for.
\layout Standard

\layout Description

Returns: Value of configuration parameter if it exists, else None.
 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getPnfsMgrParam
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getPnfsMgrParam}

\end_inset 


\layout Standard

  Get pnfs manager parameter by name based on the configuration  dictionary.
\layout Description

Parameter: name ==  Name configuration parameter to get value for.
\layout Standard

\layout Description

Returns: Value of configuration parameter if it exists, else None.
 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getSamCBMgrParam
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getSamCBMgrParam}

\end_inset 


\layout Standard

  Get SAM callback manager parameter by name based on the configuration
  dictionary.
\layout Description

Parameter: name ==  Name configuration parameter to get value for.
\layout Standard

\layout Description

Returns: Value of configuration parameter if it exists, else None.
 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getMainKeys
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getMainKeys}

\end_inset 


\layout Standard

  Get main parameter keys.
\layout Description

Returns: Keys from main dictionary.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getbufferSetMgrKeys
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getbufferSetMgrKeys}

\end_inset 


\layout Standard

  Get buffer set manager parameter keys.
\layout Description

Returns: Keys from buffer set manager dictionary.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getFileMgrKeys
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getFileMgrKeys}

\end_inset 


\layout Standard

  Get file manager parameter keys.
\layout Description

Returns: Keys from file manager dictionary.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getPnfsMgrKeys
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getPnfsMgrKeys}

\end_inset 


\layout Standard

  Get pnfs manager parameter keys.
\layout Description

Returns: Keys from pnfs manager dictionary.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: configure.getSamCBMgrKeys
\emph toggle 

\begin_inset LatexCommand \index{configure.py!configure!getSamCBMgrKeys}

\end_inset 


\layout Standard

  Get SAM callback manager parameter keys.
\layout Description

Returns: Keys from pnfs manager dictionary.
\layout Standard

\layout Standard

\layout Section


\emph on 
dlsamStates.py
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py}

\end_inset 


\layout Standard

\layout Subsection


\emph on 
Class: partition
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition}

\end_inset 


\layout Standard

  Class for tracking state of a partition file in dlsam.
\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.__init__
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for partition Class.
 
\layout Description

Parameter: info ==  Imported state dictionary object
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getStateDict
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getStateDict}

\end_inset 


\layout Standard

  Return the state dictionary object for the partition state.
\layout Description

Returns: State dictionary object if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getDataItem
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getDataItem}

\end_inset 


\layout Standard

  Return data from the data dictionary by keyName for the partition state.
\layout Description

Parameter: keyName ==  Key for data desired
\layout Standard

\layout Description

Returns: Value associated with key if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getHistItem
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getHistItem}

\end_inset 


\layout Standard

  Return data from the history dictionary by keyName for the partition 
 state.
\layout Description

Parameter: keyName ==  Key for data desired
\layout Standard

\layout Description

Returns: Returns value associated with key if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getFileName
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getFileName}

\end_inset 


\layout Standard

  Return the file name of the partition for the data dictionary.
\layout Description

Returns: File name
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getFileLocation
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getFileLocation}

\end_inset 


\layout Standard

  Return the file location of the partition for the data dictionary.
\layout Description

Returns: File location
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getFileDestination
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getFileDestination}

\end_inset 


\layout Standard

  Return the file destination in pnfs for the partition.
\layout Description

Returns: File destination if known, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getFileSize
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getFileSize}

\end_inset 


\layout Standard

  Return the file size of the partition for the data dictionary.
\layout Description

Returns: File size
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getRunNumber
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getRunNumber}

\end_inset 


\layout Standard

  Return the run number of the partition for the data dictionary.
\layout Description

Returns: Run number
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getPartitionNumber
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getPartitionNumber}

\end_inset 


\layout Standard

  Return the number of the partition for the data dictionary.
\layout Description

Returns: Partition number
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getRunYear
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getRunYear}

\end_inset 


\layout Standard

  Return the run year of the partition for the data dictionary.
\layout Description

Returns: Run year
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getRunMonth
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getRunMonth}

\end_inset 


\layout Standard

  Return the run month of the partition for the data dictionary.
\layout Description

Returns: Run month
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getStreamName
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getStreamName}

\end_inset 


\layout Standard

  Return the stream name of the partition for the data dictionary.
\layout Description

Returns: Stream name
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getRareCopy
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getRareCopy}

\end_inset 


\layout Standard

  Return the rare copy flag of the partition for the data dictionary.
\layout Description

Returns: Rare copy flag
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getCopyNum
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getCopyNum}

\end_inset 


\layout Standard

  Return the current copy number of the partition for the data dictionary.
\layout Description

Returns: Copy number currently in state.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getReadyTime
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getReadyTime}

\end_inset 


\layout Standard

  Return the init ready time of the partition for the history dictionary.
\layout Description

Returns: Date log set declared ready
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getNumberReady
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getNumberReady}

\end_inset 


\layout Standard

  Return the number of times ready of the partition for the history  dictionary.
\layout Description

Returns: Number of times log set declared ready
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getQueuedTime
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getQueuedTime}

\end_inset 


\layout Standard

  Return the init queued time of the partition for the history dictionary.
\layout Description

Returns: Date log set declared queued
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getInquiryResponse
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getInquiryResponse}

\end_inset 


\layout Standard

  Return the inquiry response object of the partition for the history  
 dictionary.
\layout Description

Returns: SAM database inquiry response 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getPnfsResponse
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getPnfsResponse}

\end_inset 


\layout Standard

  Return the pnfs response of the partition for the history dictionary.
\layout Description

Returns: Pnfs status 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getNumberQueued
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getNumberQueued}

\end_inset 


\layout Standard

  Return the number of times queued of the partition for the history   dictionar
y.
\layout Description

Returns: Number times declared queued
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getResubmit
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getResubmit}

\end_inset 


\layout Standard

  Return the resubmit flag of the partition for the history dictionary.
\layout Description

Returns: Resubmit flag
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getStateList
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getStateList}

\end_inset 


\layout Standard

  Return the list of states of the partition for the history dictionary.
\layout Description

Returns: Listing of states
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getDeleteStatus
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getDeleteStatus}

\end_inset 


\layout Standard

  Return the delete status of the partition for the history dictionary.
\layout Description

Returns: Delete status
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getCopyStatus
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getCopyStatus}

\end_inset 


\layout Standard

  Return the copy status of the partition for the history dictionary.
\layout Description

Returns: Copy status
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getDbCheck
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getDbCheck}

\end_inset 


\layout Standard

  Return the db check status of the partition for the history dictionary,
   a status reflecting success or failure, see inquiryResponse for SAM 
  response object.
\layout Description

Returns: SAM Db check status 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getCopyDeleteTime
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getCopyDeleteTime}

\end_inset 


\layout Standard

  Return the init copy delete time of the partition for the history   dictionary.
\layout Description

Returns: Date copy and delete requested
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getNumberCopyDelete
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getNumberCopyDelete}

\end_inset 


\layout Standard

  Return the number of times copy delete of the partition for the history
   dictionary.
\layout Description

Returns: Number of times copy or delete requested
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.getLastState
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!getLastState}

\end_inset 


\layout Standard

  Return the last state of the partition for the history dictionary.
\layout Description

Returns: Last state set
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setStateDict
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setStateDict}

\end_inset 


\layout Standard

  Reset the state dictionary.
\layout Description

Parameter: state ==  State to overwrite state dictionary with
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setFileName
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setFileName}

\end_inset 


\layout Standard

  Set the file name of the partition for the data dictionary.
\layout Description

Parameter: value ==  Name of raw file for log set
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setFileLocation
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setFileLocation}

\end_inset 


\layout Standard

  Set the file location of the partition for the data dictionary.
\layout Description

Parameter: value ==  Logging location of raw file for log set
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setFileDestination
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setFileDestination}

\end_inset 


\layout Standard

  Set the file destination for the partition for the data dictionary.
\layout Description

Parameter: value ==  Pnfs destination for the raw file
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setFileSize
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setFileSize}

\end_inset 


\layout Standard

  Set the file size of the partition for the data dictionary.
\layout Description

Parameter: value ==  Size of raw file for log set
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setRunNumber
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setRunNumber}

\end_inset 


\layout Standard

  Set the run number of the partition for the data dictionary.
\layout Description

Parameter: value ==  Run number
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setPartitionNumber
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setPartitionNumber}

\end_inset 


\layout Standard

  Set the number of the partition for the data dictionary.
\layout Description

Parameter: value ==  Partition number
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setRunYear
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setRunYear}

\end_inset 


\layout Standard

  Set the run year of the partition for the data dictionary.
\layout Description

Parameter: value ==  Run year
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setRunMonth
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setRunMonth}

\end_inset 


\layout Standard

  Set the run month of the partition for the data dictionary.
\layout Description

Parameter: value ==  Run month
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setStreamName
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setStreamName}

\end_inset 


\layout Standard

  Set the stream name of the partition for the data dictionary.
\layout Description

Parameter: value ==  Stream name
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setRareCopy
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setRareCopy}

\end_inset 


\layout Standard

  Set the rare copy flag of the partition for the data dictionary.
\layout Description

Parameter: value ==  Rare copy value
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setCopyNum
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setCopyNum}

\end_inset 


\layout Standard

  Set the current copy number of the partition for the data dictionary.
\layout Description

Parameter: value ==  Rare copy value
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setReadyTime
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setReadyTime}

\end_inset 


\layout Standard

  Set the init ready time of the partition for the history dictionary.
\layout Description

Parameter: value ==  Date declared ready
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setNumberReady
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setNumberReady}

\end_inset 


\layout Standard

  Set the number of times ready of the partition for the history   dictionary.
\layout Description

Parameter: value ==  Number of time declared ready
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setQueuedTime
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setQueuedTime}

\end_inset 


\layout Standard

  Set the init queued time of the partition for the history dictionary.
\layout Description

Parameter: value ==  Date declared queued
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setInquiryResponse
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setInquiryResponse}

\end_inset 


\layout Standard

  Set the inquiry response object of the partition for the history   dictionary.
\layout Description

Parameter: value ==  SAM database inquiry response object
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setPnfsResponse
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setPnfsResponse}

\end_inset 


\layout Standard

  Set the pnfs response of the partition for the history dictionary.
\layout Description

Parameter: value ==  Pnfs response
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setNumberQueued
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setNumberQueued}

\end_inset 


\layout Standard

  Set the number of times queued of the partition for the history   dictionary.
\layout Description

Parameter: value ==  Number times queued
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setResubmit
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setResubmit}

\end_inset 


\layout Standard

  Set the resubmit flag of the partition for the history dictionary.
\layout Description

Parameter: value ==  Resubmit value
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.addState
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!addState}

\end_inset 


\layout Standard

  Add state to the list of states of the partition for the history   dictionary.
\layout Description

Parameter: value ==  State to add
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setDeleteStatus
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setDeleteStatus}

\end_inset 


\layout Standard

  Set the delete status of the partition for the history dictionary.
\layout Description

Parameter: value ==  Delete status
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setCopyStatus
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setCopyStatus}

\end_inset 


\layout Standard

  Set the copy status of the partition for the history dictionary.
\layout Description

Parameter: value ==  Copy Status
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setDbCheck
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setDbCheck}

\end_inset 


\layout Standard

  Set the db check status of the partition for the history dictionary, 
 a status reflecting success or failure.
 See inquiryResponse for SAM   response object.
\layout Description

Parameter: value ==  SAM database response status 
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setCopyDeleteTime
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setCopyDeleteTime}

\end_inset 


\layout Standard

  Set the init copy delete time of the partition for the history   dictionary.
\layout Description

Parameter: value ==  Date copy or delete requested
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: partition.setNumberCopyDelete
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!partition!setNumberCopyDelete}

\end_inset 


\layout Standard

  Set the number of times copy delete of the partition for the history 
  dictionary.
\layout Description

Parameter: value ==  Number times copy or delete requested
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Class: bufferSet
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet}

\end_inset 


\layout Standard

  Class for tracking the state of a buffer set in dlsam.
\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.__init__
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for bufferSet Class.
 
\layout Description

Parameter: info ==  Imported state dictionary object
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getStateDict
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getStateDict}

\end_inset 


\layout Standard

  Return the state dictionary for a buffer set.
\layout Description

Returns: State dictionary object if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getBufferItem
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getBufferItem}

\end_inset 


\layout Standard

  Return data from a buffer dictionary by keyName for a buffer set.
\layout Description

Parameter: keyName ==  Key name for data desired
\layout Standard

\layout Description

Returns: Value associated with key if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getBufferLocation
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getBufferLocation}

\end_inset 


\layout Standard

  Return buffer location for specified buffer in the buffer set.
\layout Description

Returns: Buffer location 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getFilesQueuedFlag
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getFilesQueuedFlag}

\end_inset 


\layout Standard

  Return files are queued flag for specified buffer.
\layout Description

Returns: Buffer files queued flag 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getBufferFullFlag
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getBufferFullFlag}

\end_inset 


\layout Standard

  Return buffer is full flag for specified buffer.
\layout Description

Returns: Buffer full flag
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getBufferHighFlag
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getBufferHighFlag}

\end_inset 


\layout Standard

  Return buffer high on space used flag for specified buffer.
\layout Description

Returns: Buffer high on space used flag
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getBufferTimeoutFlag
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getBufferTimeoutFlag}

\end_inset 


\layout Standard

  Return buffer timeout for specified buffer.
\layout Description

Returns: Buffer timeout flag
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getObsoleteFlag
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getObsoleteFlag}

\end_inset 


\layout Standard

  Return obsolete flag for the bufferSet dictionary.
\layout Description

Returns: Obsolete flag if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getDeleteDict
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getDeleteDict}

\end_inset 


\layout Standard

  Return file delete status dictionary for the bufferSet dictionary.
\layout Description

Returns: Delete file dictionary if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getDeleteList
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getDeleteList}

\end_inset 


\layout Standard

  Return a list of files requested for deletion for the dictionary.
\layout Description

Returns: Listing of files to delete if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getDeleteStatus
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getDeleteStatus}

\end_inset 


\layout Standard

  Return delete status by file name for the bufferSet dictionary.
\layout Description

Parameter: name ==  Name of raw file for log set
\layout Standard

\layout Description

Returns: Delete status if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getCopyDict
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getCopyDict}

\end_inset 


\layout Standard

  Return file copy status dictionary for the dictionary.
\layout Description

Returns: Copy dictionary if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getCopyList
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getCopyList}

\end_inset 


\layout Standard

  Return a list of files requested for copy for the dictionary.
\layout Description

Returns: Listing of files to copy if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getCopyStatus
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getCopyStatus}

\end_inset 


\layout Standard

  Return copy status by file name for the bufferSet dictionary.
\layout Description

Parameter: name ==  Name of raw file for log set
\layout Standard

\layout Description

Returns: Run number if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getIDName
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getIDName}

\end_inset 


\layout Standard

  Return id name for the bufferSet dictionary.
\layout Description

Returns: ID name if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.getFreeSpace
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!getFreeSpace}

\end_inset 


\layout Standard

  Return free space for the buffer.
\layout Description

Returns: Buffer space available in MB
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setStateDict
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setStateDict}

\end_inset 


\layout Standard

  Reset the state dictionary for the bufferSet.
\layout Description

Parameter: state ==  State to overwrite state dictionary with
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setBufferItem
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setBufferItem}

\end_inset 


\layout Standard

  Set item by key name for the buffer.
 
\layout Description

Parameter: keyName ==  Key name for desired data
\layout Standard

\layout Description

Parameter: value ==  Value to set
\layout Standard

\layout Description

Returns: None.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setFilesQueuedFlag
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setFilesQueuedFlag}

\end_inset 


\layout Standard

  Set files are queued flag for the buffer.
\layout Description

Parameter: value ==  Value to set files queued flag to
\layout Standard

\layout Description

Returns: None if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setBufferFullFlag
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setBufferFullFlag}

\end_inset 


\layout Standard

  Set buffer is full flag for the buffer.
\layout Description

Parameter: value ==  Value to set buffer full flag to
\layout Standard

\layout Description

Returns: None if successful
\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setBufferHighFlag
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setBufferHighFlag}

\end_inset 


\layout Standard

  Set high on space used flag for the buffer.
\layout Description

Parameter: value ==  Value to set high space used flag to
\layout Standard

\layout Description

Returns: None if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setBufferTimeoutFlag
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setBufferTimeoutFlag}

\end_inset 


\layout Standard

  Set timeout flag for the buffer.
\layout Description

Parameter: value ==  Value to set timeout flag to
\layout Standard

\layout Description

Returns: None if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setObsoleteFlag
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setObsoleteFlag}

\end_inset 


\layout Standard

  Set obsolete flag for the bufferSet dictionary.
\layout Description

Parameter: value ==  Obsolete flag
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.addFileForDelete
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!addFileForDelete}

\end_inset 


\layout Standard

  Add a file to file delete status dictionary for the dictionary.
\layout Description

Parameter: name ==  Name of raw file for log set
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setDeleteStatus
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setDeleteStatus}

\end_inset 


\layout Standard

  Set the delete status by file name for the bufferSet dictionary.
\layout Description

Parameter: name ==  Name of raw file for log set
\layout Standard

\layout Description

Parameter: value ==  Delete status
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.addFileForCopy
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!addFileForCopy}

\end_inset 


\layout Standard

  Add a file to file copy status dictionary for the dictionary.
\layout Description

Parameter: name ==  Name of file
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setCopyStatus
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setCopyStatus}

\end_inset 


\layout Standard

  Set copy status by file name for the bufferSet dictionary.
\layout Description

Parameter: name ==  Name of raw file for log set
\layout Standard

\layout Description

Parameter: value ==  Copy status
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setFreeSpace
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setFreeSpace}

\end_inset 


\layout Standard

  Set free space in MB for the buffer.
\layout Description

Parameter: location ==  Buffer location 
\layout Standard

\layout Description

Parameter: value ==  Free space in MB
\layout Standard

\layout Description

Returns: None if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.setIDName
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!setIDName}

\end_inset 


\layout Standard

  Set id name for the bufferSet dictionary.
\layout Description

Parameter: value ==  ID name
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.removeFileForDelete
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!removeFileForDelete}

\end_inset 


\layout Standard

  Remove a file from the file delete status dictionary for the dictionary.
\layout Description

Parameter: name ==  Name of raw file for log set
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: bufferSet.removeFileForCopy
\emph toggle 

\begin_inset LatexCommand \index{dlsamStates.py!bufferSet!removeFileForCopy}

\end_inset 


\layout Standard

  Remove a file from the file copy status dictionary for the dictionary.
\layout Description

Parameter: name ==  Name of file
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Section


\emph on 
expertDlsam.py
\emph toggle 

\begin_inset LatexCommand \index{expertDlsam.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  msg_cb 
\emph toggle 

\begin_inset LatexCommand \index{expertDlsam.py!msg\_cb}

\end_inset 


\layout Standard

  Callback for handling ITC String Messages.
 Prints string  to standard output.
\layout Description

Parameter: msg ==  ITC String_Message  
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  parseArgs 
\emph toggle 

\begin_inset LatexCommand \index{expertDlsam.py!parseArgs}

\end_inset 


\layout Standard

  parses command line arguments and returns a dictionary.
\layout Description

Parameter: argc ==  Number of command line arguments
\layout Standard

\layout Description

Parameter: argv ==  List of command line arguments
\layout Standard

\layout Description

Returns: Dictionary of arguments.
\layout Standard

\layout Standard

\layout Section


\emph on 
fileManager.py
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Class: fileManager
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager}

\end_inset 


\layout Standard

  Manages the partition file information and resources and handles   requests
 to SAM concering file transfer and database updating for dlsam.
\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.__init__
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for fileManager Class.
 
\layout Description

Parameter: name ==  Name to give the thread
\layout Standard

\layout Description

Parameter: fileType ==  Possibly file type to manage
\layout Standard

\layout Description

Parameter: conf ==  Configuration containing dictionaries of parameters.
\layout Standard

\layout Description

Parameter: inQueue ==  Input work queue for processing external requests
\layout Standard

\layout Description

Parameter: outQueue ==  Output work queue for requests to external managers
  
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.dynamicDefaults
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!dynamicDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  can be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.staticDefaults
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!staticDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  cannot be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.stop
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!stop}

\end_inset 


\layout Standard

  Function for setting a flag which will stop the internal thread.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.run
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!run}

\end_inset 


\layout Standard

  Main loop for the class which is started by calling the inherited   start()
 method.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.doNothing
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!doNothing}

\end_inset 


\layout Standard

  Function for doing nothing but a print at the moment.
\layout Description

Parameter: name ==  Name of calling method 
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.reQueueFile
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!reQueueFile}

\end_inset 


\layout Standard

  Function for requeueing file that was previously marked as queued.
\layout Description

Parameter: name ==  Name of raw file for the log set
\layout Standard

\layout Description

Returns: None if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.reReadyFile
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!reReadyFile}

\end_inset 


\layout Standard

  Function for a marking file as ready that was previously marked as   queued.
\layout Description

Parameter: name ==  Name of raw file for log set
\layout Standard

\layout Description

Returns: None if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.queueFile
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!queueFile}

\end_inset 


\layout Standard

  Function for adding a file to be managed and marking it as Queued.
\layout Description

Parameter: name ==  Name of raw file for log set
\layout Standard

\layout Description

Parameter: location ==  Buffer location of logging area for log set
\layout Standard

\layout Description

Parameter: size ==  Size of raw file for log set
\layout Standard

\layout Description

Parameter: number ==  Run number 
\layout Standard

\layout Description

Parameter: part ==  Partition number
\layout Standard

\layout Description

Parameter: year ==  Run Year
\layout Standard

\layout Description

Parameter: month ==  Run month  
\layout Standard

\layout Description

Parameter: stream ==  Stream name for log set
\layout Standard

\layout Description

Parameter: itime ==  Date when file was signalled as ready to queue
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.addFile
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!addFile}

\end_inset 


\layout Standard

  Function for adding a file to be managed to the fileList.
 
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.getFailoverFlag
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!getFailoverFlag}

\end_inset 


\layout Standard

  Returns the fail over flag.
\layout Description

Returns: Fail over flag
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.setFailoverFlag
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!setFailoverFlag}

\end_inset 


\layout Standard

  Sets the fail over flag to 1.
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.clearFailoverFlag
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!clearFailoverFlag}

\end_inset 


\layout Standard

  Clears fail over flag to None.
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.removeFile
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!removeFile}

\end_inset 


\layout Standard

  Removes state information object from fileList and deletes the state 
 files associated with it..
\layout Description

Parameter: infoTarget ==  File state object to be removed.
 
\layout Standard

\layout Description

Returns: None if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.removeFileByName
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!removeFileByName}

\end_inset 


\layout Standard

  Removes state information for name from fileList and deletes the state
  files associated with it..
\layout Description

Parameter: name ==  Name of raw file for log set 
\layout Standard

\layout Description

Returns: None if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.requestStore
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!requestStore}

\end_inset 


\layout Standard

  Requests SAM to store the file associated with the state called info.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.requestResubmit
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!requestResubmit}

\end_inset 


\layout Standard

  Requests SAM to resubmit the store of the file associated with the   state
 called info.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.inquireDb
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!inquireDb}

\end_inset 


\layout Standard

  Requests SAM DB inquiry on file associated with the state called info.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.inquirePnfs
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!inquirePnfs}

\end_inset 


\layout Standard

  Requests pnfs inquiry on the file associated with the state called info.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.raiseAlarm
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!raiseAlarm}

\end_inset 


\layout Standard

  Requests that an alarm be sent to the Significant Event Server.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Parameter: alarm ==  Alarm to raise
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.opContinue
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!opContinue}

\end_inset 


\layout Standard

  Allows the operator to tell dlsam to continue despite alarm for file 
  name.
\layout Description

Parameter: name ==  Name of raw file for log set
\layout Standard

    @alarm Alarm that should be cleared for name
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.opDelete
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!opDelete}

\end_inset 


\layout Standard

  Allows operator to tell dlsam to delete file name.
\layout Description

Parameter: name ==  Name of raw file for log set which should be deleted
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.requestCopy
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!requestCopy}

\end_inset 


\layout Standard

  Requests copy of the file associated with the state called info.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.requestDelete
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!requestDelete}

\end_inset 


\layout Standard

  Requests delete of the file associated with the state called info.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.requestCleanup
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!requestCleanup}

\end_inset 


\layout Standard

  Requests cleanup of the file and state associated with the state   called
 info.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.markDone
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!markDone}

\end_inset 


\layout Standard

  Requests the file associated with the state called info be marked as 
  done.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.setRareCopy
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!setRareCopy}

\end_inset 


\layout Standard

  Requests state for file name be set for rare copy.
\layout Description

Parameter: name ==  Name of raw file for log set
\layout Standard

\layout Description

Parameter: value ==  Number of times stream should be transfered
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.poleForFile
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!poleForFile}

\end_inset 


\layout Standard

  Poles for responses for file associated with the state called info.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.poleForlist
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!poleForlist}

\end_inset 


\layout Standard

  Poles for responses for files associated with info in fileList.
\layout Description

Returns: None if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.failOverPoleForFile
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!failOverPoleForFile}

\end_inset 


\layout Standard

  Poles for responses for file associated with the state called info  in
 fail over mode.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None if successful
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.setCopied
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!setCopied}

\end_inset 


\layout Standard

  Sets the file as copied in the file copy status.
\layout Description

Parameter: name ==  Name of raw data file for logset
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.setDeleted
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!setDeleted}

\end_inset 


\layout Standard

  Sets the file as deleted in the file delete status.
\layout Description

Parameter: name ==  Name of raw data file for logset
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.processWorkQueue
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!processWorkQueue}

\end_inset 


\layout Standard

  Process work orders on the input Queue.
  Currently supported actions     queueFile     setCopied     setDeleted
     setRecoveryComplete     pnfsReply     callbackReceived     addFile
     resetConf     dynamicValue     samCBDynamicValue     pnfsDynamicValue
     opContinue
\layout Description

Returns: None 
\layout Standard

                                                                      
\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.setTransfered
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!setTransfered}

\end_inset 


\layout Standard

  Function for marking state as transfered and moving files from  Submitted
 to Transfered and request moveToDone.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.invalidWorkOrder
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!invalidWorkOrder}

\end_inset 


\layout Standard

  Dump information on invalid work order request.
\layout Description

Parameter: request ==  Invalid work order 
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.pnfsReply
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!pnfsReply}

\end_inset 


\layout Standard

  Sets the file pnfs check status.
\layout Description

Parameter: name ==  Name of raw data file for logset.
\layout Standard

\layout Description

Parameter: location ==  Location in pnfs searched for the file.
\layout Standard

\layout Description

Parameter: pnfsAnswer ==  Response from the check of pnfs for the file
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.setRecoveryComplete
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!setRecoveryComplete}

\end_inset 


\layout Standard

  Sets recovery as complete so normal processing can begin.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.getRecoveryComplete
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!getRecoveryComplete}

\end_inset 


\layout Standard

  Sets recovery as complete so normal processing can begin.
\layout Description

Returns: 1 if recovery is complete, else 0.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.buildFileTargetList
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!buildFileTargetList}

\end_inset 


\layout Standard

  Builds a list of sets of parameters for target files to be recovered 
  from a listing of locations where the data logger writes files.
   Each set contains a listing of parameters that describe the file in 
 the following order  run number, stream name, partition number.
\layout Description

Parameter: targetLocalList ==  List of target location trees to search.
\layout Standard

\layout Description

Parameter: dummyState ==   Template partition state in file format.
\layout Standard

\layout Description

Returns: Listing of sets of parameters for target files.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.fileTargetRecovery
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!fileTargetRecovery}

\end_inset 


\layout Standard

  Sets recovery as complete so normal processing can begin.
 The set  parameter contains a listing of parameters that describe the file
 in  the following order  run number, stream name, partition number.
\layout Description

Parameter: mainName ==  Name of manager calling this method.
 
\layout Standard

\layout Description

Parameter: set ==  Listing of parameters describing target file.
\layout Standard

\layout Description

Parameter: dummyState ==   Template partition state in file format.
\layout Standard

\layout Description

Returns: Work Order ticket if successful, else None.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.setConf
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!setConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.dynamicConf
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!dynamicConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  can
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.dynamicValue
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!dynamicValue}

\end_inset 


\layout Standard

  Set dynamic parameter via interface.
\layout Description

Parameter: name ==  name of dynamic parameter.
\layout Standard

\layout Description

Parameter: value ==  New value.
 
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.samCBDynamicValue
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!samCBDynamicValue}

\end_inset 


\layout Standard

  Set dynamic parameter via interface for underlying sam CB manager.
\layout Description

Parameter: name ==  name of dynamic parameter.
\layout Standard

\layout Description

Parameter: value ==  New value.
 
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.pnfsDynamicValue
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!pnfsDynamicValue}

\end_inset 


\layout Standard

  Set dynamic parameter via interface for underlying pnfs manager.
\layout Description

Parameter: name ==  name of dynamic parameter.
\layout Standard

\layout Description

Parameter: value ==  New value.
 
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.staticConf
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!staticConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  cannot
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.resetConf
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!resetConf}

\end_inset 


\layout Standard

  Set configuration based on original configuration read from file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.decodeStatus
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!decodeStatus}

\end_inset 


\layout Standard

  Decodes SAM string from status block to determine if acceptable, which
  at the moment means 'file not found'.
\layout Description

Parameter: status ==  Status string from SAM status block.
\layout Standard

\layout Description

Returns: None if file not found, else an integer value
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.callbackReceived
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!callbackReceived}

\end_inset 


\layout Standard

  Sets the database check flag for the file to the callback flag status.
\layout Description

Parameter: name ==  Name of raw data file for logset.
\layout Standard

\layout Description

Parameter: flag ==  Callback status flag
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.callbackOverdue
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!callbackOverdue}

\end_inset 


\layout Standard

  Sets the database check flag for the file to the callback flag status.
\layout Description

Parameter: info ==  File state object
\layout Standard

\layout Description

Returns: 1 if callback is overdue, else 0.
 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.updateStatistics
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!updateStatistics}

\end_inset 


\layout Standard

  Generates a string containing statistics info based on fileList.
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.getStatistics
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!getStatistics}

\end_inset 


\layout Standard

  Returns a string containing statistics info.
\layout Description

Returns: Current statistics string.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.getName
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!getName}

\end_inset 


\layout Standard

  Return name for the threaded manager.
\layout Description

Returns: Name
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.getManualDestination
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!getManualDestination}

\end_inset 


\layout Standard

  Return the manual destination for the specified copy.
\layout Description

Parameter: copyNum ==  Copy that the destination is for.
\layout Standard

\layout Description

Returns: Manual destination
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.getAutoDestination
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!getAutoDestination}

\end_inset 


\layout Standard

  Return the auto destination for the specified copy.
\layout Description

Parameter: newMeta ==  Absolute path to metadata file.
\layout Standard

\layout Description

Parameter: copyNum ==  Copy that the destination is for.
\layout Standard

\layout Description

Returns: Returns auto destination if successful, else None.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.requestRareCopy
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!requestRareCopy}

\end_inset 


\layout Standard

  Requests SAM to store another copy of the file associated with the   state
 called info.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: fileManager.storeFile
\emph toggle 

\begin_inset LatexCommand \index{fileManager.py!fileManager!storeFile}

\end_inset 


\layout Standard

  Perform the SAM method to store the file based on input parameters.
   This is the lower level code that calls the samStoreFileCB method and
  and performs other common tasks before and after the store call.
  Timeout, copy number, destination and user callback object will be  determined
 in the method.
\layout Description

Parameter: info ==  Instance of dlsamStates.partition.
\layout Standard

\layout Description

Parameter: newMeta ==  Absolute path to metadata file.
\layout Standard

\layout Description

Parameter: subArea ==  Location where raw file is stored.
\layout Standard

\layout Description

Parameter: resubmit ==  Resubmit flag.
\layout Standard

\layout Description

Returns: None if no exception is thrown else, -1.
\layout Standard

\layout Standard

\layout Section


\emph on 
mainDlsam.py
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Class: mainDlsam
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam}

\end_inset 


\layout Standard

  Main DLSAM class that will bring managers togther.
\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.__init__
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for mainDlsam Class.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.dynamicDefaults
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!dynamicDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  can be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.staticDefaults
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!staticDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  cannot be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.main
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!main}

\end_inset 


\layout Standard

  Main DLSAM block of code where all of the managers will be started and
  communication to outside applications will be interfaced.
\layout Description

Parameter: argc ==  Number of command line options
\layout Standard

\layout Description

Parameter: argv ==  Listing of command line options
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.setConf
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!setConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.confVersion
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!confVersion}

\end_inset 


\layout Standard

  Print configuration version information based on configuration file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.dynamicConf
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!dynamicConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  can
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.dynamicValue
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!dynamicValue}

\end_inset 


\layout Standard

  Set dynamic parameter via interface.
\layout Description

Parameter: name ==  name of dynamic parameter.
\layout Standard

\layout Description

Parameter: value ==  New value.
          
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.staticConf
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!staticConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  cannot
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.resetConf
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!resetConf}

\end_inset 


\layout Standard

  Set configuration based on original configuration read from file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.startRecovery
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!startRecovery}

\end_inset 


\layout Standard

  Start the process of recovering state information from previous running
   of application and bringing managers up to date.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.msg_cb
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!msg\_cb}

\end_inset 


\layout Standard

  Handle string messages from the Data State Manager.
\layout Description

Parameter: mess ==  String message received.
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.levelValue
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!levelValue}

\end_inset 


\layout Standard

  Returns numberic value for level string.
\layout Description

Parameter: level ==  Level string
\layout Standard

\layout Description

Returns: Numeric level value if valid, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.startLogging
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!startLogging}

\end_inset 


\layout Standard

  Start up logging for messages and alarms.
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.updateStatistics
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!updateStatistics}

\end_inset 


\layout Standard

  Generates a string containing statistics.
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.getStatistics
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!getStatistics}

\end_inset 


\layout Standard

  Returns a string containing statistics info.
\layout Description

Returns: Current statistics string.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.recv_request
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!recv\_request}

\end_inset 


\layout Standard

  Handle string messages for the server that should be requests for  overriding
 alarms or getting statistics.
\layout Description

Parameter: mess ==  String message received.
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.recv_conn_start
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!recv\_conn\_start}

\end_inset 


\layout Standard

  Receives connection start string message and logs it.
\layout Description

Parameter: conn ==  Connection start message.
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainDlsam.recv_conn_stop
\emph toggle 

\begin_inset LatexCommand \index{mainDlsam.py!mainDlsam!recv\_conn\_stop}

\end_inset 


\layout Standard

  Receives connection stop string message and logs it.
\layout Description

Parameter: conn ==  Connection stop message.
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Section


\emph on 
mstatic.py
\emph toggle 

\begin_inset LatexCommand \index{mstatic.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Instance:   report 
\emph toggle 

\begin_inset LatexCommand \index{mstatic.py!report}

\end_inset 


\layout Standard

  Holder for Report class instance
\layout Standard

\layout Section


\emph on 
pnfsManager.py
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Class: pnfsManager
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager}

\end_inset 


\layout Standard

  Manages the checking of files in pnfs so that other managers do not  have
 to worry about blocking on a pnfs check.
\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.__init__
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for pnfsManager Class.
 
\layout Description

Parameter: name ==  Name to give the thread
\layout Standard

\layout Description

Parameter: conf ==  Configuration containing dictionaries of parameters.
\layout Standard

\layout Description

Parameter: inQueue ==  Input work queue for processing external requests
\layout Standard

\layout Description

Parameter: outQueue ==  Output work queue for requests to external managers
  
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.dynamicDefaults
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!dynamicDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  can be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.staticDefaults
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!staticDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  cannot be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.stop
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!stop}

\end_inset 


\layout Standard

  Function for setting a flag which will stop the internal thread.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.run
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!run}

\end_inset 


\layout Standard

  Main loop for the class which is started by calling the inherited   start()
 method.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.doNothing
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!doNothing}

\end_inset 


\layout Standard

  Function for doing nothing but a print at the moment.
\layout Description

Parameter: name ==  Name of calling method 
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.getStatus
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!getStatus}

\end_inset 


\layout Standard

  Function for retrieving status dictionary 
\layout Description

Returns: Status dictionary
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.getBlockingLength
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!getBlockingLength}

\end_inset 


\layout Standard

  Calculates time state has been in blocking mode for a stat call if   currently
 blocking, otherwise specifies 0.
\layout Description

Returns: Time state has been blocking on a stat call.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.getStatusItem
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!getStatusItem}

\end_inset 


\layout Standard

  Function for retrieving value of item by key from status dictionary 
\layout Description

Parameter: keyName ==   Key name of item desired.
\layout Standard

\layout Description

Returns: Value of key if successful, else 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.setBlocking
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!setBlocking}

\end_inset 


\layout Standard

  Function sets the status as blocking on a stat call.
\layout Description

Parameter: name ==  Name of file in pnfs to check.
\layout Standard

\layout Description

Parameter: location ==  Path to file in pnfs.
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.setIdle
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!setIdle}

\end_inset 


\layout Standard

  Function sets the status as not blocking on a stat call
\layout Description

Parameter: name ==  Name of file in pnfs to check.
\layout Standard

\layout Description

Parameter: location ==  Path to file in pnfs.
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.checkFile
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!checkFile}

\end_inset 


\layout Standard

  Function for checking a file in pnfs using stat() and placing result in
  output queue.
\layout Description

Parameter: name ==  Name of file in pnfs to check.
\layout Standard

\layout Description

Parameter: location ==  Path to file in pnfs.
\layout Standard

\layout Description

Parameter: fsizeK ==  File size in KBytes
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.processWorkQueue
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!processWorkQueue}

\end_inset 


\layout Standard

  Process work orders on the input Queue.
  Currently supported actions     checkFile     resetConf;     dynamicValue
\layout Description

Returns: None 
\layout Standard

                                                                      
\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.invalidWorkOrder
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!invalidWorkOrder}

\end_inset 


\layout Standard

  Dump information on invalid work order request.
\layout Description

Parameter: request ==  Invalid work order 
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.setConf
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!setConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.dynamicConf
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!dynamicConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  can
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.dynamicValue
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!dynamicValue}

\end_inset 


\layout Standard

  Set dynamic parameter via interface.
\layout Description

Parameter: name ==  name of dynamic parameter.
\layout Standard

\layout Description

Parameter: value ==  New value.
  
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.staticConf
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!staticConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  cannot
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.resetConf
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!resetConf}

\end_inset 


\layout Standard

  Reset configuration based on original configuration read from file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: pnfsManager.getName
\emph toggle 

\begin_inset LatexCommand \index{pnfsManager.py!pnfsManager!getName}

\end_inset 


\layout Standard

  Return name for the threaded manager.
\layout Description

Returns: Name
\layout Standard

\layout Standard

\layout Section


\emph on 
samCBManager.py
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Class: samCBManager
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager}

\end_inset 


\layout Standard

  Listens for callbacks from the file storage server 
\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.__init__
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for samCBManager Class.
 
\layout Description

Parameter: name ==  Name to give the thread
\layout Standard

\layout Description

Parameter: conf ==  Configuration containing dictionaries of parameters.
\layout Standard

\layout Description

Parameter: inQueue ==  Input work queue for processing external requests
\layout Standard

\layout Description

Parameter: outQueue ==  Output work queue for requests to external managers
  
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.dynamicDefaults
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!dynamicDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  can be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.staticDefaults
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!staticDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  cannot be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.stop
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!stop}

\end_inset 


\layout Standard

  Function for setting a flag which will stop the internal thread.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.run
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!run}

\end_inset 


\layout Standard

  Main loop for the class which is started by calling the inherited   start()
 method.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.doNothing
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!doNothing}

\end_inset 


\layout Standard

  Function for doing nothing but a print at the moment.
\layout Description

Parameter: name ==  Name of calling method 
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.sockListen
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!sockListen}

\end_inset 


\layout Standard

  Listen for a callback or timeout on the socket and add request to output
  work queue if callback received.
\layout Description

Parameter: name ==  Name of calling method 
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.getSock
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!getSock}

\end_inset 


\layout Standard

  Return socket for the callback manager.
\layout Description

Returns: Socket
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.getUserCB
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!getUserCB}

\end_inset 


\layout Standard

  Return user callback object.
\layout Description

Returns: user callback object.
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.processWorkQueue
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!processWorkQueue}

\end_inset 


\layout Standard

  Process work orders on the input Queue.
  Currently supported actions     resetConf;     dynamicValue
\layout Description

Returns: None 
\layout Standard

                                                                      
\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.invalidWorkOrder
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!invalidWorkOrder}

\end_inset 


\layout Standard

  Dump information on invalid work order request.
\layout Description

Parameter: request ==  Invalid work order 
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.setConf
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!setConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.dynamicConf
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!dynamicConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  can
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.dynamicValue
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!dynamicValue}

\end_inset 


\layout Standard

  Set dynamic parameter via interface.
\layout Description

Parameter: name ==  name of dynamic parameter.
\layout Standard

\layout Description

Parameter: value ==  New value.
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.staticConf
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!staticConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  cannot
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.resetConf
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!resetConf}

\end_inset 


\layout Standard

  Reset configuration based on original configuration read from file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: samCBManager.getName
\emph toggle 

\begin_inset LatexCommand \index{samCBManager.py!samCBManager!getName}

\end_inset 


\layout Standard

  Return name for the threaded manager.
\layout Description

Returns: Name
\layout Standard

\layout Standard

\layout Section


\emph on 
simLogFiles.py
\emph toggle 

\begin_inset LatexCommand \index{simLogFiles.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  genLogSets 
\emph toggle 

\begin_inset LatexCommand \index{simLogFiles.py!genLogSets}

\end_inset 


\layout Standard

  Generate log sets based on input parameters.
 The log sets are generated  in the format expected by dlsam.
\layout Description

Parameter: streamName ==  Name of stream.
\layout Standard

\layout Description

Parameter: runNumber ==  Number of the run.
\layout Standard

\layout Description

Parameter: nfiles ==  Number of log sets.
\layout Standard

\layout Description

Parameter: nstart ==  Number of partition to start with.
\layout Standard

\layout Description

Parameter: configureFileName ==  Configuration file name.
\layout Standard

\layout Description

Parameter: rname ==  Raw file source name.
\layout Standard

\layout Description

Returns: None if successful, else -1.
 
\layout Standard

\layout Standard

\layout Section


\emph on 
stateUtil.py
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Lock Instance:  priRLock 
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!priRLock}

\end_inset 


\layout Standard

  A recursive blocking lock for use in stateUtil module for  thread safety.
\layout Standard

\layout Subsection


\emph on 
Class: stateUtil
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil}

\end_inset 


\layout Standard

  Allows saving and storing of dictionary based state information.
\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.__init__
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for bufferSetManager Class.
  
\layout Description

Parameter: topLevel ==   Top directory level for state tree  
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.makeSubDir
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!makeSubDir}

\end_inset 


\layout Standard

  Function for making a run number subdirectory.
\layout Description

Parameter: lpath ==  Path to directory where sub directory will reside
\layout Standard

\layout Description

Parameter: name ==  Name of sub directory
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.buildExportPath
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!buildExportPath}

\end_inset 


\layout Standard

  Build the export path string based on the type of state information to
  be saved.
    
\layout Description

Parameter: state ==  State object to build export path for
\layout Standard

\layout Description

Returns: Path
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.exportState
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!exportState}

\end_inset 


\layout Standard

  Export state to file system for requested state and save with file prefix
  of contained in name.
\layout Description

Parameter: name ==  Type of state to export (partition|bufferSet)
\layout Standard

\layout Description

Parameter: state ==  State object to export 
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.writeDict
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!writeDict}

\end_inset 


\layout Standard

  Write a dictionary object to a file using recursive calls for trees.
\layout Description

Parameter: fd ==  File descriptor for output file
\layout Standard

\layout Description

Parameter: state ==  State object to write
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.writeSequence
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!writeSequence}

\end_inset 


\layout Standard

  Write a sequence object (list,tuple) to a file using recursive calls for
   trees.
\layout Description

Parameter: fd ==  File descriptor for output file
\layout Standard

\layout Description

Parameter: state ==  State object to write
\layout Standard

\layout Description

Parameter: seqType ==  Type of python sequence object to write
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.importState
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!importState}

\end_inset 


\layout Standard

  Snagged from an online python documentation example for the imp module
   and modified.
 Import or reimport a python module.
 
\layout Description

Parameter: path ==  The absolute path to directory for state file.
\layout Standard

\layout Description

Parameter: modName ==  Type of state to import (partition|bufferSet) 
\layout Standard

\layout Description

Returns: Imported state object if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.createDiskAreas
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!createDiskAreas}

\end_inset 


\layout Standard

  Create dlsam disk state area directory tree.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.createYearTree
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!createYearTree}

\end_inset 


\layout Standard

  Create dlsam state year directory tree.
\layout Description

Parameter: firstYear ==  Start year to create tree for
\layout Standard

\layout Description

Parameter: lastYear ==  End year to create tree for
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.getTemplateState
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!getTemplateState}

\end_inset 


\layout Standard

  Get a template of type name for building a state object.
 
\layout Description

Parameter: location ==  Location of template state directory  
\layout Standard

\layout Description

Parameter: name ==  Type of template to import  
\layout Standard

\layout Description

Returns: Imported template state object if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.importMetaFile
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!importMetaFile}

\end_inset 


\layout Standard

  Import meta data file.
 
\layout Description

Parameter: path ==  Absolute path of directory where meta files is.
  
\layout Standard

\layout Description

Parameter: name ==  Type of metafile to import  
\layout Standard

\layout Description

Returns: Imported meta data file object if successful, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: stateUtil.getMetaValues
\emph toggle 

\begin_inset LatexCommand \index{stateUtil.py!stateUtil!getMetaValues}

\end_inset 


\layout Standard

  Get a select set of meta data from meta data file avoiding import.
 
\layout Description

Parameter: path ==  Absolute path of directory where meta files is.
  
\layout Standard

\layout Description

Parameter: name ==  Type of metafile to import  
\layout Standard

\layout Description

Returns: List of part_nr, stream, start_time
\layout Standard

\layout Standard

\layout Section


\emph on 
stopDlsam.py
\emph toggle 

\begin_inset LatexCommand \index{stopDlsam.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Class: mainStop
\emph toggle 

\begin_inset LatexCommand \index{stopDlsam.py!mainStop}

\end_inset 


\layout Standard

  Main class that will generate stop signal file.
\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainStop.__init__
\emph toggle 

\begin_inset LatexCommand \index{stopDlsam.py!mainStop!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for mainStop Class.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainStop.staticDefaults
\emph toggle 

\begin_inset LatexCommand \index{stopDlsam.py!mainStop!staticDefaults}

\end_inset 


\layout Standard

  Set configuration based on defaults for parameters that  cannot be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainStops.main
\emph toggle 

\begin_inset LatexCommand \index{stopDlsam.py!mainStops!main}

\end_inset 


\layout Standard

  Main Stop block of code 
\layout Description

Parameter: argc ==  Number of command line options
\layout Standard

\layout Description

Parameter: argv ==  Listing of command line options
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainStop.setConf
\emph toggle 

\begin_inset LatexCommand \index{stopDlsam.py!mainStop!setConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainStop.confVersion
\emph toggle 

\begin_inset LatexCommand \index{stopDlsam.py!mainStop!confVersion}

\end_inset 


\layout Standard

  Print configuration version information based on configuration file.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainStop.staticConf
\emph toggle 

\begin_inset LatexCommand \index{stopDlsam.py!mainStop!staticConf}

\end_inset 


\layout Standard

  Set configuration based on configuration file for parameters that  cannot
 be reset.
\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainStop.levelValue
\emph toggle 

\begin_inset LatexCommand \index{stopDlsam.py!mainStop!levelValue}

\end_inset 


\layout Standard

  Returns numberic value for level string.
\layout Description

Parameter: level ==  Level string
\layout Standard

\layout Description

Returns: Numeric level value if valid, else None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: mainStop.startLogging
\emph toggle 

\begin_inset LatexCommand \index{stopDlsam.py!mainStop!startLogging}

\end_inset 


\layout Standard

  Start up logging for messages and alarms.
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Section


\emph on 
tailor.py
\emph toggle 

\begin_inset LatexCommand \index{tailor.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Class: tailor
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor}

\end_inset 


\layout Standard

  Tailor environment on system to include needed directories based on  default
 configuration file dlsam.conf.
\layout Standard

\layout Subsubsection


\emph on 
Class Method: tailor.__init__
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for tailor Class.
\layout Description

Parameter: fileName ==  Name of configuration dictionary file.
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: tailor.info
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor!info}

\end_inset 


\layout Standard

  Prints configuration file information to standard output
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: tailor.version
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor!version}

\end_inset 


\layout Standard

  Prints configuration file version information to standard output
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: tailor.areas
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor!areas}

\end_inset 


\layout Standard

  Prints configuration file area information to standard output
\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: tailor.buildPath
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor!buildPath}

\end_inset 


\layout Standard

  Builds directory path for input directory name
\layout Description

Parameter: name ==  Name of directory 
\layout Standard

\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: tailor.createBuffer
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor!createBuffer}

\end_inset 


\layout Standard

  Builds directory tree for specified buffer.
\layout Description

Parameter: name ==  Name of buffer
\layout Standard

\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: tailor.buildState
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor!buildState}

\end_inset 


\layout Standard

  Builds state directory tree.
\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: tailor.buildArchive
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor!buildArchive}

\end_inset 


\layout Standard

  Builds archive and external directory.
\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: tailor.allBuffers
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor!allBuffers}

\end_inset 


\layout Standard

  Builds directory tree for all buffers in configuration file list.
\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: tailor.build
\emph toggle 

\begin_inset LatexCommand \index{tailor.py!tailor!build}

\end_inset 


\layout Standard

  Build full directory environment based on configuration file.
\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Section


\emph on 
testHarnessLogger.py
\emph toggle 

\begin_inset LatexCommand \index{testHarnessLogger.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  main 
\emph toggle 

\begin_inset LatexCommand \index{testHarnessLogger.py!main}

\end_inset 


\layout Standard

  The main code for the test harness logger.
\layout Description

Parameter: argc ==  Number of command line arguments
\layout Standard

\layout Description

Parameter: argv ==  Listing of command line arguments
\layout Standard

\layout Description

Returns: None
\layout Standard

\layout Standard

\layout Section


\emph on 
thSafeUtils.py
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Lock Instance:  priLock 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!priLock}

\end_inset 


\layout Standard

  A nonrecursive blocking lock for use in wrapping python methods for  thread
 safety.
\layout Standard

\layout Subsection


\emph on 
Global Method:  chdir 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!chdir}

\end_inset 


\layout Standard

  Changes working directory to path.
\layout Description

Parameter: path ==  Path to change working directory to
\layout Standard

\layout Description

Returns: None, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  getcwd 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!getcwd}

\end_inset 


\layout Standard

  Returns current working directory.
\layout Description

Returns: Current working directory if successful, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  listdir 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!listdir}

\end_inset 


\layout Standard

  Returns listing of files in directory path.
\layout Description

Parameter: path ==  Path of area to list contents of
\layout Standard

\layout Description

Returns: Listing of directory is successful, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  mkdir 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!mkdir}

\end_inset 


\layout Standard

  Creates a directory called path.
\layout Description

Parameter: path ==  Name of directory to create
\layout Standard

\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  remove 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!remove}

\end_inset 


\layout Standard

  Deletes file called path.
\layout Description

Parameter: path ==  Name of file to delete
\layout Standard

\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  rename 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!rename}

\end_inset 


\layout Standard

  Renames file from old to new.
\layout Description

Parameter: old ==  Name file was called
\layout Standard

\layout Description

Parameter: new ==  Name file will be called
\layout Standard

\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  mv 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!mv}

\end_inset 


\layout Standard

  Moves file from old to new and works across filesystems unlike rename.
  Possibly faster method for files under 1MB since it does not need to 
  use popen call because it reads in file in binary mode and writes it 
  back out.
 
\layout Description

Parameter: old ==  Name file was called
\layout Standard

\layout Description

Parameter: new ==  Name file will be called
\layout Standard

\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  cp 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!cp}

\end_inset 


\layout Standard

  Copies file from old to new and works across filesystems.
\layout Description

Parameter: old ==  Name file was called
\layout Standard

\layout Description

Parameter: new ==  Name file will be called
\layout Standard

\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  rmdir 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!rmdir}

\end_inset 


\layout Standard

  Deletes a directory called path.
\layout Description

Parameter: path ==  Name of directory to remove
\layout Standard

\layout Description

Returns: None if successful, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  statvfs 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!statvfs}

\end_inset 


\layout Standard

  Returns statvfs object for path.
\layout Description

Parameter: path ==  Name of directory
\layout Standard

\layout Description

Returns: List object from statvfs call if successful, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  stat 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!stat}

\end_inset 


\layout Standard

  Returns stat object for path.
\layout Description

Parameter: path ==  Name of file
\layout Standard

\layout Description

Returns: List object from stat call if successful, else -1
\layout Standard

\layout Standard

\layout Subsection


\emph on 
Global Method:  statLinux 
\emph toggle 

\begin_inset LatexCommand \index{thSafeUtils.py!statLinux}

\end_inset 


\layout Standard

  Returns free space under Linux in 1024 bytes for path.
\layout Description

Parameter: path ==  Name of directory
\layout Standard

\layout Description

Returns: Free space in 1024 bytes if successful, else -1
\layout Standard

\layout Standard

\layout Section


\emph on 
workOrder.py
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Class: workOrder
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py!workOrder}

\end_inset 


\layout Standard

  Allows for placing requests on a work queue in a consistent format
\layout Standard

\layout Subsubsection


\emph on 
Class Method: workOrder.__init__
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py!workOrder!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance for workOrder Class.
 
\layout Description

Parameter: requestor ==  Name of the requestor
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workOrder.setID
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py!workOrder!setID}

\end_inset 


\layout Standard

  Set the ID number for the request.
 This should be done by the work   queue when the request is added, with
 the ID returned to the requestor  when the job is added to the queue.
 The ID should be unique.
\layout Description

Parameter: id ==  Unique numberic id
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workOrder.setAction
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py!workOrder!setAction}

\end_inset 


\layout Standard

  Set the action that is being requested.
\layout Description

Parameter: action ==  Name of method to be invoked
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workOrder.addParam
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py!workOrder!addParam}

\end_inset 


\layout Standard

  Add a parameter to the list that will be passed to the action being  
 requested.
 This is done by parameter name and value, where the parameter  name is
 as listed in the header for the action method requested.
\layout Description

Parameter: name ==  Key name of parameter matching method definition line
\layout Standard

\layout Description

Parameter: value ==  Value of the parameter
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workOrder.getRequestor
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py!workOrder!getRequestor}

\end_inset 


\layout Standard

  Returns name of the requestor.
\layout Description

Returns: Name of requestor
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workOrder.getID
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py!workOrder!getID}

\end_inset 


\layout Standard

  Returns the ticket ID of the request.
\layout Description

Returns: ID of the request
\layout Standard

  
\layout Standard

\layout Subsubsection


\emph on 
Class Method: workOrder.getAction
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py!workOrder!getAction}

\end_inset 


\layout Standard

  Returns the name of the action requested.
\layout Description

Returns: Name of the requested method 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workOrder.getKeys
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py!workOrder!getKeys}

\end_inset 


\layout Standard

  Returns a listing of the parameter keys for the request.
\layout Description

Returns: List of parameter keys for the request
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workOrder.getParam
\emph toggle 

\begin_inset LatexCommand \index{workOrder.py!workOrder!getParam}

\end_inset 


\layout Standard

  Returns the value of the parameter name if it exists in the request.
\layout Description

Parameter: name ==  Key name of the parameter desired
\layout Standard

\layout Description

Returns: Value associated with the parameter of name
\layout Standard

\layout Standard

\layout Section


\emph on 
workQueue.py
\emph toggle 

\begin_inset LatexCommand \index{workQueue.py}

\end_inset 


\layout Standard

\layout Standard

\layout Subsection


\emph on 
Class: workQueue
\emph toggle 

\begin_inset LatexCommand \index{workQueue.py!workQueue}

\end_inset 


\layout Standard

  Work queue class for dlsam
\layout Standard

\layout Subsubsection


\emph on 
Class Method: workQueue.__init__
\emph toggle 

\begin_inset LatexCommand \index{workQueue.py!workQueue!\_\_init\_\_}

\end_inset 


\layout Standard

  Initialization of class instance of workQueue Class.
  
\layout Description

Parameter: name ==  Name of the queue
\layout Standard

\layout Description

Returns: None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workQueue.addRequest
\emph toggle 

\begin_inset LatexCommand \index{workQueue.py!workQueue!addRequest}

\end_inset 


\layout Standard

  Adds a request to the work queue, request should be an instance of  workOrder.
 Set id of workOrder and return id.
\layout Description

Parameter: request ==  Work order to add to the queue
\layout Standard

\layout Description

Returns: ID of work order
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workQueue.getDepth
\emph toggle 

\begin_inset LatexCommand \index{workQueue.py!workQueue!getDepth}

\end_inset 


\layout Standard

  Returns work queue depth.
\layout Description

Returns: Number of work orders in the queue 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workQueue.getRequest
\emph toggle 

\begin_inset LatexCommand \index{workQueue.py!workQueue!getRequest}

\end_inset 


\layout Standard

  Removes and returns a request from the queue if nonempty.
\layout Description

Returns: Oldest work order from queue if any, else None 
\layout Standard

\layout Standard

\layout Subsubsection


\emph on 
Class Method: workQueue.getName
\emph toggle 

\begin_inset LatexCommand \index{workQueue.py!workQueue!getName}

\end_inset 


\layout Standard

  Returns the name of the queue.
\layout Description

Returns: Name of the queue 
\layout Standard


\begin_inset LatexCommand \printindex

\end_inset 


\the_end
