root/sodar/branches/scintec-branch/sodar/scintec/maindata.py

"""
Module to handle Scintec sodar .mnd files.
"""

__author__ = 'Chris Calloway'
__email__ = 'cbc@chriscalloway.org'
__copyright__ = 'Copyright 2009 UNC-CH Department of Marine Science'
__license__ = 'GPL2'

import os

class MainData(object):
    """
    Class to parse Scintec sodar .mnd files.
    
    Parse the format header:
    
    >>> main_data = MainData(_testSetUp('good','091117.mnd'))
    >>> main_data.format_header[0]
    'FORMAT-1'
    """
    
    def __init__(self, mnd):
        """
        Parse main daily Scintec sodar .mnd file.
        
        MainData(mnd) -> <MainData object>
        
        Where mnd is a str object containing the complete contents read from a
        Scintec .mnd daily sodar file including all line endings.
        """
        
        super(MainData, self).__init__()
        self.blocks = [block.strip()
                      for block in mnd.split('\n\n')
                      if block.strip()]
        self.format_header = [line.strip()
                              for line in self.blocks[0].split('\n')
                              if line.strip()]
        self.file_header = [line.strip()
                            for line in self.blocks[1].split('\n')
                            if line.strip()]
        self.profile_blocks = self.blocks[2:]
                            
def _testSetUp(mnd_dir,mnd_file):
    module_dir = os.path.abspath(os.path.dirname(__file__))
    package_dir = os.path.split(module_dir)[0]
    mnd_file = os.path.join(package_dir,'tests','data',mnd_dir,mnd_file)
    mnd = open(mnd_file).read()
    return mnd

def _test():
    import doctest
    doctest.testmod()

if __name__ == "__main__":
    _test()