COPASI API  4.16.103
CLyapProblem.h
Go to the documentation of this file.
1 // Begin CVS Header
2 // $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/lyap/CLyapProblem.h,v $
3 // $Revision: 1.5 $
4 // $Name: $
5 // $Author: shoops $
6 // $Date: 2007/02/12 14:27:06 $
7 // End CVS Header
8 
9 // Copyright (C) 2007 by Pedro Mendes, Virginia Tech Intellectual
10 // Properties, Inc. and EML Research, gGmbH.
11 // All rights reserved.
12 
13 /**
14  * CLyapProblem class.
15  */
16 
17 #ifndef COPASI_CLyapProblem
18 #define COPASI_CLyapProblem
19 
20 #include <string>
21 
23 //#include "utilities/CReadConfig.h"
24 
26  {
27  // Attributes
28  private:
29  /**
30  * Number of exponents to calculate. 0 means all.
31  */
33 
34  /**
35  *
36  */
37  //bool * mpTimeSeriesRequested;
38 
39  /**
40  * whether the divergence should also be calculated
41  */
43 
44  /**
45  * Indicates at which point of time the calculation of exponents
46  * should be started.
47  */
49 
50  public:
51  // Operations
52 
53  /**
54  * Default constructor.
55  * @param const CCopasiContainer * pParent (default: NULL)
56  */
57  CLyapProblem(const CCopasiContainer * pParent = NULL);
58 
59  /**
60  * Copy constructor.
61  * @param const CTrajectoryProblem & src
62  * @paramconst CCopasiContainer * pParent (default: NULL)
63  */
64  CLyapProblem(const CLyapProblem & src,
65  const CCopasiContainer * pParent = NULL);
66 
67  /**
68  * Destructor.
69  */
70  ~CLyapProblem();
71 
72  /**
73  * This methods must be called to elevate subgroups to
74  * derived objects. The default implementation does nothing.
75  * @return bool success
76  */
77  virtual bool elevateChildren();
78 
79  /**
80  * Set the number of exponents to calculate
81  * @param "const unsigned C_INT32 &"
82  */
83  void setExponentNumber(const unsigned C_INT32 & number);
84 
85  /**
86  * Retrieve the number of exponents to calculate.
87  * @return "const unsigned C_INT32 &"
88  */
89  const unsigned C_INT32 & getExponentNumber() const;
90 
91  /**
92  * Set the end time.
93  * @param "const C_FLOAT64 &" endTime
94  */
95  void setTransientTime(const C_FLOAT64 & endTime);
96 
97  /**
98  * Retrieve the end time.
99  * @return "const C_FLOAT64 &" endTime
100  */
101  const C_FLOAT64 & getTransientTime() const;
102 
103  /**
104  *.
105  */
106  //void setTimeSeriesRequested(bool flag);
107 
108  /**
109  *
110  */
111  //bool timeSeriesRequested() const;
112 
113  /**
114  *.
115  */
116  void setDivergenceRequested(bool flag);
117 
118  /**
119  *
120  */
121  bool divergenceRequested() const;
122 
123  /**
124  * This is the output method for any result of a problem. The default implementation
125  * provided with CCopasiProblem. Does only print "Not implmented." To overide this
126  * default behaviour one needs to reimplement the virtual printResult function.
127  * @param std::ostream * ostream
128  */
129  virtual void printResult(std::ostream * ostream) const;
130 
131  /**
132  * Load a trajectory problem
133  * @param "CReadConfig &" configBuffer
134  * @param "CReadConfig::Mode mode (Default: CReadConfig::NEXT)
135  */
136  // void load(CReadConfig & configBuffer,
137  // CReadConfig::Mode mode = CReadConfig::NEXT);
138 
139  private:
140  /**
141  * Allocates all group parameters and assures that they are
142  * properly initialized.
143  */
144  void initializeParameter();
145  };
146 
147 #endif
unsigned C_INT32 * mpExponentNumber
Definition: CLyapProblem.h:32
void initializeParameter()
virtual void printResult(std::ostream *ostream) const
C_FLOAT64 * mpTransientTime
Definition: CLyapProblem.h:48
void setDivergenceRequested(bool flag)
bool * mpDivergenceRequested
Definition: CLyapProblem.h:42
void setTransientTime(const C_FLOAT64 &endTime)
#define C_INT32
Definition: copasi.h:90
CLyapProblem(const CCopasiContainer *pParent=NULL)
void setExponentNumber(const unsigned C_INT32 &number)
const C_FLOAT64 & getTransientTime() const
virtual bool elevateChildren()
const unsigned C_INT32 & getExponentNumber() const
long int flag
Definition: f2c.h:52
#define C_FLOAT64
Definition: copasi.h:92
bool divergenceRequested() const