com.hfg.automation.platelayer.WellReagentLayer 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.platelayer;



import com.hfg.exception.InvalidValueException;
import com.hfg.units.Quantity;
import com.hfg.units.QuantityType;
import com.hfg.util.StringUtil;

//------------------------------------------------------------------------------
/**
 Plate layer for specifying per-well volumes of a reagent.
 
 @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 WellReagentLayer extends WellLayerImpl implements ReagentLayer, WellVolumeLayer
{
   private R        mReagent;
   private Quantity mVolume;

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################


   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   public WellReagentLayer setReagent(R inValue)
   {
      mReagent = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public R getReagent()
   {
      return mReagent;
   }

   //---------------------------------------------------------------------------
   public WellReagentLayer setVolume(Quantity inVolume)
   {
      if (inVolume != null
            && !inVolume.getUnit().getQuantityType().equals(QuantityType.VOLUME))
      {
         throw new InvalidValueException("The specified volume quantity " + StringUtil.singleQuote(inVolume) + " isn't specified in volume units!");
      }

      mVolume = inVolume;

      return this;
   }

   //---------------------------------------------------------------------------
   public Quantity getVolume()
   {
      return mVolume;
   }
}