TGSTK  0.0.1
The Tumour Growth Simulation ToolKit
Public Member Functions | Protected Member Functions | List of all members
tgstkAlgorithmBase Class Referenceabstract

Base class for TGSTK algorithms. More...

#include <tgstkAlgorithmBase.h>

Inheritance diagram for tgstkAlgorithmBase:
tgstkObjectBase tgstkImageProcessorBase tgstkMeshProcessorBase tgstkFiniteDifferenceReactionDiffusionTumourGrowthFilter tgstkImageToMeshFilter tgstkLinearQuadraticTumourCellSurvivalImageFilter tgstkMeshScalarsFromImageFilter tgstkWaterToTumourCellDiffusionTensorImageFilter tgstkImageToMeshFilter tgstkMeshScalarsFromImageFilter

Public Member Functions

virtual ~tgstkAlgorithmBase ()
 
virtual bool check ()
 
virtual void execute ()=0
 
bool update ()
 
- Public Member Functions inherited from tgstkObjectBase
virtual ~tgstkObjectBase ()
 
std::string getObjectName ()
 

Protected Member Functions

 tgstkAlgorithmBase ()
 
template<typename Type >
bool _assertNotNullPtr (Type var, std::string name)
 
template<typename Type >
bool _assertValueInRange (Type var, Type min, Type max, std::string name)
 
template<typename Type1 , typename Type2 >
bool _assertValueIsEqual (Type1 var1, Type2 var2, std::string name1, std::string name2)
 
- Protected Member Functions inherited from tgstkObjectBase
 tgstkObjectBase ()
 

Additional Inherited Members

- Protected Attributes inherited from tgstkObjectBase
std::string objectName
 

Detailed Description

Base class for TGSTK algorithms.

tgstkAlgorithmBase is a base class for TGSTK algorithms.

Constructor & Destructor Documentation

◆ ~tgstkAlgorithmBase()

tgstkAlgorithmBase::~tgstkAlgorithmBase ( )
virtual

◆ tgstkAlgorithmBase()

tgstkAlgorithmBase::tgstkAlgorithmBase ( )
protected

Member Function Documentation

◆ _assertNotNullPtr()

template<typename Type >
bool tgstkAlgorithmBase::_assertNotNullPtr ( Type  var,
std::string  name 
)
protected

◆ _assertValueInRange()

template<typename Type >
bool tgstkAlgorithmBase::_assertValueInRange ( Type  var,
Type  min,
Type  max,
std::string  name 
)
protected

◆ _assertValueIsEqual()

template<typename Type1 , typename Type2 >
bool tgstkAlgorithmBase::_assertValueIsEqual ( Type1  var1,
Type2  var2,
std::string  name1,
std::string  name2 
)
protected

◆ check()

bool tgstkAlgorithmBase::check ( )
virtual

Reimplemented in tgstkWaterToTumourCellDiffusionTensorImageFilter, tgstkFiniteDifferenceReactionDiffusionTumourGrowthFilter, tgstkLinearQuadraticTumourCellSurvivalImageFilter, tgstkImageToMeshFilter, and tgstkMeshScalarsFromImageFilter.

◆ execute()

virtual void tgstkAlgorithmBase::execute ( )
pure virtual

Implemented in tgstkWaterToTumourCellDiffusionTensorImageFilter, tgstkFiniteDifferenceReactionDiffusionTumourGrowthFilter, tgstkLinearQuadraticTumourCellSurvivalImageFilter, tgstkImageToMeshFilter, and tgstkMeshScalarsFromImageFilter.

◆ update()

bool tgstkAlgorithmBase::update ( )
The documentation for this class was generated from the following files: