COPASI API
4.16.103
Main Page
Namespaces
Classes
Files
File List
File Members
copasi
oscillation
COscillationMethod.h
Go to the documentation of this file.
1
// Begin CVS Header
2
// $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/oscillation/COscillationMethod.h,v $
3
// $Revision: 1.1 $
4
// $Name: $
5
// $Author: ssahle $
6
// $Date: 2008/11/11 16:47:54 $
7
// End CVS Header
8
// Copyright (C) 2008 by Pedro Mendes, Virginia Tech Intellectual
9
// Properties, Inc., EML Research, gGmbH, University of Heidelberg,
10
// and The University of Manchester.
11
// All rights reserved.
12
13
#ifndef COPASI_COscMethod
14
#define COPASI_COscMethod
15
16
#include "
utilities/CCopasiMethod.h
"
17
18
class
COscillationProblem
;
19
class
COscillationTask
;
20
21
class
COscillationMethod
:
public
CCopasiMethod
22
{
23
public
:
24
25
protected
:
26
27
COscillationProblem
*
mpOscProblem
;
28
29
// COptTask * mpParentTask;
30
31
private
:
32
/**
33
* Default constructor.
34
*/
35
COscillationMethod
();
36
37
protected
:
38
/**
39
* Specific constructor
40
* @param const CCopasiTask::Type & type
41
* @param const CCopasiMethod::SubType & subType
42
* @param const CCopasiContainer * pParent (default: NULL)
43
*/
44
COscillationMethod
(
const
CCopasiTask::Type
& taskType,
45
const
SubType
& subType,
46
const
CCopasiContainer
* pParent = NULL);
47
48
public
:
49
/**
50
* Create a optimization method.
51
* Note: the returned object has to be released after use with delete
52
*/
53
static
COscillationMethod
*
createMethod
(
CCopasiMethod::SubType
subType
54
= CCopasiMethod::oscillationIntegrate);
55
56
/**
57
* Copy constructor
58
* @param const COscillationMethod & src
59
* @param const CCopasiContainer * pParent (default: NULL)
60
*/
61
COscillationMethod
(
const
COscillationMethod
& src,
62
const
CCopasiContainer
* pParent = NULL);
63
64
/**
65
* Destructor
66
*/
67
virtual
~COscillationMethod
();
68
69
/**
70
* Execute the algorithm
71
* @ return success;
72
*/
73
virtual
bool
run
() = 0;
74
75
/**
76
* Set the problem to be optmised
77
* @param "COscillationProblem *" problem
78
*/
79
void
setProblem
(
COscillationProblem
* problem);
80
81
/**
82
* Initialize arrays and pointer.
83
* @return bool success
84
*/
85
virtual
bool
initialize
();
86
87
/**
88
* Check if the method is suitable for this problem
89
* @return bool suitability of the method
90
*/
91
virtual
bool
isValidProblem
(
const
CCopasiProblem
* pProblem);
92
93
protected
:
94
/**
95
* Cleanup arrays and pointers.
96
* @return bool success
97
*/
98
virtual
bool
cleanup
();
99
};
100
101
#endif // COPASI_COscillationMethod
COscillationMethod::COscillationMethod
COscillationMethod()
Definition:
COscillationMethod.cpp:39
COscillationMethod::initialize
virtual bool initialize()
Definition:
COscillationMethod.cpp:74
COscillationTask
Definition:
COscillationTask.h:34
COscillationMethod::setProblem
void setProblem(COscillationProblem *problem)
Definition:
COscillationMethod.cpp:63
CCopasiMethod
Definition:
CCopasiMethod.h:34
CCopasiProblem
Definition:
CCopasiProblem.h:40
CCopasiTask::Type
Type
Definition:
CCopasiTask.h:45
COscillationMethod::isValidProblem
virtual bool isValidProblem(const CCopasiProblem *pProblem)
Definition:
COscillationMethod.cpp:89
COscillationMethod::mpOscProblem
COscillationProblem * mpOscProblem
Definition:
COscillationMethod.h:27
COscillationMethod::run
virtual bool run()=0
COscillationMethod::createMethod
static COscillationMethod * createMethod(CCopasiMethod::SubType subType=CCopasiMethod::oscillationIntegrate)
Definition:
COscillationMethod.cpp:21
CCopasiMethod::SubType
SubType
Definition:
CCopasiMethod.h:40
CCopasiContainer
Definition:
CCopasiContainer.h:37
COscillationMethod::~COscillationMethod
virtual ~COscillationMethod()
Definition:
COscillationMethod.cpp:60
COscillationProblem
Definition:
COscillationProblem.h:18
COscillationMethod
Definition:
COscillationMethod.h:21
COscillationMethod::cleanup
virtual bool cleanup()
Definition:
COscillationMethod.cpp:85
CCopasiMethod.h
Generated on Thu Jul 2 2015 14:50:26 for COPASI API by
1.8.6