com.hfg.automation.tecan.TecanDeckPosition 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.AutomationException;
import com.hfg.automation.PlateRole;

//------------------------------------------------------------------------------
/**
 Tecan deck position.
 
 @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 TecanDeckPosition
{
   private String mLabel;
   private PlateRole mRole;
   private TecanLabwareContainerType mContainerType;
   private TecanLabwareContainer mCurrentOccupant;

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

   //---------------------------------------------------------------------------
   public TecanDeckPosition(TecanLabwareContainerType inContainerType, String inLabel)
   {
      mContainerType = inContainerType;
      mLabel = inLabel;
   }


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

   //---------------------------------------------------------------------------
   public String getLabel()
   {
      return mLabel;
   }

   //---------------------------------------------------------------------------
   public TecanDeckPosition setRole(PlateRole inValue)
   {
      mRole = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public PlateRole getRole()
   {
      return mRole;
   }

   //---------------------------------------------------------------------------
   public TecanLabwareContainerType getContainerType()
   {
      return mContainerType;
   }

   //---------------------------------------------------------------------------
   public void setContainer(TecanLabwareContainer inContainer)
   {
      mCurrentOccupant = inContainer;
   }

   //---------------------------------------------------------------------------
   public TecanLabwareContainer getContainer()
   {
      return mCurrentOccupant;
   }

   //---------------------------------------------------------------------------
   public TecanLabwareContainer removeContainer()
   {
      if (null == mCurrentOccupant)
      {
         throw new AutomationException("Deck position " + getLabel() + " isn't currently occupied by a container!");
      }

      TecanLabwareContainer returnedContainer = mCurrentOccupant;

      mCurrentOccupant = null;

      return returnedContainer;
   }
}