=====================================
``grail.data.dhfilegenerator`` Module
=====================================

.. include:: ..\..\version.h

.. contents:: Table of Contents
   :backlinks: top

--------
Overview
--------

This module provides the ability to create and initialize a new interval file (file 11) and survey file (file 12)
and add them to an existing Project Control File.

--------
Examples
--------

.. Python::

	pcfpath = "C:/test10.dat"
	items=[]
        items.append(("CHALC", 0, 99, 1))  #name, min, max, precision
        items.append(("TCU", 0, 13, .001))
        items.append(("%MLT", 0, 100, .01))
        dhfilegenerator.addDHFiles(pcfpath, "test11.dat", "test12.dat", items)


---------
Functions
---------

:df:`addDHFiles(pcfPath, file11, file12, itemList, overwrite=0)`

   Adds a new interval and survey file to an existing Project Control File. A report file, "msg102.la", will
   be created in the project folder summarizing the results.

   Arguments:
      :a:`pcfPath` : string
         The absolute path to the PCF file.

      :a:`file11` : string
         The filename of the generated assay file (typically named after the PCF).

      :a:`file12` : string
         The filename of the generated survey file (typically named after the PCF).

      :a:`itemList` : list
         A list of tuples representing the interval items to be added to the file 11: (name, min, max, precision)

      :a:`overwrite` : integer
         If set to 1, any existing files with the same name will be overwritten. Otherwise, an IOError will be raised if the files already exist.