COPASI API  4.16.103
CSteadyStateProblem.h
Go to the documentation of this file.
1 /* Begin CVS Header
2  $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/steadystate/CSteadyStateProblem.h,v $
3  $Revision: 1.13 $
4  $Name: $
5  $Author: shoops $
6  $Date: 2006/04/27 01:31:49 $
7  End CVS Header */
8 
9 // Copyright 2005 by Pedro Mendes, Virginia Tech Intellectual
10 // Properties, Inc. and EML Research, gGmbH.
11 // All rights reserved.
12 
13 /**
14  * CSteadyStateProblem class.
15  * This class describes the steady state problem, i.e., it allows to specify
16  * for example initial conditions.
17  *
18  * Created for Copasi by Stefan Hoops 2002
19  */
20 
21 #ifndef COPASI_CSteadyStateProblem
22 #define COPASI_CSteadyStateProblem
23 
24 #include <string>
25 
27 #include "utilities/CReadConfig.h"
28 
30  {
31  // Attributes
32  private:
33  /**
34  * The initial state, i.e., the starting conditions of the trajectroy.
35  */
36  //CState mInitialState;
37 
38  /**
39  * was a initial state set?
40  */
41  //bool mHasInitialState;
42 
43  public:
44  // Operations
45 
46  /**
47  * Default constructor.
48  * @param const CCopasiContainer * pParent (default: NULL)
49  */
50  CSteadyStateProblem(const CCopasiContainer * pParent = NULL);
51 
52  /**
53  * Copy constructor.
54  * @param "const CSteadyStateProblem &" src
55  * @paramconst CCopasiContainer * pParent (default: NULL)
56  */
58  const CCopasiContainer * pParent = NULL);
59 
60  /**
61  * Destructor.
62  */
63  virtual ~CSteadyStateProblem();
64 
65  /**
66  * Do all neccessary initialization so that calls to caluclate will
67  * be successful. This is called once from CCopasiTask::process()
68  * @result bool succes
69  */
70  virtual bool initialize();
71 
72  /**
73  * Set whether the jacobian is requested.
74  * @param bool & jacobianRequested
75  */
76  void setJacobianRequested(bool & jacobianRequested);
77 
78  /**
79  * Retrieve whether the jacobian is requested.
80  * @return bool jacobianRequested
81  */
82  bool isJacobianRequested() const;
83 
84  /**
85  * Set whether stabilty analysis is requested.
86  * @param bool & stabilityAnalysisRequested
87  */
88  void setStabilityAnalysisRequested(bool & stabilityAnalysisRequested);
89 
90  /**
91  * Retrieve whether the stabilty analysis is requested.
92  * @return bool stabilityAnalysisRequested
93  */
94  bool isStabilityAnalysisRequested() const;
95 
96  /**
97  * Load a trajectory problem
98  * @param "CReadConfig &" configBuffer
99  * @param "CReadConfig::Mode mode (Default: CReadConfig::NEXT)
100  */
101  void load(CReadConfig & configBuffer,
103  };
104 
105 #endif // COPASI_CSteadyStateProblem
bool isStabilityAnalysisRequested() const
void load(CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::NEXT)
void setJacobianRequested(bool &jacobianRequested)
CSteadyStateProblem(const CCopasiContainer *pParent=NULL)
void setStabilityAnalysisRequested(bool &stabilityAnalysisRequested)
bool isJacobianRequested() const