rhessystypes.py

"""@package rhessysweb.types

@brief Define types for common RHESSys objects

This software is provided free of charge under the New BSD License. Please see
the following license information:

Copyright (c) 2013, University of North Carolina at Chapel Hill
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the University of North Carolina at Chapel Hill nor 
      the names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


@author Brian Miles <brian_miles@unc.edu>

"""
from collections import namedtuple

FQPatchID = namedtuple('FQPatchID', ['patchID', 'zoneID', 'hillID'], verbose=False)
FQ_PATCH_ID_NUM_FIELDS = 3
def getFQPatchIDFromArray(values):
    """ @brief Build a fully qualified patch ID from an array
        @param values Array of strings representing: patch ID, zone ID, hillslope ID
        @return FQPatchID representing the fully qualified patch ID
    """
    assert( len(values) == FQ_PATCH_ID_NUM_FIELDS )
    return FQPatchID(patchID=int(values[0]), \
                          zoneID=int(values[1]), \
                          hillID=int(values[2]))

CoordinatePair = namedtuple('CoordinatePair', ['easting', 'northing'], verbose=False)
def getCoordinatePair(easting, northing):
    """ @brief Build coordinate pair casting input values to float before storing
        @param easting Easting (x) coordinate
        @param northing Northing (y) coordinate
        @return CoordinatePair
    """
    return CoordinatePair(easting=float(easting), northing=float(northing))