com.hfg.automation.tecan.plateop.TecanUserPromptPlateOp Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.automation.tecan.plateop;

import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;

import com.hfg.automation.tecan.worklistcmd.TecanWorklistCommand;
import com.hfg.automation.tecan.worklistcmd.TecanWorklistCommentCommand;
import com.hfg.automation.tecan.worklistcmd.TecanWorklistUserPromptCommand;
import com.hfg.util.StringUtil;

//------------------------------------------------------------------------------
/**
 Tecan-specific User Prompt advanced plate operation.
 
 @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class TecanUserPromptPlateOp extends TecanPlateOp
{
   private TecanWorklistUserPromptCommand mPromptCmd;


   //---------------------------------------------------------------------------
   public TecanUserPromptPlateOp(String inMsg)
   {
      mPromptCmd = new TecanWorklistUserPromptCommand(inMsg);
   }

   //---------------------------------------------------------------------------
   public TecanWorklistUserPromptCommand getCommand()
   {
      return mPromptCmd;
   }

   //---------------------------------------------------------------------------
   @Override
   public TecanUserPromptPlateOp setOutputOrder(Integer inValue)
   {
      return (TecanUserPromptPlateOp) super.setOutputOrder(inValue);
   }

   //---------------------------------------------------------------------------
   @Override
   public TecanUserPromptPlateOp setComment(String inValue)
   {
      return (TecanUserPromptPlateOp) super.setComment(inValue);
   }

   //---------------------------------------------------------------------------
   public void generateWorklist(OutputStream inStream)
         throws IOException
   {

      PrintStream printStream = new PrintStream(inStream);

      // Advanced worklist commands must be preceded by a WASH command
      // TODO: If we implement more advanced plate ops we may want to centralize this
      printStream.println(TecanWorklistCommand.WASH.toString());

      if (StringUtil.isSet(getComment()))
      {
         printStream.println(new TecanWorklistCommentCommand(getComment()));
      }

      printStream.println(mPromptCmd.toString());

      printStream.close();
   }

}