ITK  4.1.0
Insight Segmentation and Registration Toolkit
itkBioCell.h
Go to the documentation of this file.
00001 /*=========================================================================
00002  *
00003  *  Copyright Insight Software Consortium
00004  *
00005  *  Licensed under the Apache License, Version 2.0 (the "License");
00006  *  you may not use this file except in compliance with the License.
00007  *  You may obtain a copy of the License at
00008  *
00009  *         http://www.apache.org/licenses/LICENSE-2.0.txt
00010  *
00011  *  Unless required by applicable law or agreed to in writing, software
00012  *  distributed under the License is distributed on an "AS IS" BASIS,
00013  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  *  See the License for the specific language governing permissions and
00015  *  limitations under the License.
00016  *
00017  *=========================================================================*/
00018 #ifndef __itkBioCell_h
00019 #define __itkBioCell_h
00020 
00021 #include "itkBioCellBase.h"
00022 #include "itkBioCellularAggregateBase.h"
00023 
00024 namespace itk
00025 {
00026 namespace bio
00027 {
00038 template< unsigned int NSpaceDimension = 3 >
00039 class ITK_EXPORT Cell:public CellBase
00040 {
00041 public:
00042   typedef   CellBase Superclass;
00043 
00044   typedef   itk::Vector< double, NSpaceDimension > VectorType;
00045   typedef   itk::Point< double, NSpaceDimension >  PointType;
00046 
00047   friend class CellularAggregateBase; // need to give access to the constructor.
00048 public:
00049   virtual ~Cell();
00050   virtual void ClearForce(void);
00051 
00052   virtual void AddForce(const VectorType & force);
00053 
00054   virtual void AdvanceTimeStep(void);
00055 
00056   virtual void Mitosis(void);
00057 
00058   virtual void Apoptosis(void);
00059 
00060   virtual void ReceptorsReading(void);
00061 
00062   virtual void SetCellularAggregate(CellularAggregateBase *);
00063 
00064   virtual CellularAggregateBase * GetCellularAggregate(void);
00065 
00066   virtual const CellularAggregateBase * GetCellularAggregate(void) const;
00067 
00068   static const char * GetSpeciesName(void)
00069   {
00070     return "Primitive Cell";
00071   }
00072 
00073   static Cell * CreateEgg(void);
00074 
00075   static unsigned int GetDimension()
00076   {
00077     return NSpaceDimension;
00078   }
00079 protected:
00080   Cell(); // Users should create a cell with the CreateEgg() method
00081 public:
00082 
00083   virtual const VectorType & GetForce(void) const;
00084 
00085 protected:
00086   VectorType m_Force;
00087 
00088   CellularAggregateBase *m_Aggregate;
00089 };
00090 } // end namespace bio
00091 } // end namespace itk
00092 
00093 #ifndef ITK_MANUAL_INSTANTIATION
00094 #include "itkBioCell.hxx"
00095 #endif
00096 
00097 #endif
00098