########################################################################
### FILE:	runstate.mod
### PURPOSE:	Interface for determining instrument run/ready state
### SCOPE:	FlowChip<n>: branches
###
### Copyrights (C) 2010 Life Technologies.  All rights reserved.
########################################################################

:STATe:NEW FlowChip${FC}:Running 
:STATe:NEW FlowChip${FC}:Ready -requires=Instrument:Initialized -conflicts=FlowChip${FC}:Running

DEFine ReadyToRun? <quote>
    WARNing "FlowChip${FC}:ReadyToRun? is depricated; please use 'STATe? FlowChip${FC}:Ready' instead"

    IF $[ "$(RUNPROC?)" != "(None)" ] <quote.procRunning>
        ERRor -id=AlreadyRunning "Because this flowchip is executing a run, another run cannot be started."
    </quote.procRunning>
    
    ELSEIF $[ "$(:SYSTem:ENVironment? SYSCONFIG)" != "ProtoC" ] <quote.legacy>
        RETurn
    </quote.legacy>

    ELSEIF $(:ACB:IsFrontDoorOpen) <quote.frontdoor>
        ERRor -id=DoorsOpen "Because the front doors are open, the run cannot be started."
    </quote.frontdoor>

    ELSEIF $[$(:FLU:FrontDoorLocked)==0] <quote.doorsNotLocked>
        ERRor -id=DoorsNotLocked "Because the front doors are unlocked, the run cannot be started."
    </quote.doorsNotLocked>
    
    ELSEIF $(:ACB:IsTankDrawerOpen) <quote.tankDrawerOpen>
        ERRor -id=DrawerOpen "Because the tank drawer is open, the run cannot be started."
    </quote.tankDrawerOpen>

    ELSEIF $[$(:FLU:TankDrawerLocked)==0] <quote.drawerNotLocked>
        ERRor -id=DrawerNotLocked "Because the tank drawer is unlocked, the run cannot be started."
    </quote.drawerNotLocked>

    ELSEIF $(:ACB:IsXeHouseCoverOpen) <quote.lampCoverOpen>
        ERRor -id=LampCoverOpen "Because the xenon lamp cover is open, the run cannot be started."
    </quote.lampCoverOpen>
    
    ELSEIF $[$(:ACB:IsXeLampOn)==0] <quote.lampOff>
        ERRor -id=LampOff "Because the xenon lamp is not on, the run cannot be started."
    </quote.lampOff>
    
    ELSEIF $(:ACB:IsSyringeCoverOpen) <quote.syringeCoverOpen>
        ERRor -id=SyringeCoverOpen "Because the syringe cover is open, the run cannot be started."
    </quote.syringeCoverOpen>
    
    ELSEIF $[$(:ACB:IsExhaustFan1On)==0] <quote.exhaustFan1Off>
        ERRor -id=ExhaustFan1Off "Because one, or both exhaust fans are not on, the run cannot be started."
    </quote.exhaustFan1Off>
    
    ELSEIF $[$(:ACB:IsExhaustFan2On)==0] <quote.exhaustFan2Off>
        ERRor -id=ExhaustFan2Off "Because one, or both exhaust fans are not on, the run cannot be started."
    </quote.exhaustFan2Off>
    
    ELSEIF $[$(:FLU:SystemLiquidTankInstalled)==0] <quote.sysTankInstalled>
        ERRor -id=SysLiquidTankNotPresent "Because the system liquid tank is not present, the run cannot be started."
    </quote.sysTankInstalled>
    
    ELSEIF $(:FLU:SystemLiquidLevelEmpty) <quote.sysLiquidLevelEmpty>
        ERRor -id=SysLiquidLevelEmpty "Because the system liquid tank is empty, the run cannot be started."
    </quote.sysLiquidLevelEmpty>

    ELSEIF $[$(:FLU:WasteTank1Installed)==0] <quote.wasteTank1Installed>
        ERRor -id=WasteTank1NotPresent "Because the non-hazardous waste tank is not present, the run cannot be started."
    </quote.wasteTank1Installed>

    ELSEIF $(:FLU:WasteTank1LiquidLevelFull) <quote.wasteTank1Full>
        ERRor -id=WasteTank1Full "Because the non-hazardous waste tank is full, the run cannot be started."
    </quote.wasteTank1Full>

    ELSEIF $[$(:FLU:WasteTank2Installed)==0] <quote.wasteTank2Installed>
        ERRor -id=WasteTank2NotPresent "Because the hazardous waste tank is not present, the run cannot be started."
    </quote.wasteTank2Installed>

    ELSEIF $(:FLU:WasteTank2LiquidLevelFull) <quote.wasteTank2Full>
        ERRor -id=WasteTank2Full "Because the hazardous waste tank is full, the run cannot be started."
    </quote.wasteTank2Full>

    ELSEIF $[$(:FLU:ChillerBlockCoolingFanON)==0] <quote.chillerFanOff>
        ERRor -id=ChillerFanOff "Because the chiller cooling fan is not on, the run cannot be started."
    </quote.chillerFanOff>

</quote>