###############################################################################
### FILE:	survey.mod
### PURPOSE:	Define a MACRo leaf to survey location
### SCOPE:	Top Level
###
### Copyrights (C) 2010-2011 Life Technologies.  All rights reserved.
################################################################################

DEFine -singleton SURVey $prerinse$='' $purpose$='' $context$='' $ignoreErrors$=False $arm$=ARM $location$ $locations* <quote.survey>

    ### Verify locations
    TRY <quote.try>
    	ITERATE -key=group "$location$ $locations*" <quote.group>
            ITERATE -key=location -delimiter="," ${group} <quote.location>
                FLUidics:ARM:LOCation? ${location}
            </quote.location>
        </quote.group>
    </quote.try> <quote.except>
        ERRor -id=$error$ $arguments$ "$message$"
    </quote.except>

    NEXT

    TRY <quote.try>
        ACQuisition+ -owner=Survey Robot

        IF $[ "$prerinse$" != "" ] <if>
             FLUidics:$arm$:RinseInside $prerinse$
        </if>
        ELSE <else>
            FLUidics:$arm$:PrimeLine
        </else>
        FLUidics:$arm$:RinseOutside -duration=0.5

        ITERate -key=group "$location$ $locations*" <quote.group>
            FLUidics:SURVey -context=$context$ -purpose=$purpose$ \
                            -ignoreErrors=$ignoreErrors$ ${group}

            FLUidics:$arm$:RinseInside  -duration=0.2
            FLUidics:$arm$:RinseOutside -duration=0.5
            FLUidics:$arm$:IDLE
        </quote.group>

       FLUidics:$arm$:PARK
       ACQuisition- -owner=Survey Robot

     </quote.try> <quote.except1>
       SET ERRID   "$error$"
       SET ERRARGS "$arguments$"
       SET ERRMSG  "$message$"

       FLUidics:$arm$:RinseInside  -duration=0.2
       FLUidics:$arm$:RinseOutside -duration=0.5
       FLUidics:$arm$:PARK
       ACQuisition- -owner=Survey Robot
    </quote.except1> <quote.except2>
       ACQuisition~ -owner=Survey
    </quote.except2>

    IF ${#ERRID:-} "ERRor -id=${ERRID} ${ERRARGS} \"${ERRMSG}\""
</quote.survey>


DESCribe SURVey <quote>
    Determine the current liquid level in each of the specificed location(s).

    Locations can be given as multiple groups separated by whitespace, and 
    where locations within a group are separated by commas.  After
    each group has been surveyed, the needle moves to the wash station
    for an inside and an outside rinse.

Example:
  * Survey locations A1,A2,B1,B2, then rinse before moving to C2; rinse again 
    before A3,B3 and C3.
     > SURVey A1,B1,A2,B2 C2 A3,B3,C3
</quote>


DEFine SURVey~ $types$=Well,Bottle,MixingWell $locations* <quote>
    FLUidics:LiquidLevel~  -types=$types$ $locations*
    FLUidics:LiquidVOLume~ -types=$types$ $locations*
</quote>

DESCribe SURVey~ <quote>
    Clear any survey data (heights/volumes).
</quote>