com.hfg.automation.tecan.TecanLabwareContainer 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;


//------------------------------------------------------------------------------

import com.hfg.automation.AutomationConfigurationException;
import com.hfg.automation.LabwareContainer;
import com.hfg.util.StringUtil;

/**
 Interface for instances of Tecan labware containers such as plates, tubes, or troughs.
 
  @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 interface TecanLabwareContainer extends TecanLabware, LabwareContainer
{
   public static final int MAX_LABEL_LENGTH   = 32;
   public static final int MAX_RACK_ID_LENGTH = 32;

   //---------------------------------------------------------------------------
   public String getTecanLabel();

   //---------------------------------------------------------------------------
   public String getRackId();

   //---------------------------------------------------------------------------
   public static void checkLabel(String inValue)
   {
      if (inValue.length() > MAX_LABEL_LENGTH)
      {
         throw new AutomationConfigurationException(StringUtil.singleQuote(inValue) + " exceeds the max Tecan label length (" + MAX_LABEL_LENGTH + " chars)!");
      }
   }

   //---------------------------------------------------------------------------
   public static void checkRackId(String inValue)
   {
      if (inValue.length() > MAX_RACK_ID_LENGTH)
      {
         throw new AutomationConfigurationException(StringUtil.singleQuote(inValue) + " exceeds the max Tecan rack/tube/barcode id length (" + MAX_RACK_ID_LENGTH + " chars)!");
      }
   }
}