/*************************************************************************
 *    CompuCell - A software framework for multimodel simulations of     *
 * biocomplexity problems Copyright (C) 2003 University of Notre Dame,   *
 *                             Indiana                                   *
 *                                                                       *
 * This program is free software; IF YOU AGREE TO CITE USE OF CompuCell  *
 *  IN ALL RELATED RESEARCH PUBLICATIONS according to the terms of the   *
 *  CompuCell GNU General Public License RIDER you can redistribute it   *
 * and/or modify it under the terms of the GNU General Public License as *
 *  published by the Free Software Foundation; either version 2 of the   *
 *         License, or (at your option) any later version.               *
 *                                                                       *
 * This program 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    *
 *             General Public License for more details.                  *
 *                                                                       *
 *  You should have received a copy of the GNU General Public License    *
 *     along with this program; if not, write to the Free Software       *
 *      Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.        *
 *************************************************************************/

#ifndef DICTYCHEMOTAXISSTEPPABLE_H
#define DICTYCHEMOTAXISSTEPPABLE_H

#include <CompuCell3D/Steppable.h>
#include <CompuCell3D/Field3D/Dim3D.h>
#include <string>

template <typename T>
class BasicClassAccessor;

namespace CompuCell3D {
  class Potts3D;
  class CellInventory;
  

  template <class T>
  class Field3D;
  
  template <class T>
  class Field3DImpl;
  

  
  class CellG; 
  
  class SimpleClock; 
   
  class DictyChemotaxisSteppable : public Steppable {
    Potts3D *potts;
    Field3DImpl<float> *field;

    Field3D<CellG *> *cellFieldG;
    
    Dim3D fieldDim;
    std::string chemicalFieldSource;
    std::string chemicalFieldName;
    
    CellInventory * cellInventoryPtr;
    BasicClassAccessor<SimpleClock> * simpleClockAccessorPtr;
    
    unsigned int clockReloadValue;
    unsigned int chemotactUntil;
    float chetmotaxisActivationThreshold;
    unsigned int ignoreFirstSteps;
    int chemotactingCellsCounter;  
    
  public:
    DictyChemotaxisSteppable();
    
    virtual ~DictyChemotaxisSteppable(){};  

    void initializeCellTypes();
    // SimObject interface
    virtual void init(Simulator *_simulator);
    virtual void extraInit(Simulator *_simulator);
    
    // Begin Steppable interface
    virtual void start();
    virtual void step(const unsigned int currentStep);
    virtual void finish() {}
    // End Steppable interface

    // Begin XMLSerializable interface
    virtual void readXML(XMLPullParser &in);
    virtual void writeXML(XMLSerializer &out){};
    // End XMLSerializable interface
  };
};
#endif
